@vertigis/viewer-spec 47.0.0 → 47.3.0

package/layout/schema/layout-common.xsd

@@ -713,13 +713,43 @@
     <element name="layer-presets" substitutionGroup="tns:component">
     <annotation>
       <documentation xml:lang="en">
-        A component that shows a list of layer presets and allows users 
-        to apply them.
+        A component that shows a list of layer presets and allows users to apply
+        them.
       </documentation>
     </annotation>
     <complexType>
       <complexContent>
-        <extension base="tns:Component" />
+        <extension base="tns:Component">
+          <attribute name="filter-by">
+            <annotation>
+              <documentation xml:lang="en">
+                Indicates how the filter box will behave; if the value is
+                'none', no filter box will be displayed. Web only.
+              </documentation>
+            </annotation>
+            <simpleType>
+              <restriction base="string">
+                <enumeration value="none"/>
+                <enumeration value="title"/>
+                <enumeration value="title-and-description"/>
+              </restriction>
+            </simpleType>
+          </attribute>
+          <attribute name="show-title" type="boolean" default="true">
+            <annotation>
+              <documentation xml:lang="en">
+                Indicates if the title should be displayed. Web only.
+              </documentation>
+            </annotation>
+          </attribute>
+          <attribute name="show-icon" type="boolean" default="true">
+            <annotation>
+              <documentation xml:lang="en">
+                Indicates if the icon should be displayed. Web only.
+              </documentation>
+            </annotation>
+          </attribute>
+        </extension>
       </complexContent>
     </complexType>
   </element>

package/messaging/registry/edit.d.ts

@@ -7,10 +7,11 @@ import type { Event } from "../Event.js";
 import { EventRegistry } from "../EventRegistry.js";
 import type { Operation } from "../Operation.js";
 import { OperationRegistry } from "../OperationRegistry.js";
-import type { HasFeatures, HasGeometry, HasLayers, HasMaps, HasUITarget, MapsLike } from "../common.js";
+import type { Features, File, HasFeatures, HasGeometry, HasLayers, HasMaps, HasUITarget, MapsLike } from "../common.js";
 import type { EditGeometryOptions } from "./sketching.js";
 /**
- * Arguments for the "edit.add-attachment" command.
+ * Arguments for the "edit.add-attachment" command. Supported by both Web and
+ * Mobile.
  */
 export interface AddAttachmentArgs {
     /**
@@ -34,6 +35,42 @@ export interface AddAttachmentArgs {
      */
     data: number[];
 }
+/**
+ * VertiGIS Studio Web's arguments for the "edit.add-attachment" command. Not
+ * supported by Mobile.
+ */
+export interface WebAddAttachmentArgs {
+    /**
+     * The feature(s) to add the attachment(s) to. If multiple features are
+     * specified, the attachment(s) will be added to all features.
+     */
+    features: Features;
+    /**
+     * The blob(s) that contains the file attachment(s). If multiple attachments
+     * are specified, all attachment will be added to the feature(s).
+     */
+    blobs: File | File[];
+}
+/**
+ * Arguments for the "edit.delete-attachment" command.
+ */
+export interface DeleteAttachmentArgs {
+    /**
+     * The feature(s) to remove the attachment(s) from.
+     */
+    features: Features;
+    /**
+     * The attachment(s) to remove from the feature(s). This property can be
+     * populated with the title(s) or ID(s) of the attachments(s). Any and all
+     * matching attachments found on the input features will be deleted. Web
+     * only.
+     */
+    attachments?: string[];
+    /**
+     * The attachment to remove from the feature(s). Mobile only.
+     */
+    gcxAttachment?: Attachment;
+}
 /**
  * Arguments for various attachment events.
  */
@@ -131,9 +168,13 @@ export declare class EditCommands extends CommandRegistry {
      * Create and add an attachment to a provided feature, using the given
      * attachment data.
      *
-     * @mobileOnly
      */
-    get addAttachment(): Command<AddAttachmentArgs>;
+    get addAttachment(): Command<AddAttachmentArgs | WebAddAttachmentArgs>;
+    /**
+     * Deletes attachments from feature(s).
+     *
+     */
+    get deleteAttachment(): Command<DeleteAttachmentArgs>;
     /**
      * Adds a feature to a particular layer. `Feature[]` and
      * `EditCommandArgs` are not supported on Mobile.

package/messaging/registry/edit.js

@@ -1 +1 @@
-import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export class EditCommands extends CommandRegistry{get addAttachment(){return this._messages.command("edit.add-attachment")}get addFeature(){return this._messages.command("edit.add-feature")}get deleteFeatures(){return this._messages.command("edit.delete-features")}get displayAddFeature(){return this._messages.command("edit.display-add-feature")}get displayUpdateFeature(){return this._messages.command("edit.display-update-feature")}get updateFeature(){return this._messages.command("edit.update-feature")}}export class EditOperations extends OperationRegistry{get createFeature(){return this._messages.operation("edit.create-feature")}}export class EditEvents extends EventRegistry{get attachmentAdded(){return this._messages.event("edit.attachment-added")}get attachmentUpdated(){return this._messages.event("edit.attachment-updated")}get attachmentDeleted(){return this._messages.event("edit.attachment-deleted")}get featureAdded(){return this._messages.event("edit.feature-added")}get featureDeleted(){return this._messages.event("edit.feature-deleted")}get featureUpdated(){return this._messages.event("edit.feature-updated")}}
+import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export class EditCommands extends CommandRegistry{get addAttachment(){return this._messages.command("edit.add-attachment")}get deleteAttachment(){return this._messages.command("edit.delete-attachment")}get addFeature(){return this._messages.command("edit.add-feature")}get deleteFeatures(){return this._messages.command("edit.delete-features")}get displayAddFeature(){return this._messages.command("edit.display-add-feature")}get displayUpdateFeature(){return this._messages.command("edit.display-update-feature")}get updateFeature(){return this._messages.command("edit.update-feature")}}export class EditOperations extends OperationRegistry{get createFeature(){return this._messages.operation("edit.create-feature")}}export class EditEvents extends EventRegistry{get attachmentAdded(){return this._messages.event("edit.attachment-added")}get attachmentUpdated(){return this._messages.event("edit.attachment-updated")}get attachmentDeleted(){return this._messages.event("edit.attachment-deleted")}get featureAdded(){return this._messages.event("edit.feature-added")}get featureDeleted(){return this._messages.event("edit.feature-deleted")}get featureUpdated(){return this._messages.event("edit.feature-updated")}}

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

@@ -474,6 +474,46 @@
             ],
             "description": "A reference to a portal item."
         },
+        "AddAttachmentArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the \"edit.add-attachment\" command. Supported by both Web and Mobile.",
+            "properties": {
+                "contentType": {
+                    "description": "The MIME content type of the attachment.",
+                    "type": "string"
+                },
+                "data": {
+                    "description": "The binary data for the attachment.",
+                    "items": {
+                        "type": "number"
+                    },
+                    "type": "array"
+                },
+                "features": {
+                    "description": "The feature(s) to add the attachment to.",
+                    "items": {
+                        "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
+                    },
+                    "type": "array"
+                },
+                "maps": {
+                    "$ref": "MapsLike",
+                    "description": "The map."
+                },
+                "name": {
+                    "description": "The name of the attachment.",
+                    "type": "string"
+                }
+            },
+            "required": [
+                "contentType",
+                "data",
+                "features",
+                "maps",
+                "name"
+            ],
+            "type": "object"
+        },
         "AddNodeOrder": {
             "description": "Indicates whether a new point should be added before or after the active point in a sketch.",
             "enum": [
@@ -702,6 +742,31 @@
             ],
             "type": "object"
         },
+        "DeleteAttachmentArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the \"edit.delete-attachment\" command.",
+            "properties": {
+                "attachments": {
+                    "description": "The attachment(s) to remove from the feature(s). This property can be populated with the title(s) or ID(s) of the attachments(s). Any and all matching attachments found on the input features will be deleted. Web only.",
+                    "items": {
+                        "type": "string"
+                    },
+                    "type": "array"
+                },
+                "features": {
+                    "$ref": "#/definitions/Features",
+                    "description": "The feature(s) to remove the attachment(s) from."
+                },
+                "gcxAttachment": {
+                    "$ref": "@vertigis.arcgis-extensions.data.Attachment.Attachment",
+                    "description": "The attachment to remove from the feature(s). Mobile only."
+                }
+            },
+            "required": [
+                "features"
+            ],
+            "type": "object"
+        },
         "DeleteGeometryArgs": {
             "additionalProperties": false,
             "description": "Arguments for the \"sketching.delete\" command.",
@@ -2168,6 +2233,35 @@
             ],
             "type": "object"
         },
+        "WebAddAttachmentArgs": {
+            "additionalProperties": false,
+            "description": "VertiGIS Studio Web's arguments for the \"edit.add-attachment\" command. Not supported by Mobile.",
+            "properties": {
+                "blobs": {
+                    "anyOf": [
+                        {
+                            "$ref": "File"
+                        },
+                        {
+                            "items": {
+                                "$ref": "File"
+                            },
+                            "type": "array"
+                        }
+                    ],
+                    "description": "The blob(s) that contains the file attachment(s). If multiple attachments are specified, all attachment will be added to the feature(s)."
+                },
+                "features": {
+                    "$ref": "#/definitions/Features",
+                    "description": "The feature(s) to add the attachment(s) to. If multiple features are specified, the attachment(s) will be added to all features."
+                }
+            },
+            "required": [
+                "blobs",
+                "features"
+            ],
+            "type": "object"
+        },
         "WebOpenUrlArgs": {
             "additionalProperties": false,
             "description": "VertiGIS Studio Web's arguments for the system.open-url command.",
@@ -2314,6 +2408,22 @@
         "drawing.set-sync:input": {
             "type": "boolean"
         },
+        "edit.add-attachment": {
+            "description": "Create and add an attachment to a provided feature, using the given attachment data.",
+            "enum": [
+                "edit.add-attachment"
+            ]
+        },
+        "edit.add-attachment:input": {
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/AddAttachmentArgs"
+                },
+                {
+                    "$ref": "#/definitions/WebAddAttachmentArgs"
+                }
+            ]
+        },
         "edit.add-feature": {
             "description": "Adds a feature to a particular layer. `Feature[]` and `EditCommandArgs` are not supported on Mobile.",
             "enum": [
@@ -2336,6 +2446,15 @@
                 }
             ]
         },
+        "edit.delete-attachment": {
+            "description": "Deletes attachments from feature(s).",
+            "enum": [
+                "edit.delete-attachment"
+            ]
+        },
+        "edit.delete-attachment:input": {
+            "$ref": "#/definitions/DeleteAttachmentArgs"
+        },
         "edit.delete-features": {
             "description": "Deletes the given feature or features from their feature sources. `EditCommandArgs` is not supported on Mobile.",
             "enum": [
@@ -10634,9 +10753,6 @@
         "geocode.count:input": {
             "$ref": "#/definitions/GeocodeArgs"
         },
-        "geocode.count:output": {
-            "type": "undefined"
-        },
         "geocode.geocode": {
             "description": "Finds one or more locations corresponding to an address.",
             "enum": [
@@ -10646,9 +10762,6 @@
         "geocode.geocode:input": {
             "$ref": "#/definitions/GeocodeArgs"
         },
-        "geocode.geocode:output": {
-            "type": "undefined"
-        },
         "geocode.reverse-geocode": {
             "description": "Finds the address at a particular location. The geocoder must have the supportsReverseGeocoding capability.",
             "enum": [
@@ -10658,9 +10771,6 @@
         "geocode.reverse-geocode:input": {
             "$ref": "#/definitions/ReverseGeocodeArgs"
         },
-        "geocode.reverse-geocode:output": {
-            "type": "undefined"
-        },
         "geocode.suggest": {
             "description": "Suggests matching addresses to search for based on some input text. The geocoder must have the supportsSuggest capability.",
             "enum": [
@@ -10670,9 +10780,6 @@
         "geocode.suggest:input": {
             "$ref": "#/definitions/SuggestArgs"
         },
-        "geocode.suggest:output": {
-            "type": "undefined"
-        },
         "geolocation.auto-recenter": {
             "description": "Centers the map on the user's current location and keeps the location centered as it moves around. The maps parameter is only supported in Geocortex Mobile Viewer. In Geocortex Web Viewer, all maps are affected.",
             "enum": [
@@ -10722,9 +10829,6 @@
         "geolocation.get-location-permissions-enabled:input": {
             "type": "boolean"
         },
-        "geolocation.get-location-permissions-enabled:output": {
-            "type": "undefined"
-        },
         "geolocation.get-position": {
             "description": "Returns the current user position. This Operation can block while the user is prompted for permission, as such it is considered best practice not to perform this during startup.",
             "enum": [
@@ -11479,6 +11583,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/edit.add-attachment:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/edit.add-attachment"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -11495,6 +11615,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/edit.delete-attachment:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/edit.delete-attachment"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -11559,6 +11695,70 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/geocode.count:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/geocode.count"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/geocode.geocode:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/geocode.geocode"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/geocode.reverse-geocode:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/geocode.reverse-geocode"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/geocode.suggest:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/geocode.suggest"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -11575,6 +11775,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/geolocation.get-location-permissions-enabled:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/geolocation.get-location-permissions-enabled"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -12131,9 +12347,15 @@
                 {
                     "$ref": "#/definitions/drawing.set-sync"
                 },
+                {
+                    "$ref": "#/definitions/edit.add-attachment"
+                },
                 {
                     "$ref": "#/definitions/edit.add-feature"
                 },
+                {
+                    "$ref": "#/definitions/edit.delete-attachment"
+                },
                 {
                     "$ref": "#/definitions/edit.delete-features"
                 },
@@ -12146,12 +12368,27 @@
                 {
                     "$ref": "#/definitions/edit.update-feature"
                 },
+                {
+                    "$ref": "#/definitions/geocode.count"
+                },
+                {
+                    "$ref": "#/definitions/geocode.geocode"
+                },
+                {
+                    "$ref": "#/definitions/geocode.reverse-geocode"
+                },
+                {
+                    "$ref": "#/definitions/geocode.suggest"
+                },
                 {
                     "$ref": "#/definitions/geolocation.auto-recenter"
                 },
                 {
                     "$ref": "#/definitions/geolocation.display-location"
                 },
+                {
+                    "$ref": "#/definitions/geolocation.get-location-permissions-enabled"
+                },
                 {
                     "$ref": "#/definitions/geolocation.turn-off-geolocation"
                 },
@@ -12296,86 +12533,6 @@
                     ],
                     "type": "object"
                 },
-                {
-                    "additionalProperties": false,
-                    "properties": {
-                        "arguments": {
-                            "$ref": "#/definitions/geocode.count:input"
-                        },
-                        "name": {
-                            "$ref": "#/definitions/geocode.count"
-                        }
-                    },
-                    "required": [
-                        "name",
-                        "arguments"
-                    ],
-                    "type": "object"
-                },
-                {
-                    "additionalProperties": false,
-                    "properties": {
-                        "arguments": {
-                            "$ref": "#/definitions/geocode.geocode:input"
-                        },
-                        "name": {
-                            "$ref": "#/definitions/geocode.geocode"
-                        }
-                    },
-                    "required": [
-                        "name",
-                        "arguments"
-                    ],
-                    "type": "object"
-                },
-                {
-                    "additionalProperties": false,
-                    "properties": {
-                        "arguments": {
-                            "$ref": "#/definitions/geocode.reverse-geocode:input"
-                        },
-                        "name": {
-                            "$ref": "#/definitions/geocode.reverse-geocode"
-                        }
-                    },
-                    "required": [
-                        "name",
-                        "arguments"
-                    ],
-                    "type": "object"
-                },
-                {
-                    "additionalProperties": false,
-                    "properties": {
-                        "arguments": {
-                            "$ref": "#/definitions/geocode.suggest:input"
-                        },
-                        "name": {
-                            "$ref": "#/definitions/geocode.suggest"
-                        }
-                    },
-                    "required": [
-                        "name",
-                        "arguments"
-                    ],
-                    "type": "object"
-                },
-                {
-                    "additionalProperties": false,
-                    "properties": {
-                        "arguments": {
-                            "$ref": "#/definitions/geolocation.get-location-permissions-enabled:input"
-                        },
-                        "name": {
-                            "$ref": "#/definitions/geolocation.get-location-permissions-enabled"
-                        }
-                    },
-                    "required": [
-                        "name",
-                        "arguments"
-                    ],
-                    "type": "object"
-                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -12545,24 +12702,9 @@
                 {
                     "$ref": "#/definitions/basemap.get-current"
                 },
-                {
-                    "$ref": "#/definitions/geocode.count"
-                },
-                {
-                    "$ref": "#/definitions/geocode.geocode"
-                },
-                {
-                    "$ref": "#/definitions/geocode.reverse-geocode"
-                },
-                {
-                    "$ref": "#/definitions/geocode.suggest"
-                },
                 {
                     "$ref": "#/definitions/geolocation.get-current-state"
                 },
-                {
-                    "$ref": "#/definitions/geolocation.get-location-permissions-enabled"
-                },
                 {
                     "$ref": "#/definitions/geolocation.get-position"
                 },