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

VertiGIS Viewer Specification

import type { CommonAction } from "./CommonAction";
/**
 * Names of `action-*` events generated for VertiGIS Studio Analytics in
 * VertiGIS Studio Web.
 */
export 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" | "project-share" | "project-delete"
/**
 * 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";