@vertigis/viewer-spec/analytics/AnalyticsContext.d.ts

VertiGIS Viewer Specification

/**
 * Contextual information that is used for reporting events to VertiGIS Studio
 * Analytics.
 */
export interface AnalyticsContext {
    /**
     * The XML name of the layout component that initiated the action, if
     * applicable. Examples: "layer-list", "map", etc.
     */
    analyticsComponentType?: string;
    /**
     * The human-readable name of the layout component that initiated the
     * action, if applicable. Examples: "Layer List", "Basemap Picker", "Left
     * Panel", etc.
     */
    analyticsComponentName?: string;
    /**
     * Additional component-specific data indicating such things as the name of
     * an item or area within a component that the user interacted with to
     * trigger the command, if applicable.
     *
     * Examples:
     *
     * - The name of a basemap selection.
     * - The name of a button.
     * - The name of a context menu item.
     */
    analyticsComponentData?: string | number | boolean | string[];
}