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

VertiGIS Viewer Specification

/**
 * Names of `action-*` events generated for VertiGIS Studio Analytics in both
 * Web and Mobile viewers.
 */
export type CommonAction = 
/**
 * Layer action. Payload: MIME type of the attachment.
 */
"attachment-add"
/**
 * Layer action. Payload: MIME type of the attachment.
 */
 | "attachment-delete"
/**
 * Layer action. Payload: MIME type of the attachment.
 */
 | "attachment-open"
/**
 * Payload: basemap name.
 */
 | "basemap-set"
/**
 * Map action, if related to a map. Payload: bookmark title.
 */
 | "bookmark-add"
/**
 * Payload: bookmark title.
 */
 | "bookmark-delete"
/**
 * Payload: bookmark's new title.
 */
 | "bookmark-update"
/**
 * Map action, if the bookmark is admin-defined in a map. Payload: bookmark
 * title.
 */
 | "bookmark-view"
/**
 * Layer action. Payload: global ID (if layer supports it), or object ID.
 */
 | "feature-add"
/**
 * Layer action. Payload: global ID (if layer supports it), or object ID.
 */
 | "feature-delete"
/**
 * Layer action. Payload: global ID (if layer supports it), or object ID.
 */
 | "feature-update"
/**
 * Layer action. Payload: global ID (if layer supports it), or object ID.
 */
 | "feature-view"
/**
 * Payload: geolocation mode, e.g. "auto-recenter", "off", etc.
 */
 | "geolocation-mode-change"
/**
 * Map action.
 */
 | "map-export"
/**
 * Map action.
 */
 | "markup-add"
/**
 * Map action.
 */
 | "markup-clear"
/**
 * Map action. Payload: geometry type (see SketchTool).
 */
 | "measurement-finish"
/**
 * Payload: the resolved address.
 */
 | "reverse-geocode-execute"
/**
 * Payload: measurement system.
 */
 | "settings-measurement-system-set"
/**
 * Payload: theme ID.
 */
 | "settings-theme-set"
/**
 * Payload: the URL.
 */
 | "url-open";