@vertigis/viewer-spec 61.18.1 → 61.19.0

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

@@ -1,11 +1,16 @@
 # command: auth.sign-in
 Description: Initiates user sign-in if they aren't already signed in. The argument indicates whether or not the map should be reloaded when the sign-in is complete. This argument is optional and only supported by VertiGIS Studio Mobile. Default is true.
 
-Inputs: `boolean`
+**Example:** Reload the map after signing in.
 
----
-# command: auth.sign-out
-Description: Signs the user out. The argument indicates whether or not the map should be reloaded when the sign-out is complete. This argument is optional and only supported by VertiGIS Studio Mobile. Default is true.
+```
+[
+    {
+        name: "auth.sign-in",
+        arguments: true,
+    },
+];
+```
 
 Inputs: `boolean`
 

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

@@ -1,6 +1,21 @@
 # operation: auth.get-current-user
 Description: Gets the user that is currently signed into the application.
 
+**Example:** Display a notification after obtaining the current user.
+
+```
+[
+    "auth.get-current-user",
+    {
+        name: "ui.display-notification",
+        arguments: {
+            message: "Signed in as a portal user.",
+            category: "info",
+        },
+    },
+];
+```
+
 Inputs: `None`
 
 Outputs: `Principal`

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

@@ -6,36 +6,41 @@ Web only.
 **Example:** Adding a CSV layer to the main map using `AddLayersArgs`.
 
 ```
-{
-    "layers": [
-        {
-            "id": "csv_123",
-            "layerType": "CSV",
-            "title": "Earthquakes",
-            "url": "http://earthquake.usgs.gov/earthquakes/feed/v1.0/summary/2.5_month.csv",
-            "columnDelimiter": ",",
-            "layerDefinition": {
-                "geometryType": "esriGeometryPoint",
-                "objectIdField": "__OBJECTID",
-                "capabilities": "Query",
-                "extent": {
-                    "xmin": -20034970.25849882,
-                    "ymin": -9494815.985282788,
-                    "xmax": 20026086.963133518,
-                    "ymax": 14269743.874052156,
-                    "spatialReference": {
-                        "wkid": 102100
-                    }
-                }
-            },
-            "locationInfo": {
-                "locationType": "coordinates",
-                "latitudeFieldName": "latitude",
-                "longitudeFieldName": "longitude"
-            }
-        }
-    ]
-}
+[
+    {
+        name: "map.add-layers",
+        arguments: {
+            layers: [
+                {
+                    id: "your-layer-id",
+                    layerType: "CSV",
+                    title: "Earthquakes",
+                    url: "http://earthquake.usgs.gov/earthquakes/feed/v1.0/summary/2.5_month.csv",
+                    columnDelimiter: ",",
+                    locationInfo: {
+                        locationType: "coordinates",
+                        latitudeFieldName: "latitude",
+                        longitudeFieldName: "longitude",
+                    },
+                    layerDefinition: {
+                        geometryType: "esriGeometryPoint",
+                        objectIdField: "__OBJECTID",
+                        capabilities: "Query",
+                        extent: {
+                            xmin: -20034970.25849882,
+                            ymin: -9494815.985282788,
+                            xmax: 20026086.963133518,
+                            ymax: 14269743.874052156,
+                            spatialReference: {
+                                wkid: 102100,
+                            },
+                        },
+                    },
+                },
+            ],
+        },
+    },
+];
 ```
 
 Inputs: `AddLayersArgs`
@@ -155,30 +160,40 @@ AddLayersArgs properties:
 # command: map.add-markup
 Description: Adds markup to the map(s).
 
-**Example:** Adding markup to a custom collection using `AddMarkupArgs`.
-
-```
-{
-    "collection": "my-custom-markup",
-    "graphics": [
-        {
-            "geometry": {
-                "x": -13733416.69,
-                "y": 6177670.86,
-                "spatialReference": {
-                    "wkid": 3857
+**Example:** Adding markup to a custom collection using `AddMarkupArgs`. In Mobile, the Graphic's symbol must use the formatting from Esri's Web Map specification: https://developers.arcgis.com/web-map-specification/objects/symbol/ .
+
+```
+[
+    {
+        name: "map.add-markup",
+        arguments: {
+            collection: "poi-highlights",
+            maps: "item://map-extension/your-mapExtension-id",
+            graphics: [
+                {
+                    geometry: {
+                        type: "point",
+                        x: -13733818,
+                        y: 6176951,
+                        spatialReference: {
+                            wkid: 3857,
+                        },
+                    },
+                    symbol: {
+                        type: "simple-marker",
+                        style: "circle",
+                        color: [0, 120, 212, 200],
+                        size: 16,
+                        outline: {
+                            color: [255, 255, 255, 255],
+                            width: 2,
+                        },
+                    },
                 },
-                "type": "point"
-            },
-            "symbol": {
-                "color": [76, 115, 0, 255],
-                "size": 16,
-                "style": "esriSMSCircle",
-                "type": "simple-marker"
-            }
-        }
-    ]
-}
+            ],
+        },
+    },
+];
 ```
 
 Inputs: `( CreateGraphicsResult | @arcgis.core.Graphic.Graphic | esri.rest-api.FeatureJson.FeatureJson | @arcgis.core.rest.support.FeatureSet.FeatureSet | ( @arcgis.core.Graphic.Graphic | esri.rest-api.FeatureJson.FeatureJson )[] | AddMarkupArgs )`
@@ -358,6 +373,30 @@ AddMarkupArgs properties:
 # command: map.apply-filter-effect
 Description: Applies a Filter Effect to the map(s). Web only.
 
+**Example:** Applying a filter effect to a layer with a specific id.
+
+```
+[
+    {
+        name: "map.apply-filter-effect",
+        arguments: {
+            layers: "your-layer-id",
+            where: "Magnitude >= 6.0",
+            featureMode: "replace",
+            maps: "item://map-extension/your-mapExtension-id",
+            includedEffect: {
+                brightness: "130%",
+                contrast: "120%",
+            },
+            excludedEffect: {
+                grayscale: "100%",
+                opacity: "25%",
+            },
+        },
+    },
+];
+```
+
 Inputs: `ApplyFilterEffectArgs`
 
 ApplyFilterEffectArgs properties:
@@ -408,6 +447,20 @@ ApplyFilterEffectArgs properties:
 # command: map.apply-layer-preset
 Description: Applies a LayerPreset to the map(s). Web only.
 
+**Example:**: Applying a defined layer preset.
+
+```
+[
+    {
+        name: "map.apply-layer-preset",
+        arguments: {
+            layerPreset: "item://layer-preset/your-layerPreset-id",
+            maps: "item://map-extension/your-mapExtension-id",
+        },
+    },
+];
+```
+
 Inputs: `ApplyLayerPresetArgs`
 
 ApplyLayerPresetArgs properties:
@@ -427,6 +480,17 @@ ApplyLayerPresetArgs properties:
 # command: map.clear-filter-effects
 Description: Clears all Filter Effects from the map(s). Web only.
 
+**Example:** Clearing all filter effects from the default map in a map extension.
+
+```
+[
+    {
+        name: "map.clear-filter-effects",
+        arguments: "item://map-extension/your-mapExtension-id",
+    },
+];
+```
+
 Inputs: `( @vertigis.arcgis-extensions.mapping.MapExtension.MapExtension | @vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[] | HasMaps )`
 
 HasMaps properties:
@@ -442,6 +506,20 @@ HasMaps properties:
 # command: map.clear-markup
 Description: Clears all markup from the map(s).
 
+**Example:** Clearing all markup from a custom collection on the default map in a map extension.
+
+```
+[
+    {
+        name: "map.clear-markup",
+        arguments: {
+            collection: "poi-highlights",
+            maps: "item://map-extension/your-mapExtension-id",
+        },
+    },
+];
+```
+
 Inputs: `( ClearMarkupArgs )`
 
 ClearMarkupArgs properties:
@@ -464,6 +542,31 @@ ClearMarkupArgs properties:
 # command: map.create-note
 Description: Create a map note. Web only.
 
+**Example:** Creating a map note based on the user-defined coordinates.
+
+```
+[
+    {
+        name: "map.get-user-coordinates-input",
+        arguments: {
+            completeLabel: "language-common-next",
+            attributes: {
+                slot: "top-start",
+            },
+        },
+    },
+    "tasks.identify",
+    {
+        name: "map.create-note",
+        arguments: {
+            attributes: {
+                slot: "top-start",
+            },
+        },
+    },
+];
+```
+
 Inputs: `CreateMapNoteArgs`
 
 CreateMapNoteArgs properties:
@@ -504,6 +607,31 @@ CreateMapNoteArgs properties:
 # command: map.edit-note
 Description: Edit an existing map note. Web only.
 
+**Example:** Editing a map note based on the user-defined coordinates.
+
+```
+[
+    {
+        name: "map.get-user-coordinates-input",
+        arguments: {
+            completeLabel: "language-common-next",
+            attributes: {
+                slot: "top-start",
+            },
+        },
+    },
+    "tasks.identify",
+    {
+        name: "map.edit-note",
+        arguments: {
+            attributes: {
+                slot: "top-start",
+            },
+        },
+    },
+];
+```
+
 Inputs: `EditMapNotesArgs`
 
 EditMapNotesArgs properties:
@@ -1329,6 +1457,20 @@ ZoomToViewpointArgs properties:
 # command: map.hide-markup
 Description: Show the specified markup collection, if hidden. If no collection is specified the default markup collection will be shown. Web only.
 
+**Example:** Hiding a custom collection using `MarkupArgs`.
+
+```
+[
+    {
+        name: "map.hide-markup",
+        arguments: {
+            collection: "poi-highlights",
+            maps: "item://map-extension/your-mapExtension-id",
+        },
+    },
+];
+```
+
 Inputs: `( MarkupArgs )`
 
 MarkupArgs properties:
@@ -1931,6 +2073,20 @@ HasMapGeometry properties:
 # command: map.remove-filter-effects
 Description: Removes a Filter Effect(s) from the map(s). Web only.
 
+**Example:** Removing a filter effect from a layer with a specific id.
+
+```
+[
+    {
+        name: "map.remove-filter-effects",
+        arguments: {
+            layers: "your-layer-id",
+            maps: "item://map-extension/your-mapExtension-id",
+        },
+    },
+];
+```
+
 Inputs: `Layers`
 
 Layers properties:
@@ -1969,6 +2125,24 @@ Layers properties:
 # command: map.remove-layers
 Description: Remove the specified layer(s) from the map(s). Web only.
 
+**Example:** Removing a layer with a specific id from the main map using `RemoveLayersArgs`.
+
+```
+[
+    {
+        name: "map.remove-layers",
+        arguments: {
+            maps: "item://map-extension/your-mapExtension-id",
+            layers: [
+                {
+                    id: "your-layer-id",
+                },
+            ],
+        },
+    },
+];
+```
+
 Inputs: `( @vertigis.arcgis-extensions.mapping._LayerExtension.LayerReference | @vertigis.arcgis-extensions.data._TableExtension.TableReference | @arcgis.core.layers.Layer.Layer | @vertigis.arcgis-extensions.mapping._LayerExtension.LayerExtension | esri.SublayerLike | @vertigis.arcgis-extensions.mapping._SublayerExtension.SublayerExtension | @vertigis.arcgis-extensions.data._TableExtension.TableExtension | LayerLike[] | RemoveLayersArgs | string )`
 
 @vertigis.arcgis-extensions.mapping._LayerExtension.LayerReference properties:
@@ -2028,6 +2202,20 @@ RemoveLayersArgs properties:
 # command: map.rotate-by
 Description: Rotates the map by the specified amount.
 
+**Example:** Rotating a map by 90 degrees with the defined id using `MapRotateArgs`.
+
+```
+[
+    {
+        name: "map.rotate-by",
+        arguments: {
+            rotation: 90,
+            maps: "item://map-extension/your-mapExtension-id",
+        },
+    },
+];
+```
+
 Inputs: `MapRotateArgs`
 
 MapRotateArgs properties:
@@ -2048,6 +2236,20 @@ MapRotateArgs properties:
 # command: map.rotate-to
 Description: Rotates the map to the specified angle.
 
+**Example:** Rotating a map to 45 degrees with the defined id using `MapRotateArgs`.
+
+```
+[
+    {
+        name: "map.rotate-to",
+        arguments: {
+            rotation: 45,
+            maps: "item://map-extension/your-mapExtension-id",
+        },
+    },
+];
+```
+
 Inputs: `MapRotateArgs`
 
 MapRotateArgs properties:
@@ -2068,6 +2270,20 @@ MapRotateArgs properties:
 # command: map.set-view-mode
 Description: Changes the view mode of a map to the specified mode, if supported. If no maps are specified, all maps will be targeted. Web only.
 
+**Example:** Setting the view mode to "scene" on a map with the defined id using `SetViewModeArgs`.
+
+```
+[
+    {
+        name: "map.set-view-mode",
+        arguments: {
+            viewMode: "scene",
+            maps: "item://map-extension/your-mapExtension-id",
+        },
+    },
+];
+```
+
 Inputs: `( SetViewModeArgs | "map" | "scene" )`
 
 SetViewModeArgs properties:
@@ -2087,6 +2303,20 @@ SetViewModeArgs properties:
 # command: map.show-markup
 Description: Show the specified markup collection, if hidden. If no collection is specified the default markup collection will be shown. Web only.
 
+**Example:** Showing a custom collection using `MarkupArgs`.
+
+```
+[
+    {
+        name: "map.show-markup",
+        arguments: {
+            collection: "poi-highlights",
+            maps: "item://map-extension/your-mapExtension-id",
+        },
+    },
+];
+```
+
 Inputs: `( MarkupArgs )`
 
 MarkupArgs properties:
@@ -2106,6 +2336,25 @@ MarkupArgs properties:
 # command: map.update-layer
 Description: Updates a layer in the map. Web only.
 
+**Example:** Updating a layer with a specific id using `UpdateLayerArgs`.
+
+```
+[
+    {
+        name: "map.update-layer",
+        arguments: {
+            layers: "your-layer-id",
+            maps: "item://map-extension/your-mapExtension-id",
+            layerJson: {
+                layerType: "CSV",
+                title: "Test-Update",
+                opacity: 0.3,
+            },
+        },
+    },
+];
+```
+
 Inputs: `UpdateLayerArgs`
 
 UpdateLayerArgs properties:
@@ -2129,6 +2378,19 @@ UpdateLayerArgs properties:
 # command: map.zoom-in
 Description: Zooms the map in by one level of detail. Web only.
 
+**Example:** Zooming in on a map with the defined id using `Maps` as an argument.
+
+```
+[
+    {
+        name: "map.zoom-in",
+        arguments: {
+            maps: "item://map-extension/your-mapExtension-id",
+        },
+    },
+];
+```
+
 Inputs: `( @vertigis.arcgis-extensions.mapping.MapExtension.MapExtension | @vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[] | HasMaps )`
 
 HasMaps properties:
@@ -2144,6 +2406,19 @@ HasMaps properties:
 # command: map.zoom-out
 Description: Zooms the map out by one level of detail. Web only.
 
+**Example:** Zooming out on a map with the defined id using `Maps` as an argument.
+
+```
+[
+    {
+        name: "map.zoom-out",
+        arguments: {
+            maps: "item://map-extension/your-mapExtension-id",
+        },
+    },
+];
+```
+
 Inputs: `( @vertigis.arcgis-extensions.mapping.MapExtension.MapExtension | @vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[] | HasMaps )`
 
 HasMaps properties:
@@ -2742,6 +3017,19 @@ HasMapGeometry properties:
 # command: map.zoom-to-initial-viewpoint
 Description: Zooms the map to its initial viewpoint.
 
+**Example:** Zooming to the initial viewpoint on a map with the defined id using `Maps` as an argument.
+
+```
+[
+    {
+        name: "map.zoom-to-initial-viewpoint",
+        arguments: {
+            maps: "item://map-extension/your-mapExtension-id",
+        },
+    },
+];
+```
+
 Inputs: `( @vertigis.arcgis-extensions.mapping.MapExtension.MapExtension | @vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[] | HasMaps )`
 
 HasMaps properties:
@@ -2757,6 +3045,20 @@ HasMaps properties:
 # command: map.zoom-to-layer-extent
 Description: Go to the full extent of the layer(s). If more than one layer is specified, it will zoom to the combined extent of all layers. Web only.
 
+**Example:** Zooming to the full extent of a layer with the defined id on a map with the defined id.
+
+```
+[
+    {
+        name: "map.zoom-to-layer-extent",
+        arguments: {
+            layers: "your-layer-id",
+            maps: "item://map-extension/your-mapExtension-id",
+        },
+    },
+];
+```
+
 Inputs: `ZoomToLayerArgs`
 
 ZoomToLayerArgs properties:
@@ -2776,6 +3078,20 @@ ZoomToLayerArgs properties:
 # command: map.zoom-to-layer-visible-scale
 Description: Go to the closest min/max scale of the layer. The map will not zoom if it is currently within the visible scale range. If multiple layers are provided, it will attempt to zoom to a scale range that makes all of the layers visible. If this is not possible (i.e. some of the layers' scale ranges don't overlap), then priority will be given to layers that come earlier in the sequence. Web only.
 
+**Example:** Zooming to the visible scale of a layer with the defined id on a map with the defined id.
+
+```
+[
+    {
+        name: "map.zoom-to-layer-visible-scale",
+        arguments: {
+            layers: "your-layer-id",
+            maps: "item://map-extension/your-mapExtension-id",
+        },
+    },
+];
+```
+
 Inputs: `ZoomToLayerArgs`
 
 ZoomToLayerArgs properties:
@@ -2797,6 +3113,19 @@ Description: Zooms to the next viewpoint to undo viewpoint changes from zooming
 
 Note that if no map is included as an argument, the command will run for all maps, which could result in unexpected behavior. Web only.
 
+**Example:** Zooming to the next viewpoint on a map with the defined id using `Maps` as an argument.
+
+```
+[
+    {
+        name: "map.zoom-to-next-viewpoint",
+        arguments: {
+            maps: "item://map-extension/your-mapExtension-id",
+        },
+    },
+];
+```
+
 Inputs: `( @vertigis.arcgis-extensions.mapping.MapExtension.MapExtension | @vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[] | HasMaps )`
 
 HasMaps properties:
@@ -2814,6 +3143,19 @@ Description: Zooms to the previous viewpoint.
 
 Note that if no map is included as an argument, the command will run for all maps, which could result in unexpected behavior. Web only.
 
+**Example:** Zooming to the previous viewpoint on a map with the defined id using `Maps` as an argument.
+
+```
+[
+    {
+        name: "map.zoom-to-previous-viewpoint",
+        arguments: {
+            maps: "item://map-extension/your-mapExtension-id",
+        },
+    },
+];
+```
+
 Inputs: `( @vertigis.arcgis-extensions.mapping.MapExtension.MapExtension | @vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[] | HasMaps )`
 
 HasMaps properties:
@@ -2829,6 +3171,20 @@ HasMaps properties:
 # command: map.zoom-to-scale
 Description: Zooms the map to a specified, numerical scale. Web only.
 
+**Example:** Zooming to a scale of 1:500 on a map with the defined id.
+
+```
+[
+    {
+        name: "map.zoom-to-scale",
+        arguments: {
+            scale: 500,
+            maps: "item://map-extension/your-mapExtension-id",
+        },
+    },
+];
+```
+
 Inputs: `ZoomToScaleArgs`
 
 ZoomToScaleArgs properties:
@@ -2849,6 +3205,30 @@ ZoomToScaleArgs properties:
 # command: map.zoom-to-viewpoint
 Description: Go to the given viewpoint.
 
+**Example:** Zooming to a viewpoint with the defined target geometry, rotation, and scale on a map with the defined id.
+
+```
+[
+    {
+        name: "map.zoom-to-viewpoint",
+        arguments: {
+            viewpoint: {
+                scale: 72224,
+                rotation: 30,
+                targetGeometry: {
+                    x: -122.4194,
+                    y: 37.7749,
+                    spatialReference: {
+                        wkid: 4326,
+                    },
+                },
+            },
+            maps: "item://map-extension/your-mapExtension-id",
+        },
+    },
+];
+```
+
 Inputs: `( @vertigis.arcgis-extensions.mapping.Bookmark.BookmarkProperties | @arcgis.core.Viewpoint.Viewpoint | esri.rest-api.ViewpointJson.ViewpointJson | ZoomToViewpointArgs )`
 
 @vertigis.arcgis-extensions.mapping.Bookmark.BookmarkProperties properties: