@vertigis/viewer-spec 61.18.2 → 61.20.0

package/messaging/registry/map.d.ts

@@ -734,29 +734,42 @@ export declare class MapCommands extends CommandRegistry {
      * Adds markup to the map(s).
      *
      * **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/ .
      *
      * ```
-     * {
-     *     "collection": "my-custom-markup",
-     *     "graphics": [
-     *         {
-     *             "geometry": {
-     *                 "x": -13733416.69,
-     *                 "y": 6177670.86,
-     *                 "spatialReference": {
-     *                     "wkid": 3857
+     * [
+     *     {
+     *         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"
-     *             }
-     *         }
-     *     ]
-     * }
+     *             ],
+     *         },
+     *     },
+     * ];
      * ```
      */
     get addMarkup(): Command<AddMarkupArgs | GraphicsLike>;
@@ -770,36 +783,41 @@ export declare class MapCommands extends CommandRegistry {
      * **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,
+     *                             },
+     *                         },
+     *                     },
+     *                 },
+     *             ],
+     *         },
+     *     },
+     * ];
      * ```
      *
      * @webOnly
@@ -808,41 +826,170 @@ export declare class MapCommands extends CommandRegistry {
     /**
      * 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%",
+     *             },
+     *         },
+     *     },
+     * ];
+     * ```
+     *
      * @webOnly
      */
     get applyFilterEffect(): Command<ApplyFilterEffectArgs>;
     /**
      * 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",
+     *         },
+     *     },
+     * ];
+     * ```
+     *
      * @webOnly
      */
     get applyLayerPreset(): Command<ApplyLayerPresetArgs>;
     /**
      * 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",
+     *             },
+     *         },
+     *     },
+     * ];
+     * ```
+     *
      * @webOnly
      */
     get createNote(): Command<CreateMapNoteArgs>;
     /**
      * 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",
+     *             },
+     *         },
+     *     },
+     * ];
+     * ```
+     *
      * @webOnly
      */
     get editNote(): Command<EditMapNotesArgs>;
     /**
      * 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",
+     *         },
+     *     },
+     * ];
+     * ```
+     *
      * @webOnly
      */
     get removeFilterEffects(): Command<Layers>;
     /**
      * 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",
+     *     },
+     * ];
+     * ```
+     *
      * @webOnly
      */
     get clearFilterEffects(): Command<Maps | void>;
     /**
      * 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",
+     *         },
+     *     },
+     * ];
+     * ```
      */
     get clearMarkup(): Command<ClearMarkupArgs | void>;
     /**
@@ -937,6 +1084,20 @@ export declare class MapCommands extends CommandRegistry {
      * 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",
+     *         },
+     *     },
+     * ];
+     * ```
+     *
      * @webOnly
      */
     get hideMarkup(): Command<MarkupArgs | void>;
@@ -968,6 +1129,25 @@ export declare class MapCommands extends CommandRegistry {
     /**
      * 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",
+     *                 },
+     *             ],
+     *         },
+     *     },
+     * ];
+     * ```
+     *
      * @webOnly
      */
     get removeLayers(): Command<LayersLike | RemoveLayersArgs>;
@@ -1002,10 +1182,40 @@ export declare class MapCommands extends CommandRegistry {
     get resumeSketch(): Command<HasMaps>;
     /**
      * 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",
+     *         },
+     *     },
+     * ];
+     * ```
      */
     get rotateBy(): Command<MapRotateArgs>;
     /**
      * 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",
+     *         },
+     *     },
+     * ];
+     * ```
      */
     get rotateTo(): Command<MapRotateArgs>;
     /**
@@ -1018,6 +1228,21 @@ export declare class MapCommands extends CommandRegistry {
      * 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",
+     *         },
+     *     },
+     * ];
+     * ```
+     *
      * @webOnly
      */
     get setViewMode(): Command<ViewMode | SetViewModeArgs>;
@@ -1025,12 +1250,45 @@ export declare class MapCommands extends CommandRegistry {
      * 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",
+     *         },
+     *     },
+     * ];
+     * ```
+     *
      * @webOnly
      */
     get showMarkup(): Command<MarkupArgs | void>;
     /**
      * 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,
+     *             },
+     *         },
+     *     },
+     * ];
+     * ```
+     *
      * @webOnly
      */
     get updateLayer(): Command<UpdateLayerArgs>;
@@ -1047,23 +1305,79 @@ export declare class MapCommands extends CommandRegistry {
     /**
      * 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",
+     *         },
+     *     },
+     * ];
+     * ```
+     *
      * @webOnly
      */
     get zoomIn(): Command<Maps | void>;
     /**
      * 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",
+     *         },
+     *     },
+     * ];
+     * ```
+     *
      * @webOnly
      */
     get zoomOut(): Command<Maps | void>;
     /**
      * 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",
+     *         },
+     *     },
+     * ];
+     * ```
+     *
      * @webOnly
      */
     get zoomToScale(): Command<ZoomToScaleArgs>;
     /**
      * 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",
+     *         },
+     *     },
+     * ];
+     * ```
      */
     get zoomToInitialViewpoint(): Command<Maps | void>;
     /**
@@ -1073,6 +1387,20 @@ export declare class MapCommands extends CommandRegistry {
      * 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",
+     *         },
+     *     },
+     * ];
+     * ```
+     *
      * @webOnly
      */
     get zoomToNextViewpoint(): Command<Maps | void>;
@@ -1082,17 +1410,71 @@ export declare class MapCommands extends CommandRegistry {
      * 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",
+     *         },
+     *     },
+     * ];
+     * ```
+     *
      * @webOnly
      */
     get zoomToPreviousViewpoint(): Command<Maps | void>;
     /**
      * 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",
+     *         },
+     *     },
+     * ];
+     * ```
      */
     get zoomToViewpoint(): Command<ZoomToViewpointArgs | ViewpointLike>;
     /**
      * 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",
+     *         },
+     *     },
+     * ];
+     * ```
+     *
      * @webOnly
      */
     get zoomToLayerExtent(): Command<ZoomToLayerArgs>;
@@ -1104,6 +1486,21 @@ export declare class MapCommands extends CommandRegistry {
      * 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",
+     *         },
+     *     },
+     * ];
+     * ```
+     *
      * @webOnly
      */
     get zoomToLayerVisibleScale(): Command<ZoomToLayerArgs>;

package/messaging/registry/tasks.d.ts

@@ -221,7 +221,7 @@ export interface QueryArgs {
     /**
      * The fields to sort the query by if the service supports sorting.
      *
-     * **Example**: Sort the results by FIELD1_NAME ascending first and then by
+     * **Example:**: Sort the results by FIELD1_NAME ascending first and then by
      * FIELD2_NAME descending.
      *
      * ```