@vertigis/viewer-spec 49.7.0 → 49.8.0

package/analytics/AnalyticsContext.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 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[];
+}

package/analytics/AnalyticsContext.js

@@ -0,0 +1 @@
+export {};

package/analytics/CommonAction.d.ts

@@ -0,0 +1,89 @@
+/**
+ * Names of `action-*` events generated for VertiGIS Studio Analytics in both
+ * Web and Mobile viewers.
+ */
+export declare 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"
+/**
+ * Map action in some cases. Payload: the URL.
+ */
+ | "url-open";

package/analytics/CommonAction.js

@@ -0,0 +1 @@
+export {};

package/analytics/WebAction.d.ts

@@ -0,0 +1,102 @@
+import type { CommonAction } from "./CommonAction";
+/**
+ * Names of `action-*` events generated for VertiGIS Studio Analytics in
+ * VertiGIS Studio Web.
+ */
+export declare type WebAction = CommonAction
+/**
+ * Layer action.
+ */
+ | "labels-hide"
+/**
+ * Layer action.
+ */
+ | "labels-show"
+/**
+ * Map action.
+ */
+ | "layer-comparison-enable"
+/**
+ * Map action.
+ */
+ | "layer-comparison-disable"
+/**
+ * Layer action. Payload: leading or trailing.
+ */
+ | "layer-comparison-layer-add"
+/**
+ * Layer action. Payload: leading or trailing.
+ */
+ | "layer-comparison-layer-remove"
+/**
+ * Payload: layout ID.
+ */
+ | "layout-change"
+/**
+ * Payload: new locale.
+ */
+ | "locale-change"
+/**
+ * Map + area action (area is location). Payload: marker ID.
+ */
+ | "location-marker-add"
+/**
+ * Map action.
+ */
+ | "location-marker-clear"
+/**
+ * Map action. Payload: marker ID.
+ */
+ | "location-marker-remove"
+/**
+ * Map + area action (area is new location). Payload: marker ID.
+ */
+ | "location-marker-update"
+/**
+ * Map + area action. Payload: note text.
+ */
+ | "map-note-add"
+/**
+ * Map + area action. Payload: note text.
+ */
+ | "map-note-delete"
+/**
+ * Map + area action. Payload: note text.
+ */
+ | "map-note-update"
+/**
+ * Map action. Payload: new view mode ("map" or "scene").
+ */
+ | "map-view-mode-set" | "project-load" | "project-create"
+/**
+ * Payload: format ("csv", "shapefile", or "xlsx").
+ */
+ | "results-export"
+/**
+ * Payload: format ("csv", "shapefile", or "xlsx").
+ */
+ | "results-import"
+/**
+ * Payload: new distance.
+ */
+ | "settings-buffer-distance-set"
+/**
+ * Payload: new units.
+ */
+ | "settings-buffer-units-set"
+/**
+ * Payload: new density.
+ */
+ | "settings-density-set"
+/**
+ * Payload: new units.
+ */
+ | "settings-measurement-area-units-set"
+/**
+ * Payload: new units.
+ */
+ | "settings-measurement-length-units-set"
+/**
+ * Payload: the link.
+ */
+ | "sharing-link-generate";

package/analytics/WebAction.js

@@ -0,0 +1 @@
+export {};