@vertigis/viewer-spec 56.24.0 → 56.26.0

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

@@ -1,38 +1,38 @@
-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 an interactive feature
-     * editing session begins.
-     */
-    onFeatureEdit?: 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.
-     * The related Feature is passed in as the argument for the command(s).
-     */
-    onRelatedRecordClick?: Action;
-    /**
-     * If true, the feature details instance will show a button that runs the
-     * action that places the feature in edit mode.
-     */
-    showEditButton?: boolean;
-    /**
-     * If true, the feature details instance will show a button that deletes the
-     * feature permanently.
-     */
-    showDeleteButton?: boolean;
-}
+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 an interactive feature
+     * editing session begins.
+     */
+    onFeatureEdit?: 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.
+     * The related Feature is passed in as the argument for the command(s).
+     */
+    onRelatedRecordClick?: Action;
+    /**
+     * If true, the feature details instance will show a button that runs the
+     * action that places the feature in edit mode.
+     */
+    showEditButton?: boolean;
+    /**
+     * If true, the feature details instance will show a button that deletes the
+     * feature permanently.
+     */
+    showDeleteButton?: boolean;
+}

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

@@ -1,12 +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)[];
-}
+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/FeatureSetProperties.d.ts

@@ -1,16 +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;
-}
+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/FeatureSummaryModelProperties.d.ts

@@ -1,27 +1,27 @@
-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;
-    /**
-     * A command or set of commands to execute when a related record is clicked.
-     * The related Feature is passed in as the argument for the command(s).
-     */
-    onRelatedRecordClick?: Action;
-}
+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;
+    /**
+     * A command or set of commands to execute when a related record is clicked.
+     * The related Feature is passed in as the argument for the command(s).
+     */
+    onRelatedRecordClick?: Action;
+}

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

@@ -1,7 +1,7 @@
-import type { GeolocationModelProperties as CommonGeolocationModelProperties } from "../common/GeolocationModelProperties.js";
-import type { ComponentModelProperties } from "./ComponentModelProperties.js";
-/**
- * @inheritdoc
- */
-export interface GeolocationModelProperties extends CommonGeolocationModelProperties, ComponentModelProperties {
-}
+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/GeometryModelProperties.d.ts

@@ -1,27 +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;
-}
+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/HasVisibilityFilters.d.ts

@@ -1,36 +1,36 @@
-/**
- * A username for a particular ArcGIS Portal User.
- */
-export type PortalUsername = string;
-/**
- * The unique ID of an ArcGIS Portal Group.
- */
-export type PortalGroupId = string;
-/**
- * A defined set of user types for convenient configuration, based on
- * authentication.
- */
-export 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 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?: Iterable<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?: Iterable<VisibilityFilter>;
-}
+/**
+ * A username for a particular ArcGIS Portal User.
+ */
+export type PortalUsername = string;
+/**
+ * The unique ID of an ArcGIS Portal Group.
+ */
+export type PortalGroupId = string;
+/**
+ * A defined set of user types for convenient configuration, based on
+ * authentication.
+ */
+export 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 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?: Iterable<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?: Iterable<VisibilityFilter>;
+}

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

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

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

@@ -1,146 +1,146 @@
-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 type ReferenceType = "none" | "previous" | "fixed" | "statistic";
-/**
- * Determines how large the text and icon are for a KPI card section.
- */
-export type KpiCardSectionSize = "extra-small" | "small" | "medium" | "large" | "extra-large";
-/**
- * Identifies one of the three possible sections in a KPI card.
- */
-export type KpiCardSectionName = "top" | "middle" | "bottom";
+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 type ReferenceType = "none" | "previous" | "fixed" | "statistic";
+/**
+ * Determines how large the text and icon are for a KPI card section.
+ */
+export type KpiCardSectionSize = "extra-small" | "small" | "medium" | "large" | "extra-large";
+/**
+ * Identifies one of the three possible sections in a KPI card.
+ */
+export type KpiCardSectionName = "top" | "middle" | "bottom";