@vertigis/viewer-spec 61.2.1 → 61.2.3

package/messaging/registry/layers.d.ts

@@ -193,6 +193,15 @@ export declare class LayersCommands extends CommandRegistry {
      * }
      * ```
      *
+     * **Example:** Toggle layers' current visibility in a particular map.
+     *
+     * ```
+     * {
+     *     "layers": ["Victoria_Fire_Hydrants_8780", "Victoria_Trees_91238_a"]
+     *     "maps": "item://map-extension/e285a558-20b3-4f3d-aa37-a289eedbef4p"
+     * }
+     * ```
+     *
      * @webOnly
      */
     get setVisibility(): Command<SetVisibilityArgs>;

package/messaging/registry/sketching.d.ts

@@ -674,6 +674,22 @@ export declare class SketchingOperations extends OperationRegistry {
     /**
      * Allows the user to create geometry by sketching on a map. Returns the
      * geometry that was drawn, along with the map that it was drawn on.
+     *
+     * **Example:** Get the geometry of a polygon drawn on the map with the
+     * snapping plugin disabled.
+     *
+     * _Notes:_ If a plugin is enabled globally, setting it as disabled will
+     * override and disable the plugin when executing this operation (Web
+     * only).
+     *
+     * ```
+     * {
+     *      "geometryType": "polygon"
+     *      "pluginSettings": {
+     *          "snapping": false
+     *      }
+     * }
+     * ```
      */
     get captureGeometry(): Operation<CaptureGeometryArgs, CaptureGeometryResult>;
     /**

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

@@ -18135,7 +18135,7 @@
             "$ref": "#/definitions/AddPointArgs"
         },
         "sketching.capture-geometry": {
-            "description": "Allows the user to create geometry by sketching on a map. Returns the geometry that was drawn, along with the map that it was drawn on.",
+            "description": "Allows the user to create geometry by sketching on a map. Returns the geometry that was drawn, along with the map that it was drawn on.\n\n**Example:** Get the geometry of a polygon drawn on the map with the snapping plugin disabled.\n\n_Notes:_ If a plugin is enabled globally, setting it as disabled will override and disable the plugin when executing this operation (Web only).\n\n```\n{\n     \"geometryType\": \"polygon\"\n     \"pluginSettings\": {\n         \"snapping\": false\n     }\n}\n```",
             "enum": [
                 "sketching.capture-geometry"
             ]

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

@@ -20486,7 +20486,7 @@
             "$ref": "#/definitions/AddPointArgs"
         },
         "sketching.capture-geometry": {
-            "description": "Allows the user to create geometry by sketching on a map. Returns the geometry that was drawn, along with the map that it was drawn on.",
+            "description": "Allows the user to create geometry by sketching on a map. Returns the geometry that was drawn, along with the map that it was drawn on.\n\n**Example:** Get the geometry of a polygon drawn on the map with the snapping plugin disabled.\n\n_Notes:_ If a plugin is enabled globally, setting it as disabled will override and disable the plugin when executing this operation (Web only).\n\n```\n{\n     \"geometryType\": \"polygon\"\n     \"pluginSettings\": {\n         \"snapping\": false\n     }\n}\n```",
             "enum": [
                 "sketching.capture-geometry"
             ]

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

@@ -25297,7 +25297,7 @@
             "$ref": "#/definitions/LayerSettingsArgs"
         },
         "layers.set-visibility": {
-            "description": "Updates the visibility of the provided layer(s). Web only.\n\n**Example:** Toggle a layer's visibility off by id.\n\n```\n{\n    \"layers\": \"Victoria_Fire_Hydrants_8780\",\n    \"visible\": false\n}\n```",
+            "description": "Updates the visibility of the provided layer(s). Web only.\n\n**Example:** Toggle a layer's visibility off by id.\n\n```\n{\n    \"layers\": \"Victoria_Fire_Hydrants_8780\",\n    \"visible\": false\n}\n```\n\n**Example:** Toggle layers' current visibility in a particular map.\n\n```\n{\n    \"layers\": [\"Victoria_Fire_Hydrants_8780\", \"Victoria_Trees_91238_a\"]\n    \"maps\": \"item://map-extension/e285a558-20b3-4f3d-aa37-a289eedbef4p\"\n}\n```",
             "enum": [
                 "layers.set-visibility"
             ]
@@ -27783,7 +27783,7 @@
             ]
         },
         "sketching.capture-geometry": {
-            "description": "Allows the user to create geometry by sketching on a map. Returns the geometry that was drawn, along with the map that it was drawn on.",
+            "description": "Allows the user to create geometry by sketching on a map. Returns the geometry that was drawn, along with the map that it was drawn on.\n\n**Example:** Get the geometry of a polygon drawn on the map with the snapping plugin disabled.\n\n_Notes:_ If a plugin is enabled globally, setting it as disabled will override and disable the plugin when executing this operation (Web only).\n\n```\n{\n     \"geometryType\": \"polygon\"\n     \"pluginSettings\": {\n         \"snapping\": false\n     }\n}\n```",
             "enum": [
                 "sketching.capture-geometry"
             ]

package/messaging/schema/web-layers-command-definitions.md

@@ -1427,6 +1427,15 @@ Description: Updates the visibility of the provided layer(s). Web only.
 }
 ```
 
+**Example:** Toggle layers' current visibility in a particular map.
+
+```
+{
+    "layers": ["Victoria_Fire_Hydrants_8780", "Victoria_Trees_91238_a"]
+    "maps": "item://map-extension/e285a558-20b3-4f3d-aa37-a289eedbef4p"
+}
+```
+
 Inputs: `SetVisibilityArgs`
 
 SetVisibilityArgs properties:

package/messaging/schema/web-sketching-operation-definitions.md

@@ -1,6 +1,19 @@
 # operation: sketching.capture-geometry
 Description: Allows the user to create geometry by sketching on a map. Returns the geometry that was drawn, along with the map that it was drawn on.
 
+**Example:** Get the geometry of a polygon drawn on the map with the snapping plugin disabled.
+
+_Notes:_ If a plugin is enabled globally, setting it as disabled will override and disable the plugin when executing this operation (Web only).
+
+```
+{
+     "geometryType": "polygon"
+     "pluginSettings": {
+         "snapping": false
+     }
+}
+```
+
 Inputs: `CaptureGeometryArgs`
 
 CaptureGeometryArgs properties:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertigis/viewer-spec",
-  "version": "61.2.1",
+  "version": "61.2.3",
   "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 = "61.2.1";
+export declare const version = "61.2.3";

package/version.js

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