@vertigis/viewer-spec 42.10.0

package/LICENSE

@@ -0,0 +1,5 @@
+VertiGIS North America Ltd. ("VERTIGIS NA") hereby grants You, free of charge, a personal, non-exclusive, nontransferable, license to access and use this software and associated documentation files (the "Software") for development purposes only. You shall not deploy the Software into production or use for revenue generating purposes. If You wish to deploy the Software into production, then the use of the Software shall be governed by VERTIGIS NA's Master License Agreement, which can be found at www.geocortex.com/legal and shall supersede all other terms of use.
+
+You shall include copyright and this permission notice in all copies or works involving the Software. 
+
+You acknowledge and agree that Software is provided AS IS and that VERTIGIS NA makes no representations and expressly disclaims any and all warranties of any kind, express or implied, including, but not limited to, any warranties regarding merchantability, fitness for a particular purpose, and noninfringement of intellectual property. In no event shall VERTIGIS NA be liable for any claim, damages, or other liability, whether in contract, tort, or other causes of action, arising from, out of, or in connection with the Software or use or other dealings with the Software. You shall bear all risk and liability regarding Your use of the Software and expressly acknowledge and agree that Your use of the Software is at Your own risk. You shall comply with all applicable laws.

package/README.md

@@ -0,0 +1,3 @@
+# Geocortex Viewer Specification
+
+This package contains specifications for app config JSON, layout XML, and a reference of all commands, operations, and events for the Geocortex Web and Geocortex Mobile viewers. For more information on extending these products, visit our [Developer Center](https://developers.geocortex.com/).

package/app-config/AppConfig.d.ts

@@ -0,0 +1,55 @@
+import type { FailureMode } from "@vertigis/arcgis-extensions/FailureMode";
+import type { ItemConfig } from "./ItemConfig.js";
+/**
+ * The most recent Geocortex App configuration schema version supported by this
+ * API.
+ */
+export declare const CURRENT_SCHEMA_VERSION = "1.0";
+/**
+ * Configuration for a Geocortex App. An App is a portable format for describing
+ * the items and settings used by Geocortex 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/AppConfig.js

@@ -0,0 +1 @@
+export const CURRENT_SCHEMA_VERSION="1.0";

package/app-config/ItemConfig.d.ts

@@ -0,0 +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;
+}

package/app-config/ItemConfig.js

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

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

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

package/app-config/common/BasemapPickerModelProperties.js

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

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

@@ -0,0 +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)[];
+}

package/app-config/common/BookmarksModelProperties.js

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

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

@@ -0,0 +1,94 @@
+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;
+    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;
+    alertRedBackground: ColorConfig;
+    alertRedBackgroundHover: ColorConfig;
+    alertRedBorder: ColorConfig;
+    alertRedBorderHover: ColorConfig;
+    alertRedForeground: ColorConfig;
+    alertRedForegroundHover: ColorConfig;
+    alertRedIcon: ColorConfig;
+    alertRedIconHover: ColorConfig;
+    alertBackgroundDisabled: ColorConfig;
+    alertBorderDisabled: ColorConfig;
+    alertForegroundDisabled: ColorConfig;
+    alertIconDisabled: 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;
+    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;
+    inlineTableHeaderBackground: ColorConfig;
+    inlineTableRowBackground: ColorConfig;
+    inlineTableBorder: ColorConfig;
+    inputBorder: ColorConfig;
+    itemSelectedBackground: ColorConfig;
+    itemHoverBackground: ColorConfig;
+    none: ColorConfig;
+    panelBorder: ColorConfig;
+    primaryAccent: ColorConfig;
+    primaryAccentDisabled: ColorConfig;
+    primaryAccentHover: ColorConfig;
+    primaryAccentLarge: ColorConfig;
+    primaryBackground: ColorConfig;
+    primaryBorder: ColorConfig;
+    primaryForeground: ColorConfig;
+    primaryForegroundDisabled: ColorConfig;
+    secondaryBackground: ColorConfig;
+    secondaryBorder: ColorConfig;
+    secondaryForeground: ColorConfig;
+    tabPrimaryForeground: ColorConfig;
+    tabSecondaryForeground: ColorConfig;
+}

package/app-config/common/BrandingColors.js

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

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

@@ -0,0 +1,23 @@
+import type { BrandingThemeProperties } from "./BrandingThemeProperties.js";
+import type { ServiceModelProperties } from "./ServiceModelProperties.js";
+/**
+ * Specifies the visual density of components in the application.
+ */
+export declare 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/BrandingModelProperties.js

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

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

@@ -0,0 +1,35 @@
+import type Color from "@arcgis/core/Color";
+import type { Color as ColorJson } from "@vertigis/arcgis-extensions/portal/Symbol";
+import type { BrandingColors } from "./BrandingColors.js";
+/**
+ * The App Designer template that was used to generate a branding theme, if it
+ * was generated.
+ */
+export declare 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/BrandingThemeProperties.js

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

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

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

package/app-config/common/CompassModelProperties.js

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

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

@@ -0,0 +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;
+}

package/app-config/common/ComponentModelProperties.js

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

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

@@ -0,0 +1,34 @@
+import type { SpatialReference as SpatialReferenceJson } from "@vertigis/arcgis-extensions/portal/SpatialReference";
+import type { GeographicTransformationJson, Transformation } from "@vertigis/arcgis-extensions/utilities/geometry";
+import type { ServiceModelProperties } from "./ServiceModelProperties.js";
+/**
+ * Specifies a transformation to use between two spatial references.
+ */
+export interface TransformationJson {
+    /**
+     * The spatial reference that the data is collected in.
+     */
+    inSpatialReference?: SpatialReferenceJson;
+    /**
+     * The spatial reference that the data is displayed in (typically the SR of
+     * the configured map's feature layers, or the SR of the map itself).
+     */
+    outSpatialReference?: SpatialReferenceJson;
+    /**
+     * The transformation to get from in SR to out SR.
+     */
+    transformation?: GeographicTransformationJson;
+}
+/**
+ * Configuration for the coordinate service.
+ */
+export interface CoordinateModelProperties extends ServiceModelProperties {
+    /**
+     * Whether the coordinates can be overridden by the end user.
+     */
+    canOverride?: boolean;
+    /**
+     * Rules to apply when transforming coordinates between coordinate systems.
+     */
+    transformations?: (Transformation | TransformationJson)[];
+}

package/app-config/common/CoordinateModelProperties.js

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

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

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

package/app-config/common/DialogModelProperties.js

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

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

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

package/app-config/common/ExpandModelProperties.js

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

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

@@ -0,0 +1,27 @@
+import type { Action } from "@vertigis/arcgis-extensions/support/Action";
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+import type { ItemRef } from "./ItemRef.js";
+/**
+ * Base properties for a feature-details component.
+ */
+export interface FeatureDetailsModelProperties extends ComponentModelProperties {
+    /**
+     * A menu of actions used to create clickable action buttons within the
+     * component. (MenuModel). For Mobile, the first four actions are designated
+     * as primary actions, with the remainder designated as secondary actions.
+     * If feature actions are configured globally as well as for the feature's
+     * source, then all actions will be displayed, with the feature source level
+     * actions shown first.
+     */
+    featureActions?: ItemRef;
+    /**
+     * A command or set of commands to execute when a feature becomes visible
+     * within the component.
+     */
+    onFeatureShow?: Action;
+    /**
+     * A command or set of commands to execute when a feature becomes invisible
+     * within the component.
+     */
+    onFeatureHide?: Action;
+}

package/app-config/common/FeatureDetailsModelProperties.js

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

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

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

package/app-config/common/GeolocationModelProperties.js

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

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

@@ -0,0 +1,69 @@
+import type Color from "@arcgis/core/Color";
+import type Symbol from "@arcgis/core/symbols/Symbol";
+import type { Color as ColorJson, Symbol as SymbolJson } from "@vertigis/arcgis-extensions/portal/Symbol";
+import type { TextSymbol } from "@vertigis/arcgis-extensions/portal/TextSymbol";
+import type { ServiceModelProperties } from "./ServiceModelProperties.js";
+/**
+ * Specifies which map mode(s) to display highlights.
+ */
+export declare enum DisplayMode {
+    MAP = "map",
+    SCENE = "scene",
+    BOTH = "both"
+}
+/**
+ * Configuration for the highlight service.
+ */
+export interface HighlightModelProperties extends ServiceModelProperties {
+    /**
+     * The color used for rendering highlight graphics on a map. A different
+     * border color for highlight graphics will be derived from this color
+     * value. If this property is undefined, no highlight graphics will get
+     * rendered.
+     */
+    highlightColor?: Color | ColorJson;
+    /**
+     * The symbol properties used for rendering a highlight marker on the map.
+     * If this property is undefined, no markers will be rendered for in-scale
+     * highlighting.
+     */
+    highlightMarkerSymbol?: Symbol | SymbolJson;
+    /**
+     * The symbol properties used for rendering highlight text on the map.
+     */
+    highlightLabelTextSymbol?: TextSymbol;
+    /**
+     * The color used for rendering focus graphics on a map. A different border
+     * color for focus graphics will be derived from this color value. If this
+     * property is undefined, no focus graphics will get rendered.
+     */
+    focusColor?: Color | ColorJson;
+    /**
+     * The symbol properties used for rendering a focus marker on the map. If
+     * this property is undefined, no markers will be rendered for in-scale
+     * focusing.
+     */
+    focusMarkerSymbol?: Symbol | SymbolJson;
+    /**
+     * The symbol properties used for rendering focus text on the map.
+     */
+    focusLabelTextSymbol?: TextSymbol;
+    /**
+     * The maximum allowed deviation from the generalized geometry to the
+     * original geometry.
+     */
+    maxDeviationInMeters?: number;
+    /**
+     * The maximum number of vertices a polyline or polygon geometry can have
+     * before it gets generalized.
+     */
+    maxVertices?: number;
+    /**
+     * The map view modes in which to display the highlight markers.
+     */
+    highlightMarkerDisplay?: DisplayMode;
+    /**
+     * The map view modes in which to display the focus markers.
+     */
+    focusMarkerDisplay?: DisplayMode;
+}