@vertigis/viewer-spec 42.10.0

package/app-config/web/ImageModelProperties.js

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

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

@@ -0,0 +1,145 @@
+import type { EntityProperties } from "@vertigis/arcgis-extensions/Entity";
+import type { FormatSettingsProperties } from "@vertigis/arcgis-extensions/support/FormatSettings";
+import type { ItemRef } from "../common/ItemRef.js";
+import type { ColorConfig } from "../common/colors.js";
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+import type { FeatureSetProperties } from "./FeatureSetProperties.js";
+/**
+ * Configuration for a KPI card component.
+ */
+export interface KpiCardModelProperties extends ComponentModelProperties {
+    /**
+     * The background color for the KPI card. If not specified, the branding
+     * theme color will be used.
+     */
+    backgroundColor?: ColorConfig;
+    /**
+     * Configuration for the bottom section.
+     */
+    bottom?: KpiCardSectionModelProperties;
+    /**
+     * A set of conditions to evaluated. If a condition's expression is true,
+     * its configuration will take effect. For any given configuration property,
+     * conditions that appear earlier in this list will take precedence over
+     * ones that come later.
+     */
+    conditions?: KpiCardConditionModelProperties[];
+    /**
+     * Configuration for the middle section.
+     */
+    middle?: KpiCardSectionModelProperties;
+    /**
+     * A reference value to use for comparison. This is available as a
+     * predefined `reference` variable within Arcade expressions.
+     */
+    reference?: number;
+    /**
+     * The type of reference to use.
+     */
+    referenceType?: ReferenceType;
+    /**
+     * When `referenceType` is "statistic", this Arcade expression will be used
+     * to calculate the reference value.
+     */
+    referenceExpression?: string;
+    /**
+     * The feature source (e.g. layer, sublayer, table, etc.) that this KPI card
+     * is associated with.
+     */
+    source?: ItemRef;
+    /**
+     * Configuration for the top section.
+     */
+    top?: KpiCardSectionModelProperties;
+    /**
+     * The initial KPI value. Normally this is computed from `valueExpression`
+     * rather than set directly.
+     */
+    value?: number;
+    /**
+     * An Arcade expression that calculates the KPI value from a feature set.
+     * The feature set is made available via a `$features` variable that is
+     * available for use within the expression.
+     */
+    valueExpression?: string;
+    /**
+     * The set of features contained by the kpi-card model. This property is only
+     * serialized into saved projects. Web only.
+     */
+    results?: FeatureSetProperties;
+}
+/**
+ * Configuration for a specific section of a KPI card (top, middle, or bottom).
+ */
+export interface KpiCardSectionModelProperties {
+    /**
+     * The text to display for this section. The text can contain embedded
+     * Arcade expressions, surrounded by braces ("{" and "}").
+     */
+    text?: string;
+    /**
+     * The ID of the icon to display in this section, or undefined to show no
+     * icon.
+     */
+    icon?: string;
+    /**
+     * The size of the text and icon.
+     */
+    size?: KpiCardSectionSize;
+    /**
+     * The foreground color to use for the text and icon. If undefined, it will
+     * use the theme's color.
+     */
+    color?: ColorConfig;
+    /**
+     * Format settings that affect how numbers and dates are formatted. Any
+     * setting that isn't specified will use the equivalent setting in the
+     * region service by default.
+     */
+    formatSettings?: FormatSettingsProperties;
+}
+/**
+ * Conditional configuration that is applied when the given expression is true.
+ */
+export interface KpiCardConditionModelProperties extends EntityProperties {
+    /**
+     * The Arcade expression to evaluate. If the return value is "truthy", the
+     * configuration in this condition will take effect.
+     */
+    expression?: string;
+    /**
+     * The background color to use if the condition is true.
+     */
+    backgroundColor?: ColorConfig;
+    /**
+     * Settings to apply to the top section if the condition is true.
+     */
+    top?: KpiCardSectionModelProperties;
+    /**
+     * Settings to apply to the middle section if the condition is true.
+     */
+    middle?: KpiCardSectionModelProperties;
+    /**
+     * Settings to apply to the bottom section if the condition is true.
+     */
+    bottom?: KpiCardSectionModelProperties;
+}
+/**
+ * Determines how the reference value for a KPI card is calculated. A reference
+ * is a number to compare against.
+ *  - "none": No reference value is used for this card.
+ *  - "previous": The reference value will reflect the previous KPI value
+ *    whenever it changes. Initially it will be undefined.
+ *  - "fixed": A constant value.
+ *  - "statistic": A calculated value determined via an Arcade expression (see
+ *    `referenceExpression`).
+ */
+export declare type ReferenceType = "none" | "previous" | "fixed" | "statistic";
+/**
+ * Determines how large the text and icon are for a KPI card section.
+ */
+export declare type KpiCardSectionSize = "extra-small" | "small" | "medium" | "large" | "extra-large";
+/**
+ * Identifies one of the three possible sections in a KPI card.
+ */
+export declare type KpiCardSectionName = "top" | "middle" | "bottom";

package/app-config/web/KpiCardModelProperties.js

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

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

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

package/app-config/web/LayerListModelProperties.js

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

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

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

package/app-config/web/LayerPresetsModelProperties.js

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

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

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

package/app-config/web/LegendModelProperties.js

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

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

@@ -0,0 +1,6 @@
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+/**
+ * Configuration for a 3D toggle component.
+ */
+export interface Map3dToggleModelProperties extends ComponentModelProperties {
+}

package/app-config/web/Map3dToggleModelProperties.js

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

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

@@ -0,0 +1,43 @@
+import type { MapCoordinatesModelProperties as CommonMapCoordinatesModelProperties } from "../common/MapCoordinatesModelProperties.js";
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+/**
+ * The coordinate formats that can be shown by the MapCoordinates component.
+ */
+export declare type CoordinateFormat = "xy" | "lat-long-dd" | "lat-long-ddm" | "lat-long-dms" | "mgrs" | "usng" | "utm";
+/**
+ * @inheritdoc
+ */
+export interface MapCoordinatesModelProperties extends CommonMapCoordinatesModelProperties, ComponentModelProperties {
+    /**
+     * The coordinate format that is displayed. The default is XY.
+     */
+    coordinateFormat?: CoordinateFormat;
+    /**
+     * The number of decimal places displayed for LAT_LONG coordinate formats.
+     * The value must be an integer between 0 and 8 (inclusive). The default is
+     * 4.
+     */
+    decimalPlacesLatLong?: number;
+    /**
+     * The number of decimal places displayed for the XY coordinate format. The
+     * value must be an integer between 0 and 8 (inclusive). The default is 2.
+     */
+    decimalPlacesXY?: number;
+    /**
+     * The precision with which to represent the coordinates, when using the
+     * MGRS format. The value must be an integer between 0 and 8 (inclusive).
+     * The default is 5.
+     */
+    precisionMGRS?: number;
+    /**
+     * The precision with which to represent the coordinates, when using the
+     * USNG format. The value must be an integer between 0 and 8 (inclusive).
+     * The default is 5.
+     */
+    precisionUSNG?: number;
+    /**
+     * Whether or not the corresponding component should render the coordinate
+     * format selector. The default is true.
+     */
+    showCoordinateFormats?: boolean;
+}

package/app-config/web/MapCoordinatesModelProperties.js

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

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

@@ -0,0 +1,81 @@
+import type { Feature as GraphicJson } from "@vertigis/arcgis-extensions/portal/Feature";
+import type { Symbol as SymbolJson } from "@vertigis/arcgis-extensions/portal/Symbol";
+import type { Viewpoint as ViewpointJson } from "@vertigis/arcgis-extensions/portal/Viewpoint";
+import type { ItemRef } from "../common/ItemRef.js";
+import type { MapModelProperties as CommonMapModelProperties } from "../common/MapModelProperties.js";
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+/**
+ * Direction in which the layer-comparison bar can slide.
+ */
+export declare type LayerComparisonDirection = "horizontal" | "vertical";
+/**
+ * The position of the label relative to the slider bar.
+ */
+export declare type LayerComparisonLabelPosition = "start" | "center" | "end";
+/**
+ * Properties for configuring a MapModel.
+ */
+export interface MapModelProperties extends CommonMapModelProperties, ComponentModelProperties {
+    /**
+     * The symbology for the map's context menu marker.
+     */
+    contextMarkerSymbol?: Symbol | SymbolJson;
+    /**
+     * Whether or not to pulse new features that are dynamically added to the
+     * map's stream layers. The default is false.
+     */
+    pulseNewStreamFeatures?: boolean;
+    /**
+     * Layers used within the map's layer-comparison tool, positioned on the
+     * left if the layer-comparison orientation is 'horizontal' or on the top if
+     * the layer-comparison orientation is 'vertical'.
+     */
+    leadingLayers?: ItemRef[];
+    /**
+     * The label shown on the map for the leading layers, when the
+     * layer-comparison tool is active.
+     */
+    leadingLayersLabel?: string;
+    /**
+     * Layers used within the map's layer-comparison tool, positioned on the
+     * right if the layer-comparison orientation is 'horizontal' or on the
+     * bottom if the layer-comparison orientation is 'vertical'.
+     */
+    trailingLayers?: ItemRef[];
+    /**
+     * The label shown on the map for the trailing layers, when the
+     * layer-comparison tool is active.
+     */
+    trailingLayersLabel?: string;
+    /**
+     * Whether or not the layer-comparison tool is active on the map.
+     */
+    layerComparisonIsActive?: boolean;
+    /**
+     * The direction in which the layer-comparison bar slides. 'horizontal'
+     * positions the leading layers on the left and trailing layers on the
+     * right; 'vertical' positions the leading layers on the top and the
+     * trailing layers on the bottom.
+     */
+    layerComparisonDirection?: LayerComparisonDirection;
+    /**
+     * The position of the label relative to the slider bar. The default is
+     * "start".
+     */
+    layerComparisonLabelPosition?: LayerComparisonLabelPosition;
+    /**
+     * Whether or not the leading and trailing layers are configurable from the
+     * label buttons on the map. The default is true.
+     */
+    layerComparisonIsConfigurable?: boolean;
+    /**
+     * The viewpoint of the map. This property is only serialized to saved
+     * projects.
+     */
+    viewpoint?: ViewpointJson;
+    /**
+     * The markup graphics currently present on the map. This property is only
+     * serialized to saved projects.
+     */
+    markupGraphics?: GraphicJson[];
+}

package/app-config/web/MapModelProperties.js

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

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

@@ -0,0 +1,36 @@
+import type { DrawModelBaseProperties } from "./DrawModelProperties.js";
+/**
+ * Properties used to create and config a MeasurementModel.
+ */
+export interface MeasurementModelProperties extends DrawModelBaseProperties {
+    /**
+     * The number of decimal places to use in measurement labels. The default is
+     * 2.
+     */
+    decimalPlaces?: number;
+    /**
+     * The units used when creating measurement labels for polylines. When left
+     * undefined, measurement units will be intelligently assigned based on the
+     * locale. The default is undefined.
+     */
+    lengthUnits?: LengthMeasurementUnits;
+    /**
+     * The units used when creating measurement labels for polygons. When left
+     * undefined, measurement units will be intelligently assigned based on the
+     * locale. The default is undefined.
+     */
+    areaUnits?: AreaMeasurementUnits;
+    /**
+     * Whether measurements are geodesic. The default is true. If set to false,
+     * measurements will be planar.
+     */
+    isGeodesic?: boolean;
+}
+/**
+ * The units for area measurements supported by ArcGIS.
+ */
+export declare type AreaMeasurementUnits = "acres" | "ares" | "hectares" | "square-feet" | "square-meters" | "square-yards" | "square-kilometers" | "square-miles";
+/**
+ * The units for length measurements supported by ArcGIS.
+ */
+export declare type LengthMeasurementUnits = "meters" | "feet" | "kilometers" | "miles" | "nautical-miles" | "yards";

package/app-config/web/MeasurementModelProperties.js

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

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

@@ -0,0 +1,7 @@
+import type { MenuItemProperties } from "@vertigis/arcgis-extensions/menus/MenuItem";
+import type { HasVisibilityFilters } from "./HasVisibilityFilters.js";
+/**
+ * @inheritdoc
+ */
+export interface MenuItemModelProperties extends MenuItemProperties, HasVisibilityFilters {
+}

package/app-config/web/MenuItemModelProperties.js

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

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

@@ -0,0 +1,13 @@
+import type { ItemRef } from "../common/ItemRef.js";
+import type { MenuModelProperties as CommonMenuModelProperties } from "../common/MenuModelProperties.js";
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+import type { MenuItemModelProperties } from "./MenuItemModelProperties.js";
+/**
+ * @inheritdoc
+ */
+export interface MenuModelProperties extends CommonMenuModelProperties, ComponentModelProperties {
+    /**
+     * Individual menu items for this menu.
+     */
+    items: (ItemRef | MenuItemModelProperties)[];
+}

package/app-config/web/MenuModelProperties.js

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

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

@@ -0,0 +1,7 @@
+import type { InitializableBaseProperties } from "@vertigis/arcgis-extensions/support/InitializableBase";
+import type { ModelProperties as CommonModelProperties } from "../common/ModelProperties.js";
+/**
+ * Properties that can be used to create or update a model.
+ */
+export interface ModelProperties extends CommonModelProperties, InitializableBaseProperties {
+}

package/app-config/web/ModelProperties.js

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

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

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

package/app-config/web/PanelModelProperties.js

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

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

@@ -0,0 +1,10 @@
+import type { ModelProperties } from "../common/ModelProperties.js";
+/**
+ * Properties that are used for the Portal service.
+ */
+export interface PortalModelProperties extends ModelProperties {
+    /**
+     * Tags by which the Choose Layer modal will filter out the displayed layers.
+     */
+    layerFilterTags?: string[];
+}

package/app-config/web/PortalModelProperties.js

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