@vertigis/viewer-spec 50.5.0 → 50.5.1

package/README.md

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

package/analytics/AnalyticsContext.d.ts

@@ -1,5 +1,6 @@
 /**
- * Contextual information that is used for reporting events to VertiGIS Studio Analytics.
+ * Contextual information that is used for reporting events to VertiGIS Studio
+ * Analytics.
  */
 export interface AnalyticsContext {
     /**

package/analytics/CommonAction.d.ts

@@ -32,7 +32,8 @@ export declare type CommonAction =
  */
  | "bookmark-update"
 /**
- * Map action, if the bookmark is admin-defined in a map. Payload: bookmark title.
+ * Map action, if the bookmark is admin-defined in a map. Payload: bookmark
+ * title.
  */
  | "bookmark-view"
 /**

package/analytics/MobileAction.d.ts

@@ -89,7 +89,8 @@ export declare type MobileAction = CommonAction
  */
  | "settings-log-level-set"
 /**
- * Generic action. Payload: boolean value indicating if setting is set to true.
+ * Generic action. Payload: boolean value indicating if setting is set to
+ * true.
  */
  | "settings-measurement-system-set"
 /**
@@ -97,11 +98,13 @@ export declare type MobileAction = CommonAction
  */
  | "settings-photo-quality-set"
 /**
- * Generic action. Payload: boolean value indicating if setting is set to true.
+ * Generic action. Payload: boolean value indicating if setting is set to
+ * true.
  */
  | "settings-remember-layer-visibility-set"
 /**
- * Generic action. Payload: boolean value indicating if setting is set to true.
+ * Generic action. Payload: boolean value indicating if setting is set to
+ * true.
  */
  | "settings-remember-map-extent-set"
 /**

package/app-config/AppConfig.d.ts

@@ -1,15 +1,16 @@
 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.
+ * The most recent VertiGIS Studio 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.
+ * 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 {
     /**
@@ -18,7 +19,8 @@ export interface AppConfig {
      */
     schemaVersion: string;
     /**
-     * Specifies zero or more App configurations that are imported into this one.
+     * 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
@@ -36,7 +38,8 @@ export interface AppConfig {
         [setting: string]: string | number | boolean;
     };
     /**
-     * User-defined failure modes for particular items. Items are referenced by item uri.
+     * User-defined failure modes for particular items. Items are referenced by
+     * item uri.
      */
     failureModes?: {
         [itemUri: string]: FailureMode;

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

@@ -15,7 +15,8 @@ export interface BrandingThemeProperties {
      */
     id: string;
     /**
-     * The accent color used to generate this theme, if it was automatically generated.
+     * The accent color used to generate this theme, if it was automatically
+     * generated.
      */
     accentColor?: Color | ColorJson;
     /**
@@ -27,7 +28,8 @@ export interface BrandingThemeProperties {
      */
     title: string;
     /**
-     * The template used to generate this theme, if it was automatically generated.
+     * The template used to generate this theme, if it was automatically
+     * generated.
      */
     template?: BrandingThemeTemplate;
 }

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

@@ -18,7 +18,8 @@ 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.
+     * value. If this property is undefined, no highlight graphics will get
+     * rendered.
      */
     highlightColor?: Color | ColorJson;
     /**
@@ -39,7 +40,8 @@ export interface HighlightModelProperties extends ServiceModelProperties {
     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.
+     * this property is undefined, no markers will be rendered for in-scale
+     * focusing.
      */
     focusMarkerSymbol?: Symbol | SymbolJson;
     /**

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

@@ -7,7 +7,8 @@ import type { ComponentModelProperties } from "./ComponentModelProperties.js";
 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.
+     * existing 'layer-preset' item, or inline JSON defining a layer-preset
+     * item.
      */
     layerPresets?: (ItemRef | LayerPresetProperties)[];
 }

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

@@ -4,7 +4,7 @@ import type { ModelProperties } from "./ModelProperties.js";
  */
 export interface LicensingModelProperties extends ModelProperties {
     /**
-     * The organization's Geocortex account ID.
+     * The organization's VertiGIS Studio account ID.
      */
     accountId?: string;
 }

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

@@ -1,7 +1,8 @@
 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).
+ * Configuration for a results component (e.g. results list or results table in
+ * Web).
  */
 export interface ResultsModelProperties extends ComponentModelProperties {
     /**

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

@@ -21,7 +21,8 @@ export interface TranslateOptions extends FormatSettings {
     locale?: string;
     /**
      * The values to substitute into the format string if it contains
-     * substitution placeholders (see utilities/string/format in Geocortex API).
+     * substitution placeholders (see utilities/string/format in ArcGIS
+     * Extensions API).
      */
     args?: unknown[];
 }

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

@@ -24,7 +24,8 @@ export interface WorkflowModelProperties extends ComponentModelProperties {
      * 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.
+     * child of the targeted container, and removed when the workflow finishes
+     * running.
      */
     target?: string;
     /**
@@ -32,7 +33,8 @@ export interface WorkflowModelProperties extends ComponentModelProperties {
      */
     portalItem?: PortalItemLike;
     /**
-     * The name of the workflow input parameter that the command's context will map to.
+     * The name of the workflow input parameter that the command's context will
+     * map to.
      */
     commandArgumentInput?: string;
     /**

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

@@ -9,11 +9,13 @@ export interface FeatureDetailsModelProperties extends CommonFeatureDetailsModel
      */
     maxAttachmentSize?: number;
     /**
-     * The action to perform when delete is called from the feature details view.
+     * The action to perform when delete is called from the feature details
+     * view.
      */
     onFeatureDelete?: Action;
     /**
-     * The action to perform when delete is called from the feature details view.
+     * The action to perform when delete is called from the feature details
+     * view.
      */
     onFeatureEdit?: Action;
     /**

package/app-config/mobile/VertigisMobileModelProperties.d.ts

@@ -52,9 +52,10 @@ export interface VertigisMobileModelProperties extends ApplicationModelPropertie
     privacyPolicyUrl?: string;
     /**
      * An optional URL specifying the endpoint of a Portal app item containing
-     * the latest version of the app configuration. Upon launching the Geocortex
-     * Mobile Viewer, the referenced remote app configuration will be downloaded
-     * and loaded if it is more recent than the embedded or cached app configuration.
+     * the latest version of the app configuration. Upon launching the VertiGIS
+     * Studio Mobile Viewer, the referenced remote app configuration will be
+     * downloaded and loaded if it is more recent than the embedded or cached
+     * app configuration.
      */
     remoteConfigUrl?: string;
     /**