@vertigis/viewer-spec 42.10.0

package/app-config/web/BookmarksModelProperties.js

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

package/app-config/web/BrandingModelProperties.d.ts

@@ -0,0 +1,14 @@
+import type { BrandingModelProperties as CommonBrandingModelProperties } from "../common/BrandingModelProperties.js";
+/**
+ * Properties for the branding service.
+ */
+export interface BrandingModelProperties extends CommonBrandingModelProperties {
+    /**
+     * A link to an icon or png to be used as the application favIcon.
+     */
+    favIcon?: string;
+    /**
+     * The name to be used as the application name.
+     */
+    applicationName?: string;
+}

package/app-config/web/BrandingModelProperties.js

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

package/app-config/web/ChartModelProperties.d.ts

@@ -0,0 +1,58 @@
+import type Highcharts from "highcharts";
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+import type { FeatureSetProperties } from "./FeatureSetProperties.js";
+/**
+ * Modules that enable additional functionality in HighCharts.
+ */
+export declare type HighChartsModule = "highcharts-3d" | "highcharts-more" | "accessibility" | "annotations" | "annotations-advanced" | "arrow-symbols" | "boost" | "boost-canvas" | "broken-axis" | "bullet" | "coloraxis" | "current-date-indicator" | "cylinder" | "data" | "datagrouping" | "debugger" | "dependency-wheel" | "dotplot" | "draggable-points" | "drag-panes" | "drilldown" | "dumbbell" | "export-data" | "exporting" | "full-screen" | "funnel" | "funnel3d" | "gantt" | "grid-axis" | "heatmap" | "histogram-bellcurve" | "item-series" | "lollipop" | "map" | "marker-clusters" | "networkgraph" | "no-data-to-display" | "offline-exporting" | "oldie" | "oldie-polyfills" | "organization" | "overlapping-datalabels" | "parallel-coordinates" | "pathfinder" | "pattern-fill" | "price-indicator" | "pyramid3d" | "sankey" | "series-label" | "solid-gauge" | "sonification" | "static-scale" | "stock" | "stock-tools" | "streamgraph" | "sunburst" | "tilemap" | "timeline" | "treegrid" | "treemap" | "variable-pie" | "variwide" | "vector" | "venn" | "windbarb" | "wordcloud" | "xrange";
+/**
+ * Configuration for a chart component.
+ */
+export interface ChartModelProperties extends ComponentModelProperties {
+    /**
+     * The chart template. This is based on Highcharts config defined at
+     * https://api.highcharts.com/highcharts/
+     * with support for arcade expressions in the following syntax:
+     * ```.
+     * {
+     *      "$script": "arcade expression"
+     *      "$source": "item://layer-extension/id"
+     * }
+     * ```.
+     *
+     * The Arcade script supports basic arcade functionality as well as operations
+     * that target Arcade feature sets. The charts features from the specified source
+     * will be available to the arcade script as a $features global variable.
+     *
+     * The source specified can be any configured app item that can produce features
+     * ex:
+     * ```.
+     *  Item://layer-extension/id
+     *  item://table-extension/id
+     *  item://workflow/id
+     * ```.
+     *
+     * Our config also supports callbacks with the following syntax
+     * ex:
+     * ```
+     *  {
+     *       ...,
+     *       events: {
+     *           click: {@link Action}
+     *       }
+     *  }
+     * ```
+     * The action will be executed with the event argument provided by Highcharts.
+     */
+    template: Highcharts.Options;
+    /**
+     * An optional list of highcharts modules that will be utilized by your
+     * charts configuration.
+     */
+    highchartsModules?: HighChartsModule[];
+    /**
+     * The set of features contained by the chart model. This property is only
+     * serialized into saved projects. Web only.
+     */
+    results?: FeatureSetProperties;
+}

package/app-config/web/ChartModelProperties.js

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

package/app-config/web/CompassModelProperties.d.ts

@@ -0,0 +1,7 @@
+import type { CompassModelProperties as CommonCompassModelProperties } from "../common/CompassModelProperties.js";
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+/**
+ * @inheritdoc
+ */
+export interface CompassModelProperties extends CommonCompassModelProperties, ComponentModelProperties {
+}

package/app-config/web/CompassModelProperties.js

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

package/app-config/web/ComponentModelProperties.d.ts

@@ -0,0 +1,12 @@
+import type { ComponentModelProperties as CommonComponentModelProperties } from "../common/ComponentModelProperties.js";
+import type { HasVisibilityFilters } from "./HasVisibilityFilters.js";
+import type { ModelProperties } from "./ModelProperties.js";
+/**
+ * @inheritdoc
+ */
+export interface ComponentModelProperties extends CommonComponentModelProperties, HasVisibilityFilters, ModelProperties {
+    /**
+     * Whether this model should be included in landmarks.
+     */
+    isLandmark?: boolean;
+}

package/app-config/web/ComponentModelProperties.js

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

package/app-config/web/CoordinateModelProperties.d.ts

@@ -0,0 +1,7 @@
+import type { CoordinateModelProperties as CommonCoordinateModelProperties } from "../common/CoordinateModelProperties.js";
+import type { ServiceModelProperties } from "../common/ServiceModelProperties.js";
+/**
+ * @inheritdoc
+ */
+export interface CoordinateModelProperties extends CommonCoordinateModelProperties, ServiceModelProperties {
+}

package/app-config/web/CoordinateModelProperties.js

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

package/app-config/web/DialogModelProperties.d.ts

@@ -0,0 +1,7 @@
+import type { DialogModelProperties as CommonDialogModelProperties } from "../common/DialogModelProperties.js";
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+/**
+ * @inheritdoc
+ */
+export interface DialogModelProperties extends CommonDialogModelProperties, ComponentModelProperties {
+}

package/app-config/web/DialogModelProperties.js

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

package/app-config/web/DrawModelProperties.d.ts

@@ -0,0 +1,102 @@
+import type LineSymbol3D from "@arcgis/core/symbols/LineSymbol3D";
+import type PictureFillSymbol from "@arcgis/core/symbols/PictureFillSymbol";
+import type PictureMarkerSymbol from "@arcgis/core/symbols/PictureMarkerSymbol";
+import type PointSymbol3D from "@arcgis/core/symbols/PointSymbol3D";
+import type PolygonSymbol3D from "@arcgis/core/symbols/PolygonSymbol3D";
+import type SimpleFillSymbol from "@arcgis/core/symbols/SimpleFillSymbol";
+import type SimpleLineSymbol from "@arcgis/core/symbols/SimpleLineSymbol";
+import type SimpleMarkerSymbol from "@arcgis/core/symbols/SimpleMarkerSymbol";
+import type TextSymbol from "@arcgis/core/symbols/TextSymbol";
+import type { LineSymbol3D as LineSymbol3DProperties } from "@vertigis/arcgis-extensions/portal/LineSymbol3D";
+import type { PictureFillSymbol as PictureFillSymbolProperties } from "@vertigis/arcgis-extensions/portal/PictureFillSymbol";
+import type { PictureMarkerSymbol as PictureMarkerSymbolProperties } from "@vertigis/arcgis-extensions/portal/PictureMarkerSymbol";
+import type { PointSymbol3D as PointSymbol3DProperties } from "@vertigis/arcgis-extensions/portal/PointSymbol3D";
+import type { PolygonSymbol3D as PolygonSymbol3DProperties } from "@vertigis/arcgis-extensions/portal/PolygonSymbol3D";
+import type { SimpleFillSymbol as SimpleFillSymbolProperties } from "@vertigis/arcgis-extensions/portal/SimpleFillSymbol";
+import type { SimpleLineSymbol as SimpleLineSymbolProperties } from "@vertigis/arcgis-extensions/portal/SimpleLineSymbol";
+import type { SimpleMarkerSymbol as SimpleMarkerSymbolProperties } from "@vertigis/arcgis-extensions/portal/SimpleMarkerSymbol";
+import type { TextSymbol as TextSymbolProperties } from "@vertigis/arcgis-extensions/portal/TextSymbol";
+import type { SymbolLike } from "../../messaging/common.js";
+import type { ModelProperties } from "../common/ModelProperties.js";
+/**
+ * Base configuration shared by the draw and measurement services.
+ */
+export interface DrawModelBaseProperties extends ModelProperties {
+    /**
+     * The symbol used to draw point markup.
+     */
+    pointSymbol?: SimpleMarkerSymbol | SimpleMarkerSymbolProperties | PictureMarkerSymbol | PictureMarkerSymbolProperties;
+    /**
+     * The symbol used to draw 3D point markup.
+     */
+    pointSymbol3D?: PointSymbol3D | PointSymbol3DProperties;
+    /**
+     * The symbol used to draw line markup.
+     */
+    lineSymbol?: SimpleLineSymbol | SimpleLineSymbolProperties;
+    /**
+     * The symbol used to draw 3D line markup.
+     */
+    lineSymbol3D?: LineSymbol3D | LineSymbol3DProperties;
+    /**
+     * The symbol used to draw polygon markup.
+     */
+    polygonSymbol?: PictureFillSymbol | PictureFillSymbolProperties | SimpleFillSymbol | SimpleFillSymbolProperties;
+    /**
+     * The symbol used to draw 3D polygon markup.
+     */
+    polygonSymbol3D?: PolygonSymbol3D | PolygonSymbol3DProperties;
+    /**
+     * The symbol used to draw text markup.
+     */
+    textSymbol?: TextSymbol | TextSymbolProperties;
+    /**
+     * A list of SymbolPresets that can be assigned to graphics.
+     */
+    symbolPresets?: SymbolPresetProperties[];
+    /**
+     * Shows only symbol presets and no fine-grain controls when a symbol is
+     * being edited. If no symbol presets are configured, this property is
+     * ignored.
+     */
+    showOnlySymbolPresets?: boolean;
+}
+/**
+ * Configuration for the draw service.
+ */
+export interface DrawModelProperties extends DrawModelBaseProperties {
+    /**
+     * Whether draw syncing is enabled. If enabled, draw syncing will propagate
+     * all graphics drawn on any map to all other maps in the layout.
+     */
+    synced?: boolean;
+}
+/**
+ * The type of geometry that a given symbol can symbolize.
+ */
+export declare type SymbolGeometryType = "point" | "polyline" | "polygon" | "unknown";
+/**
+ * Configuration properties for a SymbolPreset.
+ */
+export interface SymbolPresetProperties {
+    /**
+     * The unique ID.
+     */
+    id?: string;
+    /**
+     * The geometry type associated with the symbol.
+     */
+    geometryType?: SymbolGeometryType;
+    /**
+     * A description of the SymbolPreset.
+     */
+    description?: string;
+    /**
+     * The title of the the SymbolPreset.
+     */
+    title: string;
+    /**
+     * The Symbol.
+     */
+    symbol: SymbolLike;
+}

package/app-config/web/DrawModelProperties.js

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

package/app-config/web/FeatureDetailsModelProperties.d.ts

@@ -0,0 +1,12 @@
+import type { FeatureInfoModelProperties } from "./FeatureInfoModelProperties.js";
+import type { FeatureListProperties } from "./FeatureListProperties.js";
+/**
+ * Properties for a feature-details component.
+ */
+export interface FeatureDetailsModelProperties extends FeatureInfoModelProperties {
+    /**
+     * The set of features contained by the feature-details model. This property is only
+     * serialized into saved projects. Web only.
+     */
+    results?: FeatureListProperties;
+}

package/app-config/web/FeatureDetailsModelProperties.js

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

package/app-config/web/FeatureInfoModelProperties.d.ts

@@ -0,0 +1,22 @@
+import type { Action } from "@vertigis/arcgis-extensions/support/Action";
+import type { FeatureDetailsModelProperties as CommonFeatureDetailsModelProperties } from "../common/FeatureDetailsModelProperties.js";
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+/**
+ * Base properties for the feature-details and feature-summary components.
+ */
+export interface FeatureInfoModelProperties extends CommonFeatureDetailsModelProperties, ComponentModelProperties {
+    /**
+     * A command or set of commands to execute when a feature is added into the
+     * collection.
+     */
+    onFeatureAdd?: Action;
+    /**
+     * A command or set of commands to execute when a feature is removed from
+     * the collection.
+     */
+    onFeatureRemove?: Action;
+    /**
+     * A command or set of commands to execute when a related record is clicked.
+     */
+    onRelatedRecordClick?: Action;
+}

package/app-config/web/FeatureInfoModelProperties.js

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

package/app-config/web/FeatureListProperties.d.ts

@@ -0,0 +1,12 @@
+import type { FeatureListProperties as ApiFeatureListProperties } from "@vertigis/arcgis-extensions/data/FeatureList";
+import type { ItemRef } from "../common/ItemRef.js";
+import type { FeatureSetProperties } from "./FeatureSetProperties.js";
+/**
+ * Properties for a FeatureList.
+ */
+export interface FeatureListProperties extends Omit<ApiFeatureListProperties, "featureSet"> {
+    /**
+     * @inheritdoc
+     */
+    featureSet?: (FeatureSetProperties | ItemRef)[];
+}

package/app-config/web/FeatureListProperties.js

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

package/app-config/web/FeatureSetProperties.d.ts

@@ -0,0 +1,16 @@
+import type { FeatureProperties } from "@vertigis/arcgis-extensions/data/Feature";
+import type { FeatureSetProperties as ApiFeatureSetProperties } from "@vertigis/arcgis-extensions/data/FeatureSet";
+import type { ItemRef } from "app-config/common/ItemRef";
+/**
+ * Properties for a FeatureSet.
+ */
+export interface FeatureSetProperties extends Omit<ApiFeatureSetProperties, "features" | "source"> {
+    /**
+     * @inheritdoc
+     */
+    features?: (FeatureProperties | ItemRef)[];
+    /**
+     * @inheritdoc
+     */
+    source?: ItemRef;
+}

package/app-config/web/FeatureSetProperties.js

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

package/app-config/web/FeatureSummaryModelProperties.d.ts

@@ -0,0 +1,22 @@
+import type { Action } from "@vertigis/arcgis-extensions/support/Action";
+import type { FeatureDetailsModelProperties as CommonFeatureDetailsModelProperties } from "../common/FeatureDetailsModelProperties.js";
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+/**
+ * Properties for a feature-summary component.
+ */
+export interface FeatureSummaryModelProperties extends CommonFeatureDetailsModelProperties, ComponentModelProperties {
+    /**
+     * A command or set of commands to execute when a feature is added into the
+     * collection.
+     */
+    onFeatureAdd?: Action;
+    /**
+     * A command or set of commands to execute when a feature is removed from
+     * the collection.
+     */
+    onFeatureRemove?: Action;
+    /**
+     * A command or set of commands to execute when the summary is clicked.
+     */
+    onFeatureClick?: Action;
+}

package/app-config/web/FeatureSummaryModelProperties.js

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

package/app-config/web/GeolocationModelProperties.d.ts

@@ -0,0 +1,7 @@
+import type { GeolocationModelProperties as CommonGeolocationModelProperties } from "../common/GeolocationModelProperties.js";
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+/**
+ * @inheritdoc
+ */
+export interface GeolocationModelProperties extends CommonGeolocationModelProperties, ComponentModelProperties {
+}

package/app-config/web/GeolocationModelProperties.js

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

package/app-config/web/GeometryModelProperties.d.ts

@@ -0,0 +1,27 @@
+import type { LengthUnits } from "../../messaging/registry/geometry.js";
+import type { ModelProperties } from "../common/ModelProperties.js";
+/**
+ * Configuration for the geometry service.
+ */
+export interface GeometryModelProperties extends ModelProperties {
+    /**
+     * The URL for the external geometry service that's used for calculations
+     * that can't be done client-side.
+     */
+    geometryServiceUrl?: string;
+    /**
+     * The default distance value for buffer operations. The default units are
+     * based on the application's measurement system: "meters" for metric,
+     * otherwise "yards".
+     */
+    bufferDistance?: number;
+    /**
+     * The default distance units for buffer operations. The default is 100.
+     */
+    bufferUnits?: LengthUnits;
+    /**
+     * Whether or not geodesic buffers are performed. The default is true. If
+     * set to false, buffers will be planar.
+     */
+    isGeodesic?: boolean;
+}

package/app-config/web/GeometryModelProperties.js

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

package/app-config/web/HasVisibilityFilters.d.ts

@@ -0,0 +1,35 @@
+/**
+ * A username for a particular ArcGIS Portal User.
+ */
+export declare type PortalUsername = string;
+/**
+ * The unique ID of an ArcGIS Portal Group.
+ */
+export declare type PortalGroupId = string;
+/**
+ * A defined set of user types for convenient configuration, based on authentication.
+ */
+export declare type VertigisUserType = "gcx-all-users" | "gcx-anonymous-users" | "gcx-authenticated-users";
+/**
+ * An identity/authentication based filter that determines whether a component
+ * or menu item in the app is visible or hidden from a given end-user.
+ */
+export declare type VisibilityFilter = VertigisUserType | PortalGroupId | PortalUsername;
+/**
+ * A set of properties that determines whether a component or menu item in the
+ * app is visible or hidden from a given end-user.
+ */
+export interface HasVisibilityFilters {
+    /**
+     * Filters that determine whether the UI element is visible to a given
+     * end-user. If both visibleTo and hiddenFrom are undefined/empty, the component
+     * will be visible to all users.
+     */
+    visibleTo?: VisibilityFilter[];
+    /**
+     * Filters that determine whether the UI element is hidden from a given
+     * end-user. If both visibleTo and hiddenFrom are undefined/empty, the component
+     * will be visible to all users.
+     */
+    hiddenFrom?: VisibilityFilter[];
+}

package/app-config/web/HasVisibilityFilters.js

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

package/app-config/web/ImageModelProperties.d.ts

@@ -0,0 +1,7 @@
+import type { ImageModelProperties as CommonImageModelProperties } from "../common/ImageModelProperties.js";
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+/**
+ * @inheritdoc
+ */
+export interface ImageModelProperties extends CommonImageModelProperties, ComponentModelProperties {
+}