@vertigis/viewer-spec 56.12.0 → 56.13.0

package/messaging/common.d.ts

@@ -2,6 +2,7 @@ import type Graphic from "@arcgis/core/Graphic";
 import type Viewpoint from "@arcgis/core/Viewpoint";
 import type Geometry from "@arcgis/core/geometry/Geometry";
 import type Layer from "@arcgis/core/layers/Layer";
+import type LabelClass from "@arcgis/core/layers/support/LabelClass";
 import type EsriFeatureSet from "@arcgis/core/rest/support/FeatureSet";
 import type LineSymbol3D from "@arcgis/core/symbols/LineSymbol3D";
 import type PictureFillSymbol from "@arcgis/core/symbols/PictureFillSymbol";
@@ -11,6 +12,7 @@ import type PolygonSymbol3D from "@arcgis/core/symbols/PolygonSymbol3D";
 import type SimpleFillSymbol from "@arcgis/core/symbols/SimpleFillSymbol";
 import type SimpleLineSymbol from "@arcgis/core/symbols/SimpleLineSymbol";
 import type SimpleMarkerSymbol from "@arcgis/core/symbols/SimpleMarkerSymbol";
+import type TextSymbol from "@arcgis/core/symbols/TextSymbol";
 import type { Entity } from "@vertigis/arcgis-extensions/Entity";
 import type { Feature, FeatureProperties } from "@vertigis/arcgis-extensions/data/Feature";
 import type { FeatureList } from "@vertigis/arcgis-extensions/data/FeatureList";
@@ -18,9 +20,10 @@ import type { FeatureSet } from "@vertigis/arcgis-extensions/data/FeatureSet";
 import type { FeatureSource } from "@vertigis/arcgis-extensions/data/FeatureSource";
 import type { FeatureStream } from "@vertigis/arcgis-extensions/data/FeatureStream";
 import type { TableExtension, TableReference as TableReferenceObject } from "@vertigis/arcgis-extensions/data/TableExtension";
+import type { LabelingInfoJson } from "@vertigis/arcgis-extensions/json/DrawingInfoJson";
 import type { FeatureJson } from "@vertigis/arcgis-extensions/json/FeatureJson";
 import type { GeometryJson } from "@vertigis/arcgis-extensions/json/GeometryJson";
-import type { LineSymbol3DJson, PictureFillSymbolJson, PictureMarkerSymbolJson, PointSymbol3DJson, PolygonSymbol3DJson, SimpleFillSymbolJson, SimpleLineSymbolJson, SimpleMarkerSymbolJson } from "@vertigis/arcgis-extensions/json/SymbolJson";
+import type { LineSymbol3DJson, PictureFillSymbolJson, PictureMarkerSymbolJson, PointSymbol3DJson, PolygonSymbol3DJson, SimpleFillSymbolJson, SimpleLineSymbolJson, SimpleMarkerSymbolJson, TextSymbolJson } from "@vertigis/arcgis-extensions/json/SymbolJson";
 import type { ViewpointJson } from "@vertigis/arcgis-extensions/json/ViewpointJson";
 import type { BasemapExtension } from "@vertigis/arcgis-extensions/mapping/BasemapExtension";
 import type { Bookmark, BookmarkProperties } from "@vertigis/arcgis-extensions/mapping/Bookmark";
@@ -57,6 +60,14 @@ export interface CreateGraphicsResult {
  * Represents one or more features.
  */
 export type FeaturesLike = Feature | FeatureSet | FeatureList | FeatureStream | (Feature | FeatureProperties)[];
+/**
+ * Represents one or more LabelingInfo.
+ */
+export type LabelingInfoLike = LabelingInfoJson | LabelClass | (LabelingInfoJson | LabelClass)[];
+/**
+ * One or more LabelingInfos, or an object that has LabelingInfos.
+ */
+export type LabelingInfos = LabelingInfoLike | HasLabelingInfo;
 /**
  * Feature results from an operation.
  */
@@ -71,6 +82,15 @@ export interface HasFeatures {
      */
     features?: FeaturesLike;
 }
+/**
+ * Defines an object that has a `labelingInfo` property.
+ */
+export interface HasLabelingInfo {
+    /**
+     * LabelingInfos to use for the command/operation.
+     */
+    labelingInfo?: LabelingInfoLike;
+}
 /**
  * Defines an object that has a `maps` property and a `features` property.
  */
@@ -246,7 +266,7 @@ export interface HasViewPoint {
 /**
  * Symbols supported for drawing.
  */
-export type SymbolLike = SimpleMarkerSymbol | SimpleMarkerSymbolJson | PictureMarkerSymbol | PictureMarkerSymbolJson | SimpleLineSymbol | SimpleLineSymbolJson | SimpleFillSymbol | SimpleFillSymbolJson | PictureFillSymbol | PictureFillSymbolJson | PointSymbol3D | PointSymbol3DJson | LineSymbol3D | LineSymbol3DJson | PolygonSymbol3D | PolygonSymbol3DJson;
+export type SymbolLike = SimpleMarkerSymbol | SimpleMarkerSymbolJson | PictureMarkerSymbol | PictureMarkerSymbolJson | SimpleLineSymbol | SimpleLineSymbolJson | SimpleFillSymbol | SimpleFillSymbolJson | PictureFillSymbol | PictureFillSymbolJson | PointSymbol3D | PointSymbol3DJson | LineSymbol3D | LineSymbol3DJson | PolygonSymbol3D | PolygonSymbol3DJson | TextSymbol | TextSymbolJson;
 /**
  * An object that has a `symbol` property.
  */

package/messaging/registry/layers.d.ts

@@ -1,4 +1,5 @@
 import type { TaskSettingsProperties } from "@vertigis/arcgis-extensions/data/TaskSettings.js";
+import type { LabelingInfoJson } from "@vertigis/arcgis-extensions/json/DrawingInfoJson.js";
 import type { PopupInfoJson } from "@vertigis/arcgis-extensions/json/PopupInfoJson.js";
 import type { Command } from "../Command.js";
 import { CommandRegistry } from "../CommandRegistry.js";
@@ -63,6 +64,10 @@ export interface HasLayerSettings {
      * The title of the layer.
      */
     title?: string | string[];
+    /**
+     * The labeling class of the layer.
+     */
+    labelingInfo?: LabelingInfoJson[] | LabelingInfoJson[][];
 }
 /**
  * Arguments for a `layers.edit-settings` operation.
@@ -77,6 +82,12 @@ export declare class LayersCommands extends CommandRegistry {
      * @webOnly
      */
     get ensureCanSetSymbol(): Command<SetSymbolArgs>;
+    /**
+     * Updates the label classes of the provided layer(s). Web only.
+     *
+     * @webOnly
+     */
+    get setLabelClasses(): Command<LayerSettingsArgs>;
     /**
      * Updates the provided layer(s) with new popup template configuration. Web
      * only.
@@ -130,6 +141,12 @@ export declare class LayersOperations extends OperationRegistry {
      * @webOnly
      */
     get getPopupTemplate(): Operation<HasLayers, LayerSettingsArgs>;
+    /**
+     * Retrieves the label classes for supplied layer(s). Web only.
+     *
+     * @webOnly
+     */
+    get getLabelClasses(): Operation<HasLayers, LayerSettingsArgs>;
     /**
      * Retrieves the values for the 'taskSettings' applied to the supplied
      * layer(s). Web only.
@@ -151,6 +168,14 @@ export declare class LayersOperations extends OperationRegistry {
      * @webOnly
      */
     get editSettings(): Operation<LayerSettingsArgs, LayerSettingsArgs>;
+    /**
+     * Shows a UI for editing the label classes on an existing layer or layers.
+     * Note that changes will not be applied to the supplied layers by this
+     * operation. Use `layers.set-label-classes` for this. Web only.
+     *
+     * @webOnly
+     */
+    get editLabelSettings(): Operation<LayerSettingsArgs, LayerSettingsArgs>;
     /**
      * Edit the symbol from an existing layer or layers. Note that changes to
      * these symbols will not be applied to the layers by this operation. Use

package/messaging/registry/layers.js

@@ -1 +1 @@
-import{CommandRegistry as t}from"../CommandRegistry.js";import{EventRegistry as e}from"../EventRegistry.js";import{OperationRegistry as s}from"../OperationRegistry.js";export class LayersCommands extends t{constructor(){super(...arguments),this._prefix="layers"}get ensureCanSetSymbol(){return this._get("ensure-can-set-symbol")}get setPopupTemplate(){return this._get("set-popup-template")}get setSymbol(){return this._get("set-symbol")}get setTaskSettings(){return this._get("set-task-settings")}get setTitle(){return this._get("set-title")}get setVisibility(){return this._get("set-visibility")}get showLabels(){return this._get("show-labels")}get hideLabels(){return this._get("hide-labels")}}export class LayersOperations extends s{constructor(){super(...arguments),this._prefix="layers"}get getPopupTemplate(){return this._get("get-popup-template")}get getTaskSettings(){return this._get("get-task-settings")}get getTitle(){return this._get("get-title")}get editSettings(){return this._get("edit-settings")}get editSymbols(){return this._get("edit-symbols")}}export class LayersEvents extends e{constructor(){super(...arguments),this._prefix="layers"}get visibilityChanged(){return this._get("visibility-changed")}}
+import{CommandRegistry as t}from"../CommandRegistry.js";import{EventRegistry as e}from"../EventRegistry.js";import{OperationRegistry as s}from"../OperationRegistry.js";export class LayersCommands extends t{constructor(){super(...arguments),this._prefix="layers"}get ensureCanSetSymbol(){return this._get("ensure-can-set-symbol")}get setLabelClasses(){return this._get("set-label-classes")}get setPopupTemplate(){return this._get("set-popup-template")}get setSymbol(){return this._get("set-symbol")}get setTaskSettings(){return this._get("set-task-settings")}get setTitle(){return this._get("set-title")}get setVisibility(){return this._get("set-visibility")}get showLabels(){return this._get("show-labels")}get hideLabels(){return this._get("hide-labels")}}export class LayersOperations extends s{constructor(){super(...arguments),this._prefix="layers"}get getPopupTemplate(){return this._get("get-popup-template")}get getLabelClasses(){return this._get("get-label-classes")}get getTaskSettings(){return this._get("get-task-settings")}get getTitle(){return this._get("get-title")}get editSettings(){return this._get("edit-settings")}get editLabelSettings(){return this._get("edit-symbol-settings")}get editSymbols(){return this._get("edit-symbols")}}export class LayersEvents extends e{constructor(){super(...arguments),this._prefix="layers"}get visibilityChanged(){return this._get("visibility-changed")}}

package/messaging/schema/common-action.schema.json

@@ -1102,6 +1102,9 @@
                         {
                             "$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleMarkerSymbolJson"
                         },
+                        {
+                            "$ref": "#/definitions/esri.rest-api.SymbolJson.TextSymbolJson"
+                        },
                         {
                             "$ref": "#/definitions/esri.rest-api.SymbolJson.LineSymbol3DJson"
                         },
@@ -1134,6 +1137,9 @@
                         },
                         {
                             "$ref": "#/definitions/esri.PolygonSymbol3D"
+                        },
+                        {
+                            "$ref": "#/definitions/esri.TextSymbol"
                         }
                     ],
                     "description": "The symbol that should be used to create the graphic. If null, a default is provided."

package/messaging/schema/mobile-action.schema.json

@@ -1246,6 +1246,9 @@
                         {
                             "$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleMarkerSymbolJson"
                         },
+                        {
+                            "$ref": "#/definitions/esri.rest-api.SymbolJson.TextSymbolJson"
+                        },
                         {
                             "$ref": "#/definitions/esri.rest-api.SymbolJson.LineSymbol3DJson"
                         },
@@ -1278,6 +1281,9 @@
                         },
                         {
                             "$ref": "#/definitions/esri.PolygonSymbol3D"
+                        },
+                        {
+                            "$ref": "#/definitions/esri.TextSymbol"
                         }
                     ],
                     "description": "The symbol that should be used to create the graphic. If null, a default is provided."

package/messaging/schema/web-action.schema.json

@@ -1621,6 +1621,9 @@
                         {
                             "$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleMarkerSymbolJson"
                         },
+                        {
+                            "$ref": "#/definitions/esri.rest-api.SymbolJson.TextSymbolJson"
+                        },
                         {
                             "$ref": "#/definitions/esri.rest-api.SymbolJson.LineSymbol3DJson"
                         },
@@ -1653,6 +1656,9 @@
                         },
                         {
                             "$ref": "#/definitions/esri.PolygonSymbol3D"
+                        },
+                        {
+                            "$ref": "#/definitions/esri.TextSymbol"
                         }
                     ],
                     "description": "The symbol that should be used to create the graphic. If null, a default is provided."
@@ -2506,6 +2512,9 @@
                         {
                             "$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleMarkerSymbolJson"
                         },
+                        {
+                            "$ref": "#/definitions/esri.rest-api.SymbolJson.TextSymbolJson"
+                        },
                         {
                             "$ref": "#/definitions/esri.rest-api.SymbolJson.LineSymbol3DJson"
                         },
@@ -2539,6 +2548,9 @@
                         {
                             "$ref": "#/definitions/esri.PolygonSymbol3D"
                         },
+                        {
+                            "$ref": "#/definitions/esri.TextSymbol"
+                        },
                         {
                             "items": {
                                 "$ref": "#/definitions/SymbolLike"
@@ -2592,6 +2604,9 @@
                         {
                             "$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleMarkerSymbolJson"
                         },
+                        {
+                            "$ref": "#/definitions/esri.rest-api.SymbolJson.TextSymbolJson"
+                        },
                         {
                             "$ref": "#/definitions/esri.rest-api.SymbolJson.LineSymbol3DJson"
                         },
@@ -2625,6 +2640,9 @@
                         {
                             "$ref": "#/definitions/esri.PolygonSymbol3D"
                         },
+                        {
+                            "$ref": "#/definitions/esri.TextSymbol"
+                        },
                         {
                             "items": {
                                 "$ref": "#/definitions/SymbolLike"
@@ -4219,6 +4237,26 @@
             "additionalProperties": false,
             "description": "Arguments for a `layers.edit-settings` operation.",
             "properties": {
+                "labelingInfo": {
+                    "anyOf": [
+                        {
+                            "items": {
+                                "$ref": "#/definitions/esri.rest-api.DrawingInfoJson.LabelingInfoJson"
+                            },
+                            "type": "array"
+                        },
+                        {
+                            "items": {
+                                "items": {
+                                    "$ref": "#/definitions/esri.rest-api.DrawingInfoJson.LabelingInfoJson"
+                                },
+                                "type": "array"
+                            },
+                            "type": "array"
+                        }
+                    ],
+                    "description": "The labeling class of the layer."
+                },
                 "layers": {
                     "$ref": "#/definitions/LayersLike",
                     "description": "Layer(s) to use for the command/operation."
@@ -4258,6 +4296,9 @@
                         {
                             "$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleMarkerSymbolJson"
                         },
+                        {
+                            "$ref": "#/definitions/esri.rest-api.SymbolJson.TextSymbolJson"
+                        },
                         {
                             "$ref": "#/definitions/esri.rest-api.SymbolJson.LineSymbol3DJson"
                         },
@@ -4291,6 +4332,9 @@
                         {
                             "$ref": "#/definitions/esri.PolygonSymbol3D"
                         },
+                        {
+                            "$ref": "#/definitions/esri.TextSymbol"
+                        },
                         {
                             "items": {
                                 "$ref": "#/definitions/SymbolLike"
@@ -6091,6 +6135,9 @@
                         {
                             "$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleMarkerSymbolJson"
                         },
+                        {
+                            "$ref": "#/definitions/esri.rest-api.SymbolJson.TextSymbolJson"
+                        },
                         {
                             "$ref": "#/definitions/esri.rest-api.SymbolJson.LineSymbol3DJson"
                         },
@@ -6124,6 +6171,9 @@
                         {
                             "$ref": "#/definitions/esri.PolygonSymbol3D"
                         },
+                        {
+                            "$ref": "#/definitions/esri.TextSymbol"
+                        },
                         {
                             "items": {
                                 "$ref": "#/definitions/SymbolLike"
@@ -6632,6 +6682,9 @@
                 {
                     "$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleMarkerSymbolJson"
                 },
+                {
+                    "$ref": "#/definitions/esri.rest-api.SymbolJson.TextSymbolJson"
+                },
                 {
                     "$ref": "#/definitions/esri.rest-api.SymbolJson.LineSymbol3DJson"
                 },
@@ -6664,6 +6717,9 @@
                 },
                 {
                     "$ref": "#/definitions/esri.PolygonSymbol3D"
+                },
+                {
+                    "$ref": "#/definitions/esri.TextSymbol"
                 }
             ],
             "description": "Symbols supported for drawing."
@@ -8237,6 +8293,9 @@
                 {
                     "$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleMarkerSymbolJson"
                 },
+                {
+                    "$ref": "#/definitions/esri.rest-api.SymbolJson.TextSymbolJson"
+                },
                 {
                     "$ref": "#/definitions/esri.rest-api.SymbolJson.LineSymbol3DJson"
                 },
@@ -8270,6 +8329,9 @@
                 {
                     "$ref": "#/definitions/esri.PolygonSymbol3D"
                 },
+                {
+                    "$ref": "#/definitions/esri.TextSymbol"
+                },
                 {
                     "$ref": "#/definitions/HasSymbol"
                 }
@@ -18750,6 +18812,15 @@
         "layers.hide-labels:input": {
             "$ref": "#/definitions/SetLabelVisibilityArgs"
         },
+        "layers.set-label-classes": {
+            "description": "Updates the label classes of the provided layer(s). Web only.",
+            "enum": [
+                "layers.set-label-classes"
+            ]
+        },
+        "layers.set-label-classes:input": {
+            "$ref": "#/definitions/LayerSettingsArgs"
+        },
         "layers.set-popup-template": {
             "description": "Updates the provided layer(s) with new popup template configuration. Web only.",
             "enum": [
@@ -20080,6 +20151,9 @@
                 {
                     "$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleMarkerSymbolJson"
                 },
+                {
+                    "$ref": "#/definitions/esri.rest-api.SymbolJson.TextSymbolJson"
+                },
                 {
                     "$ref": "#/definitions/esri.rest-api.SymbolJson.LineSymbol3DJson"
                 },
@@ -20113,6 +20187,9 @@
                 {
                     "$ref": "#/definitions/esri.PolygonSymbol3D"
                 },
+                {
+                    "$ref": "#/definitions/esri.TextSymbol"
+                },
                 {
                     "$ref": "#/definitions/HasSymbol"
                 }
@@ -22653,6 +22730,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/layers.set-label-classes:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/layers.set-label-classes"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -24562,6 +24655,9 @@
                 {
                     "$ref": "#/definitions/layers.hide-labels"
                 },
+                {
+                    "$ref": "#/definitions/layers.set-label-classes"
+                },
                 {
                     "$ref": "#/definitions/layers.set-popup-template"
                 },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertigis/viewer-spec",
-  "version": "56.12.0",
+  "version": "56.13.0",
   "license": "SEE LICENSE IN LICENSE",
   "description": "VertiGIS Viewer Specification",
   "type": "module",

package/version.d.ts

@@ -1,4 +1,4 @@
 /**
  * The current version of the VertiGIS Studio Viewer Specification.
  */
-export declare const version = "56.12.0";
+export declare const version = "56.13.0";

package/version.js

@@ -1,4 +1,4 @@
 /**
  * The current version of the VertiGIS Studio Viewer Specification.
  */
-export const version = "56.12.0";
+export const version = "56.13.0";