@vertigis/viewer-spec 56.24.0 → 56.26.0

package/app-config/AppConfig.d.ts

@@ -1,55 +1,55 @@
-import type { FailureMode } from "@vertigis/arcgis-extensions/FailureMode";
-import type { ItemConfig } from "./ItemConfig.js";
-/**
- * The most recent VertiGIS Studio App configuration schema version supported by
- * this API.
- */
-export declare const CURRENT_SCHEMA_VERSION = "1.0";
-/**
- * Configuration for a VertiGIS Studio App. An App is a portable format for
- * describing the items and settings used by VertiGIS Studio applications. Items
- * that are defined within an App (e.g. menus, layer extensions, web maps, etc.)
- * can be retrieved by loading the App configuration into an {@link AppContainer}
- * and using its {@link AppContainer.get} method.
- */
-export interface AppConfig {
-    /**
-     * The version of the App configuration schema that is being used. Current
-     * version is available via the {@link CURRENT_SCHEMA_VERSION } constant.
-     */
-    schemaVersion: string;
-    /**
-     * Specifies zero or more App configurations that are imported into this
-     * one.
-     *
-     * Imports are processed in the order specified, followed by items and
-     * settings that are locally defined in this AppConfig. If the same item is
-     * defined multiple times, then the items' properties will get merged in
-     * such a way that the later definitions will override earlier ones.
-     * Similarly if a setting is defined several times, then the most recent
-     * definition wins.
-     */
-    import?: string[];
-    /**
-     * User-defined settings. These can be referenced via URIs in the form
-     * setting://setting-name.
-     */
-    settings?: {
-        [setting: string]: string | number | boolean;
-    };
-    /**
-     * User-defined failure modes for particular items. Items are referenced by
-     * item uri.
-     */
-    failureModes?: {
-        [itemUri: string]: FailureMode;
-    };
-    /**
-     * The set of items defined in the App (order is irrelevant).
-     */
-    items?: ItemConfig[];
-    /**
-     * A human-readable name for the App.
-     */
-    title?: string;
-}
+import type { FailureMode } from "@vertigis/arcgis-extensions/FailureMode";
+import type { ItemConfig } from "./ItemConfig.js";
+/**
+ * The most recent VertiGIS Studio App configuration schema version supported by
+ * this API.
+ */
+export declare const CURRENT_SCHEMA_VERSION = "1.0";
+/**
+ * Configuration for a VertiGIS Studio App. An App is a portable format for
+ * describing the items and settings used by VertiGIS Studio applications. Items
+ * that are defined within an App (e.g. menus, layer extensions, web maps, etc.)
+ * can be retrieved by loading the App configuration into an {@link AppContainer}
+ * and using its {@link AppContainer.get} method.
+ */
+export interface AppConfig {
+    /**
+     * The version of the App configuration schema that is being used. Current
+     * version is available via the {@link CURRENT_SCHEMA_VERSION } constant.
+     */
+    schemaVersion: string;
+    /**
+     * Specifies zero or more App configurations that are imported into this
+     * one.
+     *
+     * Imports are processed in the order specified, followed by items and
+     * settings that are locally defined in this AppConfig. If the same item is
+     * defined multiple times, then the items' properties will get merged in
+     * such a way that the later definitions will override earlier ones.
+     * Similarly if a setting is defined several times, then the most recent
+     * definition wins.
+     */
+    import?: string[];
+    /**
+     * User-defined settings. These can be referenced via URIs in the form
+     * setting://setting-name.
+     */
+    settings?: {
+        [setting: string]: string | number | boolean;
+    };
+    /**
+     * User-defined failure modes for particular items. Items are referenced by
+     * item uri.
+     */
+    failureModes?: {
+        [itemUri: string]: FailureMode;
+    };
+    /**
+     * The set of items defined in the App (order is irrelevant).
+     */
+    items?: ItemConfig[];
+    /**
+     * A human-readable name for the App.
+     */
+    title?: string;
+}

package/app-config/ItemConfig.d.ts

@@ -1,18 +1,18 @@
-/**
- * An item in an {@link AppConfig}.
- */
-export interface ItemConfig {
-    /**
-     * The item's type. See {@link ItemType}.
-     */
-    $type?: string;
-    /**
-     * The item's ID. No two items of the same type within an App can have the
-     * same ID (however, items of different types can have the same ID).
-     */
-    id?: string;
-    /**
-     * Type-specific properties of the item.
-     */
-    [properties: string]: unknown;
-}
+/**
+ * An item in an {@link AppConfig}.
+ */
+export interface ItemConfig {
+    /**
+     * The item's type. See {@link ItemType}.
+     */
+    $type?: string;
+    /**
+     * The item's ID. No two items of the same type within an App can have the
+     * same ID (however, items of different types can have the same ID).
+     */
+    id?: string;
+    /**
+     * Type-specific properties of the item.
+     */
+    [properties: string]: unknown;
+}

package/app-config/common/AnalyticsModelProperties.d.ts

@@ -1,10 +1,10 @@
-import type { ServiceModelProperties } from "./ServiceModelProperties.js";
-/**
- * Configuration for the Analytics Service.
- */
-export interface AnalyticsModelProperties extends ServiceModelProperties {
-    /**
-     * The URL used by VertiGIS Studio Analytics for tracking this application.
-     */
-    url?: string;
-}
+import type { ServiceModelProperties } from "./ServiceModelProperties.js";
+/**
+ * Configuration for the Analytics Service.
+ */
+export interface AnalyticsModelProperties extends ServiceModelProperties {
+    /**
+     * The URL used by VertiGIS Studio Analytics for tracking this application.
+     */
+    url?: string;
+}

package/app-config/common/ApplicationModelProperties.d.ts

@@ -1,15 +1,15 @@
-import type { Action } from "@vertigis/arcgis-extensions/support/Action";
-import type { ServiceModelProperties } from "../common/ServiceModelProperties.js";
-/**
- * Global configuration for an application.
- */
-export interface ApplicationModelProperties extends ServiceModelProperties {
-    /**
-     * Action to be triggered when viewer initialization is complete.
-     */
-    onInitialized?: Action;
-    /**
-     * Action to be triggered on viewer initialization before layout selection.
-     */
-    onInitializing?: Action;
-}
+import type { Action } from "@vertigis/arcgis-extensions/support/Action";
+import type { ServiceModelProperties } from "../common/ServiceModelProperties.js";
+/**
+ * Global configuration for an application.
+ */
+export interface ApplicationModelProperties extends ServiceModelProperties {
+    /**
+     * Action to be triggered when viewer initialization is complete.
+     */
+    onInitialized?: Action;
+    /**
+     * Action to be triggered on viewer initialization before layout selection.
+     */
+    onInitializing?: Action;
+}

package/app-config/common/BasemapPickerModelProperties.d.ts

@@ -1,6 +1,6 @@
-import type { ComponentModelProperties } from "./ComponentModelProperties.js";
-/**
- * Configuration for a basemap picker component.
- */
-export interface BasemapPickerModelProperties extends ComponentModelProperties {
-}
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+/**
+ * Configuration for a basemap picker component.
+ */
+export interface BasemapPickerModelProperties extends ComponentModelProperties {
+}

package/app-config/common/BookmarksModelProperties.d.ts

@@ -1,17 +1,17 @@
-import type { BookmarkProperties } from "@vertigis/arcgis-extensions/mapping/Bookmark";
-import type { Action } from "@vertigis/arcgis-extensions/support/Action";
-import type { ComponentModelProperties } from "./ComponentModelProperties.js";
-import type { ItemRef } from "./ItemRef.js";
-/**
- * Configuration for a bookmarks component.
- */
-export interface BookmarksModelProperties extends ComponentModelProperties {
-    /**
-     * The command to execute when the user clicks a bookmark.
-     */
-    onClick?: Action;
-    /**
-     * User preferences bookmarks.
-     */
-    userBookmarks?: (ItemRef | BookmarkProperties)[];
-}
+import type { BookmarkProperties } from "@vertigis/arcgis-extensions/mapping/Bookmark";
+import type { Action } from "@vertigis/arcgis-extensions/support/Action";
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+import type { ItemRef } from "./ItemRef.js";
+/**
+ * Configuration for a bookmarks component.
+ */
+export interface BookmarksModelProperties extends ComponentModelProperties {
+    /**
+     * The command to execute when the user clicks a bookmark.
+     */
+    onClick?: Action;
+    /**
+     * User preferences bookmarks.
+     */
+    userBookmarks?: (ItemRef | BookmarkProperties)[];
+}

package/app-config/common/BrandingColors.d.ts

@@ -1,102 +1,102 @@
-import type { ColorConfig } from "./colors.js";
-/**
- * Configuration for a branding theme's colors.
- */
-export interface BrandingColors {
-    accentIconBackground: ColorConfig;
-    accentIconBackgroundHover: ColorConfig;
-    accentIconBorder: ColorConfig;
-    accentIconBorderHover: ColorConfig;
-    accentIconForeground: ColorConfig;
-    accentIconForegroundHover: ColorConfig;
-    alertAmberBackground: ColorConfig;
-    alertAmberBackgroundHover: ColorConfig;
-    alertAmberBorder: ColorConfig;
-    alertAmberBorderHover: ColorConfig;
-    alertAmberForeground: ColorConfig;
-    alertAmberForegroundHover: ColorConfig;
-    alertAmberIcon: ColorConfig;
-    alertAmberIconHover: ColorConfig;
-    alertBackgroundDisabled: ColorConfig;
-    alertBorderDisabled: ColorConfig;
-    alertForegroundDisabled: ColorConfig;
-    alertGrayBackground: ColorConfig;
-    alertGrayBackgroundHover: ColorConfig;
-    alertGrayBorder: ColorConfig;
-    alertGrayBorderHover: ColorConfig;
-    alertGrayForeground: ColorConfig;
-    alertGrayForegroundHover: ColorConfig;
-    alertGrayIcon: ColorConfig;
-    alertGrayIconHover: ColorConfig;
-    alertGreenBackground: ColorConfig;
-    alertGreenBackgroundHover: ColorConfig;
-    alertGreenBorder: ColorConfig;
-    alertGreenBorderHover: ColorConfig;
-    alertGreenForeground: ColorConfig;
-    alertGreenForegroundHover: ColorConfig;
-    alertGreenIcon: ColorConfig;
-    alertGreenIconHover: ColorConfig;
-    alertIconDisabled: ColorConfig;
-    alertRedBackground: ColorConfig;
-    alertRedBackgroundHover: ColorConfig;
-    alertRedBorder: ColorConfig;
-    alertRedBorderHover: ColorConfig;
-    alertRedForeground: ColorConfig;
-    alertRedForegroundHover: ColorConfig;
-    alertRedIcon: ColorConfig;
-    alertRedIconHover: ColorConfig;
-    buttonBackground: ColorConfig;
-    buttonBackgroundDisabled: ColorConfig;
-    buttonBackgroundHover: ColorConfig;
-    buttonBorder: ColorConfig;
-    buttonBorderDisabled: ColorConfig;
-    buttonBorderHover: ColorConfig;
-    buttonForeground: ColorConfig;
-    buttonForegroundDisabled: ColorConfig;
-    buttonForegroundHover: ColorConfig;
-    buttonIcon: ColorConfig;
-    buttonIconDisabled: ColorConfig;
-    buttonIconHover: ColorConfig;
-    defaultMapBackground: ColorConfig;
-    disabledIconFill: ColorConfig;
-    emphasizedButtonBackground: ColorConfig;
-    emphasizedButtonBackgroundDisabled: ColorConfig;
-    emphasizedButtonBackgroundHover: ColorConfig;
-    emphasizedButtonBorder: ColorConfig;
-    emphasizedButtonBorderDisabled: ColorConfig;
-    emphasizedButtonBorderHover: ColorConfig;
-    emphasizedButtonForeground: ColorConfig;
-    emphasizedButtonForegroundDisabled: ColorConfig;
-    emphasizedButtonForegroundHover: ColorConfig;
-    emphasizedButtonIcon: ColorConfig;
-    emphasizedButtonIconDisabled: ColorConfig;
-    emphasizedButtonIconHover: ColorConfig;
-    errorHelperTextBackground: ColorConfig;
-    errorHelperTextForeground: ColorConfig;
-    errorIconBackground: ColorConfig;
-    errorIconForeground: ColorConfig;
-    inlineTableBorder: ColorConfig;
-    inlineTableHeaderBackground: ColorConfig;
-    inlineTableRowBackground: ColorConfig;
-    inputBorder: ColorConfig;
-    inputBorderDisabled: ColorConfig;
-    itemHoverBackground: ColorConfig;
-    itemSelectedBackground: ColorConfig;
-    loadingBarBackground: ColorConfig;
-    none: ColorConfig;
-    panelBorder: ColorConfig;
-    primaryAccent: ColorConfig;
-    primaryAccentDisabled: ColorConfig;
-    primaryAccentHover: ColorConfig;
-    primaryAccentLarge: ColorConfig;
-    primaryBackground: ColorConfig;
-    primaryBackgroundDisabled: ColorConfig;
-    primaryBorder: ColorConfig;
-    primaryForeground: ColorConfig;
-    primaryForegroundDisabled: ColorConfig;
-    secondaryBackground: ColorConfig;
-    secondaryBorder: ColorConfig;
-    secondaryForeground: ColorConfig;
-    tabPrimaryForeground: ColorConfig;
-    tabSecondaryForeground: ColorConfig;
-}
+import type { ColorConfig } from "./colors.js";
+/**
+ * Configuration for a branding theme's colors.
+ */
+export interface BrandingColors {
+    accentIconBackground: ColorConfig;
+    accentIconBackgroundHover: ColorConfig;
+    accentIconBorder: ColorConfig;
+    accentIconBorderHover: ColorConfig;
+    accentIconForeground: ColorConfig;
+    accentIconForegroundHover: ColorConfig;
+    alertAmberBackground: ColorConfig;
+    alertAmberBackgroundHover: ColorConfig;
+    alertAmberBorder: ColorConfig;
+    alertAmberBorderHover: ColorConfig;
+    alertAmberForeground: ColorConfig;
+    alertAmberForegroundHover: ColorConfig;
+    alertAmberIcon: ColorConfig;
+    alertAmberIconHover: ColorConfig;
+    alertBackgroundDisabled: ColorConfig;
+    alertBorderDisabled: ColorConfig;
+    alertForegroundDisabled: ColorConfig;
+    alertGrayBackground: ColorConfig;
+    alertGrayBackgroundHover: ColorConfig;
+    alertGrayBorder: ColorConfig;
+    alertGrayBorderHover: ColorConfig;
+    alertGrayForeground: ColorConfig;
+    alertGrayForegroundHover: ColorConfig;
+    alertGrayIcon: ColorConfig;
+    alertGrayIconHover: ColorConfig;
+    alertGreenBackground: ColorConfig;
+    alertGreenBackgroundHover: ColorConfig;
+    alertGreenBorder: ColorConfig;
+    alertGreenBorderHover: ColorConfig;
+    alertGreenForeground: ColorConfig;
+    alertGreenForegroundHover: ColorConfig;
+    alertGreenIcon: ColorConfig;
+    alertGreenIconHover: ColorConfig;
+    alertIconDisabled: ColorConfig;
+    alertRedBackground: ColorConfig;
+    alertRedBackgroundHover: ColorConfig;
+    alertRedBorder: ColorConfig;
+    alertRedBorderHover: ColorConfig;
+    alertRedForeground: ColorConfig;
+    alertRedForegroundHover: ColorConfig;
+    alertRedIcon: ColorConfig;
+    alertRedIconHover: ColorConfig;
+    buttonBackground: ColorConfig;
+    buttonBackgroundDisabled: ColorConfig;
+    buttonBackgroundHover: ColorConfig;
+    buttonBorder: ColorConfig;
+    buttonBorderDisabled: ColorConfig;
+    buttonBorderHover: ColorConfig;
+    buttonForeground: ColorConfig;
+    buttonForegroundDisabled: ColorConfig;
+    buttonForegroundHover: ColorConfig;
+    buttonIcon: ColorConfig;
+    buttonIconDisabled: ColorConfig;
+    buttonIconHover: ColorConfig;
+    defaultMapBackground: ColorConfig;
+    disabledIconFill: ColorConfig;
+    emphasizedButtonBackground: ColorConfig;
+    emphasizedButtonBackgroundDisabled: ColorConfig;
+    emphasizedButtonBackgroundHover: ColorConfig;
+    emphasizedButtonBorder: ColorConfig;
+    emphasizedButtonBorderDisabled: ColorConfig;
+    emphasizedButtonBorderHover: ColorConfig;
+    emphasizedButtonForeground: ColorConfig;
+    emphasizedButtonForegroundDisabled: ColorConfig;
+    emphasizedButtonForegroundHover: ColorConfig;
+    emphasizedButtonIcon: ColorConfig;
+    emphasizedButtonIconDisabled: ColorConfig;
+    emphasizedButtonIconHover: ColorConfig;
+    errorHelperTextBackground: ColorConfig;
+    errorHelperTextForeground: ColorConfig;
+    errorIconBackground: ColorConfig;
+    errorIconForeground: ColorConfig;
+    inlineTableBorder: ColorConfig;
+    inlineTableHeaderBackground: ColorConfig;
+    inlineTableRowBackground: ColorConfig;
+    inputBorder: ColorConfig;
+    inputBorderDisabled: ColorConfig;
+    itemHoverBackground: ColorConfig;
+    itemSelectedBackground: ColorConfig;
+    loadingBarBackground: ColorConfig;
+    none: ColorConfig;
+    panelBorder: ColorConfig;
+    primaryAccent: ColorConfig;
+    primaryAccentDisabled: ColorConfig;
+    primaryAccentHover: ColorConfig;
+    primaryAccentLarge: ColorConfig;
+    primaryBackground: ColorConfig;
+    primaryBackgroundDisabled: ColorConfig;
+    primaryBorder: ColorConfig;
+    primaryForeground: ColorConfig;
+    primaryForegroundDisabled: ColorConfig;
+    secondaryBackground: ColorConfig;
+    secondaryBorder: ColorConfig;
+    secondaryForeground: ColorConfig;
+    tabPrimaryForeground: ColorConfig;
+    tabSecondaryForeground: ColorConfig;
+}

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

@@ -1,23 +1,23 @@
-import type { BrandingThemeProperties } from "./BrandingThemeProperties.js";
-import type { ServiceModelProperties } from "./ServiceModelProperties.js";
-/**
- * Specifies the visual density of components in the application.
- */
-export type UIDensity = "standard" | "compact";
-/**
- * Configuration.
- */
-export interface BrandingModelProperties extends ServiceModelProperties {
-    /**
-     * The currently active theme.
-     */
-    activeTheme?: string;
-    /**
-     * A list of configured themes.
-     */
-    themes?: BrandingThemeProperties[];
-    /**
-     * Specifies the density of UI elements in the application.
-     */
-    density?: UIDensity;
-}
+import type { BrandingThemeProperties } from "./BrandingThemeProperties.js";
+import type { ServiceModelProperties } from "./ServiceModelProperties.js";
+/**
+ * Specifies the visual density of components in the application.
+ */
+export type UIDensity = "standard" | "compact";
+/**
+ * Configuration.
+ */
+export interface BrandingModelProperties extends ServiceModelProperties {
+    /**
+     * The currently active theme.
+     */
+    activeTheme?: string;
+    /**
+     * A list of configured themes.
+     */
+    themes?: BrandingThemeProperties[];
+    /**
+     * Specifies the density of UI elements in the application.
+     */
+    density?: UIDensity;
+}

package/app-config/common/BrandingThemeProperties.d.ts

@@ -1,35 +1,35 @@
-import type Color from "@arcgis/core/Color";
-import type { ColorJson } from "@vertigis/arcgis-extensions/json/SymbolJson.js";
-import type { BrandingColors } from "./BrandingColors.js";
-/**
- * The App Designer template that was used to generate a branding theme, if it
- * was generated.
- */
-export type BrandingThemeTemplate = "light" | "dark";
-/**
- * A branding theme specifies the look and feel of the viewer.
- */
-export interface BrandingThemeProperties {
-    /**
-     * A unique ID for this theme.
-     */
-    id: string;
-    /**
-     * The accent color used to generate this theme, if it was automatically
-     * generated.
-     */
-    accentColor?: Color | ColorJson;
-    /**
-     * The color keys and values.
-     */
-    colors: BrandingColors;
-    /**
-     * The display title for this theme.
-     */
-    title: string;
-    /**
-     * The template used to generate this theme, if it was automatically
-     * generated.
-     */
-    template?: BrandingThemeTemplate;
-}
+import type Color from "@arcgis/core/Color";
+import type { ColorJson } from "@vertigis/arcgis-extensions/json/SymbolJson.js";
+import type { BrandingColors } from "./BrandingColors.js";
+/**
+ * The App Designer template that was used to generate a branding theme, if it
+ * was generated.
+ */
+export type BrandingThemeTemplate = "light" | "dark";
+/**
+ * A branding theme specifies the look and feel of the viewer.
+ */
+export interface BrandingThemeProperties {
+    /**
+     * A unique ID for this theme.
+     */
+    id: string;
+    /**
+     * The accent color used to generate this theme, if it was automatically
+     * generated.
+     */
+    accentColor?: Color | ColorJson;
+    /**
+     * The color keys and values.
+     */
+    colors: BrandingColors;
+    /**
+     * The display title for this theme.
+     */
+    title: string;
+    /**
+     * The template used to generate this theme, if it was automatically
+     * generated.
+     */
+    template?: BrandingThemeTemplate;
+}

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

@@ -1,6 +1,6 @@
-import type { ComponentModelProperties } from "./ComponentModelProperties.js";
-/**
- * Configuration for a compass component.
- */
-export interface CompassModelProperties extends ComponentModelProperties {
-}
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+/**
+ * Configuration for a compass component.
+ */
+export interface CompassModelProperties extends ComponentModelProperties {
+}

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

@@ -1,14 +1,14 @@
-import type { ModelProperties } from "./ModelProperties.js";
-/**
- * Properties that can be used to create or update a component model.
- */
-export interface ComponentModelProperties extends ModelProperties {
-    /**
-     * An icon ID for this model.
-     */
-    icon?: string;
-    /**
-     * A human-readable title for this model.
-     */
-    title?: string;
-}
+import type { ModelProperties } from "./ModelProperties.js";
+/**
+ * Properties that can be used to create or update a component model.
+ */
+export interface ComponentModelProperties extends ModelProperties {
+    /**
+     * An icon ID for this model.
+     */
+    icon?: string;
+    /**
+     * A human-readable title for this model.
+     */
+    title?: string;
+}

package/app-config/common/CoordinateFormat.d.ts

@@ -1,4 +1,4 @@
-/**
- * The format in which a map coordinate could be displayed.
- */
-export type CoordinateFormat = "xy" | "lat-long-dd" | "lat-long-ddm" | "lat-long-dms" | "mgrs" | "usng" | "utm";
+/**
+ * The format in which a map coordinate could be displayed.
+ */
+export type CoordinateFormat = "xy" | "lat-long-dd" | "lat-long-ddm" | "lat-long-dms" | "mgrs" | "usng" | "utm";