@vertigis/viewer-spec/messaging/registry/studioAnalytics.d.ts

VertiGIS Viewer Specification

import type { Command } from "../Command.js";
import { CommandRegistry } from "../CommandRegistry.js";
/**
 * Arguments for the 'studio-analytics.track-custom-event' command.
 */
export interface TrackCustomEventArgs {
    /**
     * The name of the event. The event name should be in kebab-case, present
     * tense, and follow a `{noun phrase}-{verb}` pattern, where `{verb}` is a
     * single word without hyphens. Example: "parcel-boundary-move".
     */
    name: string;
    /**
     * Optional. Additional event-specific data of interest.
     */
    payload?: string;
}
export declare class StudioAnalyticsCommands extends CommandRegistry {
    protected readonly _prefix = "studio-analytics";
    /**
     * Sends a custom event to VertiGIS Studio Analytics. If the app is not
     * configured to use Analytics, then nothing will happen.
     */
    get trackCustomEvent(): Command<TrackCustomEventArgs>;
}