@vertigis/viewer-spec 42.10.0

package/app-config/common/HighlightModelProperties.js

@@ -0,0 +1 @@
+export var DisplayMode;!function(e){e.MAP="map",e.SCENE="scene",e.BOTH="both"}(DisplayMode||(DisplayMode={}));

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

@@ -0,0 +1,14 @@
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+/**
+ * Configuration for an image component.
+ */
+export interface ImageModelProperties extends ComponentModelProperties {
+    /**
+     * The image source.
+     */
+    src?: string;
+    /**
+     * The alternative text for the image.
+     */
+    alt: string;
+}

package/app-config/common/ImageModelProperties.js

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

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

@@ -0,0 +1,4 @@
+/**
+ * This is an item URI within the app. It would look like: item://<type>/<id>.
+ */
+export declare type ItemRef = string;

package/app-config/common/ItemRef.js

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

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

@@ -0,0 +1,12 @@
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+import type { ItemRef } from "./ItemRef.js";
+/**
+ * Configuration for a layer list component.
+ */
+export interface LayerListModelProperties extends ComponentModelProperties {
+    /**
+     * A reference to a Menu containing layer actions (menu items that take a
+     * layer as context).
+     */
+    layerActions?: ItemRef;
+}

package/app-config/common/LayerListModelProperties.js

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

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

@@ -0,0 +1,14 @@
+import type { LayerPresetProperties } from "@vertigis/arcgis-extensions/layer-preset/LayerPreset";
+import type { ItemRef } from "../common/ItemRef.js";
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+/**
+ * Configuration for a layer presets component.
+ */
+export interface LayerPresetsModelProperties extends ComponentModelProperties {
+    /**
+     * A collection of layer presets. Each element can be a reference to an
+     * existing 'layer-preset' item, or inline JSON defining a layer-preset
+     * item.
+     */
+    layerPresets?: (ItemRef | LayerPresetProperties)[];
+}

package/app-config/common/LayerPresetsModelProperties.js

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

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

@@ -0,0 +1,33 @@
+import type { Action } from "@vertigis/arcgis-extensions/support/Action";
+import type { ModelProperties } from "./ModelProperties.js";
+/**
+ * Properties that can be used to initialize a {@link Layout}.
+ */
+export interface LayoutProperties extends ModelProperties {
+    /**
+     * The URL of the layout XML (Either a URL or definition must be provided).
+     */
+    url?: string;
+    /**
+     * Application-defined tags associated with the layout, e.g. "handheld"
+     * or "high-contrast". An application might use these tags to choose a
+     * layout when there are multiple to choose from.
+     */
+    tags?: string[];
+    /**
+     * The stringified layout XML (Either a URL or definition must be provided).
+     */
+    definition?: string;
+    /**
+     * An action that will be performed when the layout has loaded.
+     */
+    onLayoutLoading?: Action;
+    /**
+     * An action that will be performed when the layout is about to load.
+     */
+    onLayoutLoaded?: Action;
+    /**
+     * The user-friendly title of the layout.
+     */
+    title?: string;
+}

package/app-config/common/LayoutProperties.js

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

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

@@ -0,0 +1,6 @@
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+/**
+ * Properties used to create or update a LegendModel.
+ */
+export interface LegendModelProperties extends ComponentModelProperties {
+}

package/app-config/common/LegendModelProperties.js

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

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

@@ -0,0 +1,10 @@
+import type { ModelProperties } from "./ModelProperties.js";
+/**
+ * Configuration for the licensing service.
+ */
+export interface LicensingModelProperties extends ModelProperties {
+    /**
+     * The organization's Geocortex account ID.
+     */
+    accountId?: string;
+}

package/app-config/common/LicensingModelProperties.js

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

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

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

package/app-config/common/MapCoordinatesModelProperties.js

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

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

@@ -0,0 +1,7 @@
+import type { MapExtensionProperties } from "@vertigis/arcgis-extensions/mapping/MapExtension";
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+/**
+ * Configuration for a map component.
+ */
+export interface MapModelProperties extends MapExtensionProperties, ComponentModelProperties {
+}

package/app-config/common/MapModelProperties.js

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

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

@@ -0,0 +1,13 @@
+import type { MenuProperties } from "@vertigis/arcgis-extensions/menus/Menu";
+import type { MenuItemProperties } from "@vertigis/arcgis-extensions/menus/MenuItem";
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+import type { ItemRef } from "./ItemRef.js";
+/**
+ * Configuration for a menu.
+ */
+export interface MenuModelProperties extends Omit<MenuProperties, "items">, ComponentModelProperties {
+    /**
+     * Individual menu items for this menu.
+     */
+    items: (ItemRef | MenuItemProperties)[];
+}

package/app-config/common/MenuModelProperties.js

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

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

@@ -0,0 +1,6 @@
+import type { EntityProperties } from "@vertigis/arcgis-extensions/Entity";
+/**
+ * Properties that can be used to create or update a model.
+ */
+export interface ModelProperties extends EntityProperties {
+}

package/app-config/common/ModelProperties.js

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

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

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

package/app-config/common/PanelModelProperties.js

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

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

@@ -0,0 +1,26 @@
+import type { FormatSettingsProperties } from "@vertigis/arcgis-extensions/support/FormatSettings";
+import type { ModelProperties } from "./ModelProperties.js";
+/**
+ * A system used to determine what units should be used for measurement values.
+ */
+export declare type MeasurementSystem = "metric" | "imperial";
+/**
+ * Properties that can be passed into the constructor for
+ * {@link RegionSettings}.
+ */
+export interface RegionModelProperties extends ModelProperties {
+    /**
+     * The fallback locale to use if the detected locale is not found in the
+     * app. This locale should be attempted to be used before 'invariant'.
+     */
+    fallbackLocale?: string;
+    /**
+     * The measurement system used to determine what units should be used for
+     * measurement values.
+     */
+    measurementSystem?: MeasurementSystem;
+    /**
+     * The root format settings for the app.
+     */
+    formatSettings?: FormatSettingsProperties;
+}

package/app-config/common/RegionModelProperties.js

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

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

@@ -0,0 +1,12 @@
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+import type { ItemRef } from "./ItemRef.js";
+/**
+ * Configuration for a results component (e.g. results list or results table in Web).
+ */
+export interface ResultsModelProperties extends ComponentModelProperties {
+    /**
+     * A menu used to run commands on specific features or groups of features.
+     * (MenuModel).
+     */
+    featureActions?: ItemRef;
+}

package/app-config/common/ResultsModelProperties.js

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

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

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

package/app-config/common/ScalebarModelProperties.js

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

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

@@ -0,0 +1,26 @@
+import type { Action } from "@vertigis/arcgis-extensions/support/Action";
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+/**
+ * Properties for a search component.
+ */
+export interface SearchModelProperties extends ComponentModelProperties {
+    /**
+     * The maximum number of results to return per feature source (layer,
+     * sublayer, table, geocoder, etc.).
+     */
+    maxResults?: number;
+    /**
+     * The maximum number of results to query per feature source, will be
+     * sorted by score and limited by maxResults NOTE: Not supported for layers on
+     * ArcGIS Server version 10.2 or older.
+     */
+    maxQueryResults?: number;
+    /**
+     * The command to execute when the user clears the search input.
+     */
+    onClear?: Action;
+    /**
+     * The command to execute when the user initiates a search.
+     */
+    onSearch?: Action;
+}

package/app-config/common/SearchModelProperties.js

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

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

@@ -0,0 +1,6 @@
+import type { ModelProperties } from "./ModelProperties.js";
+/**
+ * Base configuration for all services.
+ */
+export interface ServiceModelProperties extends ModelProperties {
+}

package/app-config/common/ServiceModelProperties.js

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

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

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

package/app-config/common/SplitModelProperties.js

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

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

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

package/app-config/common/StackModelProperties.js

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

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

@@ -0,0 +1,10 @@
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+/**
+ * Configuration for a text component.
+ */
+export interface TextModelProperties extends ComponentModelProperties {
+    /**
+     * The text content.
+     */
+    text?: string;
+}

package/app-config/common/TextModelProperties.js

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

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

@@ -0,0 +1,27 @@
+import type { FormatSettings } from "@vertigis/arcgis-extensions/utilities/FormatSettings";
+/**
+ * A translatable string, either a language string or a language string with
+ * arguments to pass into it.
+ */
+export declare type TranslatableText = string | TranslateOptions;
+/**
+ * The available options for the Locale Service translate function.
+ */
+export interface TranslateOptions extends FormatSettings {
+    /**
+     * The string to translate. If the text is a language resource key, then a
+     * localized version of that resource will be used if one exists, otherwise
+     * the original text is returned.
+     */
+    text: string;
+    /**
+     * The locale to use for translation. If not specified, the current locale
+     * will be used.
+     */
+    locale?: string;
+    /**
+     * The values to substitute into the format string if it contains
+     * substitution placeholders (see utilities/string/format in Geocortex API).
+     */
+    args?: unknown[];
+}

package/app-config/common/TranslatableText.js

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

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

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

package/app-config/common/UserModelProperties.js

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

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

@@ -0,0 +1,11 @@
+import type { ItemRef } from "./ItemRef.js";
+import type { ServiceModelProperties } from "./ServiceModelProperties.js";
+/**
+ * Configuration for the workflow events service. For internal use only.
+ */
+export interface WorkflowEventsProperties extends ServiceModelProperties {
+    /**
+     * An array of workflows to run when the app is launched. (Workflow[]).
+     */
+    workflows?: ItemRef[];
+}

package/app-config/common/WorkflowEventsProperties.js

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

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

@@ -0,0 +1,44 @@
+import type { PortalItemLike } from "@vertigis/arcgis-extensions/utilities/portal";
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+/**
+ * Properties that can be passed into the constructor for a Workflow model.
+ */
+export interface WorkflowModelProperties extends ComponentModelProperties {
+    /**
+     * The URL where the workflow JSON is located.
+     */
+    url?: string;
+    /**
+     * The title of the workflow.
+     */
+    title?: string;
+    /**
+     * An icon to display for the workflow.
+     */
+    icon?: string;
+    /**
+     * The inputs to be passed into the workflow.
+     */
+    inputs?: Record<string, unknown>;
+    /**
+     * The layout ID of the workflow component to use for any workflow forms, or
+     * the ID of a container component like taskbar, panel, stack, etc. In the
+     * latter case, a new workflow component will be created dynamically as a
+     * child of the targeted container, and removed when the workflow finishes
+     * running.
+     */
+    target?: string;
+    /**
+     * The portal item where the workflow JSON is located.
+     */
+    portalItem?: PortalItemLike;
+    /**
+     * The name of the workflow input parameter that the command's context will
+     * map to.
+     */
+    commandArgumentInput?: string;
+    /**
+     * Whether the workflow accepts URL parameters when run from the URL.
+     */
+    acceptsUrlParams?: boolean;
+}