@vertigis/viewer-spec 56.32.0 → 56.33.0

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

@@ -544,6 +544,10 @@
                 "title": {
                     "description": "The layer's title.",
                     "type": "string"
+                },
+                "url": {
+                    "description": "The layer's url.",
+                    "type": "string"
                 }
             },
             "type": "object"
@@ -2588,6 +2592,9 @@
                 {
                     "$ref": "#/definitions/esri.rest-api.WebTileLayerJson.WebTileLayerJson"
                 },
+                {
+                    "$ref": "#/definitions/esri.rest-api.WFSLayerJson.WFSLayerJson"
+                },
                 {
                     "$ref": "#/definitions/esri.rest-api.WMSLayerJson.WMSLayerJson"
                 }
@@ -3009,7 +3016,25 @@
                 },
                 {
                     "additionalProperties": false,
-                    "properties": {}
+                    "properties": {
+                        "activate": {
+                            "description": "Whether to activate the component showing the results of the operation. False by default.",
+                            "type": "boolean"
+                        },
+                        "features": {
+                            "$ref": "#/definitions/FeaturesLike",
+                            "description": "Features to use for the command/operation."
+                        },
+                        "results": {
+                            "$ref": "#/definitions/ModelRef",
+                            "description": "The result component to update, referenced by results model or its ID. Web only."
+                        },
+                        "resultsSetId": {
+                            "description": "If specified the results will be updated in the named results set only. Results sets with the prefix 'vgs' are reserved for system use and should not be used unless you are intentionally targeting a well known results set such as the 'vgs-starred' results. Web only.",
+                            "type": "string"
+                        }
+                    },
+                    "type": "object"
                 }
             ],
             "description": "Arguments for various commands that manipulate the current set of shown results."
@@ -4581,6 +4606,10 @@
                     "description": "A unique identifying string for the layer.",
                     "type": "string"
                 },
+                "itemId": {
+                    "description": "Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.",
+                    "type": "string"
+                },
                 "layerDefinition": {
                     "$ref": "#/definitions/esri.rest-api.LayerDefinitionJson.LayerDefinitionJson",
                     "description": "A layerDefinition object defining the attribute schema and drawing information for the layer."
@@ -11150,9 +11179,6 @@
                     "type": "number"
                 }
             },
-            "required": [
-                "color"
-            ],
             "type": "object"
         },
         "esri.rest-api.SymbolJson.CIMSymbolJson": {
@@ -11197,8 +11223,6 @@
                 }
             },
             "required": [
-                "color",
-                "size",
                 "type"
             ],
             "type": "object"
@@ -11486,9 +11510,6 @@
                     "type": "number"
                 }
             },
-            "required": [
-                "color"
-            ],
             "type": "object"
         },
         "esri.rest-api.SymbolJson.MeshSymbol3DJson": {
@@ -11520,8 +11541,26 @@
             "properties": {
                 "anchor": {
                     "description": "The positioning of the object relative to the geometry. Must be one of the following values: center, bottom, origin.",
+                    "enum": [
+                        "bottom",
+                        "center",
+                        "origin",
+                        "relative",
+                        "top"
+                    ],
                     "type": "string"
                 },
+                "anchorPosition": {
+                    "description": "When anchor equals \"relative\", this property specifies the positioning of the object relative to the geometry as a fraction of the symbol layer's bounding box. Otherwise it is ignored.",
+                    "items": {
+                        "type": "number"
+                    },
+                    "type": "array"
+                },
+                "castShadows": {
+                    "description": "Boolean to control the shadow casting behavior of the rendered geometries.",
+                    "type": "boolean"
+                },
                 "depth": {
                     "description": "Object depth in meters, positive only.",
                     "type": "number"
@@ -11582,10 +11621,6 @@
                     "type": "number"
                 }
             },
-            "required": [
-                "color",
-                "size"
-            ],
             "type": "object"
         },
         "esri.rest-api.SymbolJson.PathSymbol3DLayerJson": {
@@ -12788,6 +12823,189 @@
             },
             "type": "object"
         },
+        "esri.rest-api.WFSLayerJson.WFSInfoJson": {
+            "additionalProperties": false,
+            "description": "Object that defines and provides information about layers in a WFS service. See {@link https://developers.arcgis.com/web-map-specification/objects/wfsInfo/}.",
+            "properties": {
+                "customParameters": {
+                    "description": "A sequence of parameters used to append custom parameters to all WFS requests. These parameters are applied to GetCapabilities, DescribeFeatureType, and GetFeatures."
+                },
+                "featureUrl": {
+                    "description": "URL of the WFS service operation.",
+                    "type": "string"
+                },
+                "maxFeatures": {
+                    "description": "Set this to limit the number of requested features that a GetFeature request presents.",
+                    "type": "number"
+                },
+                "name": {
+                    "description": "The name of the WFS layer. This is used to set layer visibility.",
+                    "type": "string"
+                },
+                "supportedSpatialReferences": {
+                    "description": "List of supported spatial reference IDs.",
+                    "items": {
+                        "type": "number"
+                    },
+                    "type": "array"
+                },
+                "swapXY": {
+                    "description": "Boolean value indicating whether X and Y axis are flipped.",
+                    "type": "boolean"
+                },
+                "version": {
+                    "description": "Value indicating which version of the WFS specification is used.",
+                    "type": "string"
+                },
+                "wfsNamespace": {
+                    "description": "String indicating namespace.",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
+        "esri.rest-api.WFSLayerJson.WFSLayerJson": {
+            "additionalProperties": false,
+            "description": "OGC Web Feature Service (WFS) is a dynamic feature service that follows the specifications of OGC. See {@link https://developers.arcgis.com/web-map-specification/objects/wfsLayer/} and {@link https://developers.arcgis.com/web-scene-specification/objects/wfsLayer/}.",
+            "properties": {
+                "blendMode": {
+                    "description": "Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer.",
+                    "enum": [
+                        "average",
+                        "color",
+                        "color-burn",
+                        "color-dodge",
+                        "darken",
+                        "destination-atop",
+                        "destination-in",
+                        "destination-out",
+                        "destination-over",
+                        "difference",
+                        "exclusion",
+                        "hard-light",
+                        "hue",
+                        "invert",
+                        "lighten",
+                        "lighter",
+                        "luminosity",
+                        "minus",
+                        "multiply",
+                        "normal",
+                        "overlay",
+                        "plus",
+                        "reflect",
+                        "saturation",
+                        "screen",
+                        "soft-light",
+                        "source-atop",
+                        "source-in",
+                        "source-out",
+                        "vivid-light",
+                        "xor"
+                    ],
+                    "type": "string"
+                },
+                "disablePopup": {
+                    "description": "Indicates whether to allow a client to ignore popups defined by the service item.",
+                    "type": "boolean"
+                },
+                "effect": {
+                    "$ref": "#/definitions/esri.rest-api.LayerJson.EffectJson",
+                    "description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
+                },
+                "id": {
+                    "description": "A unique identifying string for the layer.",
+                    "type": "string"
+                },
+                "itemId": {
+                    "description": "Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.",
+                    "type": "string"
+                },
+                "layerDefinition": {
+                    "$ref": "#/definitions/esri.rest-api.LayerDefinitionJson.LayerDefinitionJson",
+                    "description": "A layerDefinition object defining the attribute schema and drawing information for the layer."
+                },
+                "layerType": {
+                    "const": "WFS",
+                    "description": "The type of layer.",
+                    "type": "string"
+                },
+                "listMode": {
+                    "$ref": "esri.ListMode",
+                    "description": "Indicates how the layer should display in the table of contents. The known values are listed below. See {@link support /esri!ListMode}."
+                },
+                "maxScale": {
+                    "description": "A number representing the maximum scale at which the layer will be visible. The number is the scale's denominator; thus, a value of 2400 represents a scale of 1/2,400. A value of 0 indicates that the layer will be visible no matter how far you zoom in.",
+                    "type": "number"
+                },
+                "minScale": {
+                    "description": "A number representing the minimum scale at which the layer will be visible. The number is the scale's denominator; thus, a value of 2400 represents a scale of 1/2,400.",
+                    "type": "number"
+                },
+                "mode": {
+                    "description": "Number where 0 means 'snapshot' and 1 means 'ondemand'.",
+                    "enum": [
+                        0,
+                        1
+                    ],
+                    "type": "number"
+                },
+                "opacity": {
+                    "description": "The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency.",
+                    "type": "number"
+                },
+                "popupInfo": {
+                    "$ref": "#/definitions/esri.rest-api.PopupInfoJson.PopupInfoJson",
+                    "description": "A PopupInfo object defining the content of pop-up windows when you click or query a feature."
+                },
+                "refreshInterval": {
+                    "description": "When the refresh interval is set on a layer, the client must refresh that layer only, not the entire web map. The default value is '0', meaning the no refresh. You can enable a refresh interval on the following types of layers: ArcGIS Server web service, hosted feature layer, hosted tile layer, OGC WMS, OGS WMTS, tile layer, GeoRSS, Living Atlas layers, basemaps (including Bing Maps basemaps), CSV from the web with latitude and longitude fields, and KML when added to ArcGIS Online through the My Content page. See {@link https://doc.arcgis.com/en/arcgis-online/create-maps/set-refresh-interval.htm}.",
+                    "type": "number"
+                },
+                "showLabels": {
+                    "description": "Indicates whether to display labels for this layer. If true, labels will appear as defined in the labelingInfo property.",
+                    "type": "boolean"
+                },
+                "showLegend": {
+                    "description": "Indicates whether to allow map authors the ability to control what layers should be shown in a client's legend.",
+                    "type": "boolean"
+                },
+                "title": {
+                    "description": "A user-friendly title for the layer that can be used in a table of contents. If this is not included, then a title is derived from the service.",
+                    "type": "string"
+                },
+                "type": {
+                    "description": "(Deprecated, use layerType instead.) If the layer is referenced through a URL, but is not an ArcGIS web service, then this parameter can be supplied to denote the layer type.",
+                    "enum": [
+                        "BingMapsAerial",
+                        "BingMapsHybrid",
+                        "BingMapsRoad",
+                        "CSV",
+                        "KML",
+                        "OpenStreetMap",
+                        "WMS",
+                        "WebTiledLayer"
+                    ],
+                    "type": "string"
+                },
+                "url": {
+                    "description": "The URL to the layer. If the layer is not from a web service but rather a feature collection, than the url property is omitted.",
+                    "type": "string"
+                },
+                "visibility": {
+                    "description": "Determines whether the layer is initially visible in the web map.",
+                    "type": "boolean"
+                },
+                "wfsInfo": {
+                    "$ref": "#/definitions/esri.rest-api.WFSLayerJson.WFSInfoJson",
+                    "description": "Object that defines and provides information about layers in a WFS service."
+                }
+            },
+            "required": [
+                "layerType"
+            ],
+            "type": "object"
+        },
         "esri.rest-api.WMSLayerJson.WMSLayerJson": {
             "additionalProperties": false,
             "description": "A layer consuming a Web Map Service (WMS). The WMS specification is an international specification for serving and consuming dynamic maps on the web. For additional information on publishing WMS services, please see the ArcGIS Server help. See {@link https://developers.arcgis.com/web-map-specification/objects/wmsLayer/}.",

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

@@ -274,6 +274,9 @@
                 {
                     "$ref": "#/definitions/esri.rest-api.WebTileLayerJson.WebTileLayerJson"
                 },
+                {
+                    "$ref": "#/definitions/esri.rest-api.WFSLayerJson.WFSLayerJson"
+                },
                 {
                     "$ref": "#/definitions/esri.rest-api.WMSLayerJson.WMSLayerJson"
                 }
@@ -1114,6 +1117,10 @@
                     "description": "A unique identifying string for the layer.",
                     "type": "string"
                 },
+                "itemId": {
+                    "description": "Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.",
+                    "type": "string"
+                },
                 "layerDefinition": {
                     "$ref": "#/definitions/esri.rest-api.LayerDefinitionJson.LayerDefinitionJson",
                     "description": "A layerDefinition object defining the attribute schema and drawing information for the layer."
@@ -7458,9 +7465,6 @@
                     "type": "number"
                 }
             },
-            "required": [
-                "color"
-            ],
             "type": "object"
         },
         "esri.rest-api.SymbolJson.CIMSymbolJson": {
@@ -7505,8 +7509,6 @@
                 }
             },
             "required": [
-                "color",
-                "size",
                 "type"
             ],
             "type": "object"
@@ -7794,9 +7796,6 @@
                     "type": "number"
                 }
             },
-            "required": [
-                "color"
-            ],
             "type": "object"
         },
         "esri.rest-api.SymbolJson.MeshSymbol3DJson": {
@@ -7828,8 +7827,26 @@
             "properties": {
                 "anchor": {
                     "description": "The positioning of the object relative to the geometry. Must be one of the following values: center, bottom, origin.",
+                    "enum": [
+                        "bottom",
+                        "center",
+                        "origin",
+                        "relative",
+                        "top"
+                    ],
                     "type": "string"
                 },
+                "anchorPosition": {
+                    "description": "When anchor equals \"relative\", this property specifies the positioning of the object relative to the geometry as a fraction of the symbol layer's bounding box. Otherwise it is ignored.",
+                    "items": {
+                        "type": "number"
+                    },
+                    "type": "array"
+                },
+                "castShadows": {
+                    "description": "Boolean to control the shadow casting behavior of the rendered geometries.",
+                    "type": "boolean"
+                },
                 "depth": {
                     "description": "Object depth in meters, positive only.",
                     "type": "number"
@@ -7890,10 +7907,6 @@
                     "type": "number"
                 }
             },
-            "required": [
-                "color",
-                "size"
-            ],
             "type": "object"
         },
         "esri.rest-api.SymbolJson.PathSymbol3DLayerJson": {
@@ -9051,6 +9064,189 @@
             ],
             "type": "object"
         },
+        "esri.rest-api.WFSLayerJson.WFSInfoJson": {
+            "additionalProperties": false,
+            "description": "Object that defines and provides information about layers in a WFS service. See {@link https://developers.arcgis.com/web-map-specification/objects/wfsInfo/}.",
+            "properties": {
+                "customParameters": {
+                    "description": "A sequence of parameters used to append custom parameters to all WFS requests. These parameters are applied to GetCapabilities, DescribeFeatureType, and GetFeatures."
+                },
+                "featureUrl": {
+                    "description": "URL of the WFS service operation.",
+                    "type": "string"
+                },
+                "maxFeatures": {
+                    "description": "Set this to limit the number of requested features that a GetFeature request presents.",
+                    "type": "number"
+                },
+                "name": {
+                    "description": "The name of the WFS layer. This is used to set layer visibility.",
+                    "type": "string"
+                },
+                "supportedSpatialReferences": {
+                    "description": "List of supported spatial reference IDs.",
+                    "items": {
+                        "type": "number"
+                    },
+                    "type": "array"
+                },
+                "swapXY": {
+                    "description": "Boolean value indicating whether X and Y axis are flipped.",
+                    "type": "boolean"
+                },
+                "version": {
+                    "description": "Value indicating which version of the WFS specification is used.",
+                    "type": "string"
+                },
+                "wfsNamespace": {
+                    "description": "String indicating namespace.",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
+        "esri.rest-api.WFSLayerJson.WFSLayerJson": {
+            "additionalProperties": false,
+            "description": "OGC Web Feature Service (WFS) is a dynamic feature service that follows the specifications of OGC. See {@link https://developers.arcgis.com/web-map-specification/objects/wfsLayer/} and {@link https://developers.arcgis.com/web-scene-specification/objects/wfsLayer/}.",
+            "properties": {
+                "blendMode": {
+                    "description": "Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer.",
+                    "enum": [
+                        "average",
+                        "color",
+                        "color-burn",
+                        "color-dodge",
+                        "darken",
+                        "destination-atop",
+                        "destination-in",
+                        "destination-out",
+                        "destination-over",
+                        "difference",
+                        "exclusion",
+                        "hard-light",
+                        "hue",
+                        "invert",
+                        "lighten",
+                        "lighter",
+                        "luminosity",
+                        "minus",
+                        "multiply",
+                        "normal",
+                        "overlay",
+                        "plus",
+                        "reflect",
+                        "saturation",
+                        "screen",
+                        "soft-light",
+                        "source-atop",
+                        "source-in",
+                        "source-out",
+                        "vivid-light",
+                        "xor"
+                    ],
+                    "type": "string"
+                },
+                "disablePopup": {
+                    "description": "Indicates whether to allow a client to ignore popups defined by the service item.",
+                    "type": "boolean"
+                },
+                "effect": {
+                    "$ref": "#/definitions/esri.rest-api.LayerJson.EffectJson",
+                    "description": "Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work."
+                },
+                "id": {
+                    "description": "A unique identifying string for the layer.",
+                    "type": "string"
+                },
+                "itemId": {
+                    "description": "Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.",
+                    "type": "string"
+                },
+                "layerDefinition": {
+                    "$ref": "#/definitions/esri.rest-api.LayerDefinitionJson.LayerDefinitionJson",
+                    "description": "A layerDefinition object defining the attribute schema and drawing information for the layer."
+                },
+                "layerType": {
+                    "const": "WFS",
+                    "description": "The type of layer.",
+                    "type": "string"
+                },
+                "listMode": {
+                    "$ref": "esri.ListMode",
+                    "description": "Indicates how the layer should display in the table of contents. The known values are listed below. See {@link support /esri!ListMode}."
+                },
+                "maxScale": {
+                    "description": "A number representing the maximum scale at which the layer will be visible. The number is the scale's denominator; thus, a value of 2400 represents a scale of 1/2,400. A value of 0 indicates that the layer will be visible no matter how far you zoom in.",
+                    "type": "number"
+                },
+                "minScale": {
+                    "description": "A number representing the minimum scale at which the layer will be visible. The number is the scale's denominator; thus, a value of 2400 represents a scale of 1/2,400.",
+                    "type": "number"
+                },
+                "mode": {
+                    "description": "Number where 0 means 'snapshot' and 1 means 'ondemand'.",
+                    "enum": [
+                        0,
+                        1
+                    ],
+                    "type": "number"
+                },
+                "opacity": {
+                    "description": "The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency.",
+                    "type": "number"
+                },
+                "popupInfo": {
+                    "$ref": "#/definitions/esri.rest-api.PopupInfoJson.PopupInfoJson",
+                    "description": "A PopupInfo object defining the content of pop-up windows when you click or query a feature."
+                },
+                "refreshInterval": {
+                    "description": "When the refresh interval is set on a layer, the client must refresh that layer only, not the entire web map. The default value is '0', meaning the no refresh. You can enable a refresh interval on the following types of layers: ArcGIS Server web service, hosted feature layer, hosted tile layer, OGC WMS, OGS WMTS, tile layer, GeoRSS, Living Atlas layers, basemaps (including Bing Maps basemaps), CSV from the web with latitude and longitude fields, and KML when added to ArcGIS Online through the My Content page. See {@link https://doc.arcgis.com/en/arcgis-online/create-maps/set-refresh-interval.htm}.",
+                    "type": "number"
+                },
+                "showLabels": {
+                    "description": "Indicates whether to display labels for this layer. If true, labels will appear as defined in the labelingInfo property.",
+                    "type": "boolean"
+                },
+                "showLegend": {
+                    "description": "Indicates whether to allow map authors the ability to control what layers should be shown in a client's legend.",
+                    "type": "boolean"
+                },
+                "title": {
+                    "description": "A user-friendly title for the layer that can be used in a table of contents. If this is not included, then a title is derived from the service.",
+                    "type": "string"
+                },
+                "type": {
+                    "description": "(Deprecated, use layerType instead.) If the layer is referenced through a URL, but is not an ArcGIS web service, then this parameter can be supplied to denote the layer type.",
+                    "enum": [
+                        "BingMapsAerial",
+                        "BingMapsHybrid",
+                        "BingMapsRoad",
+                        "CSV",
+                        "KML",
+                        "OpenStreetMap",
+                        "WMS",
+                        "WebTiledLayer"
+                    ],
+                    "type": "string"
+                },
+                "url": {
+                    "description": "The URL to the layer. If the layer is not from a web service but rather a feature collection, than the url property is omitted.",
+                    "type": "string"
+                },
+                "visibility": {
+                    "description": "Determines whether the layer is initially visible in the web map.",
+                    "type": "boolean"
+                },
+                "wfsInfo": {
+                    "$ref": "#/definitions/esri.rest-api.WFSLayerJson.WFSInfoJson",
+                    "description": "Object that defines and provides information about layers in a WFS service."
+                }
+            },
+            "required": [
+                "layerType"
+            ],
+            "type": "object"
+        },
         "esri.rest-api.WMSLayerJson.WMSLayerJson": {
             "additionalProperties": false,
             "description": "A layer consuming a Web Map Service (WMS). The WMS specification is an international specification for serving and consuming dynamic maps on the web. For additional information on publishing WMS services, please see the ArcGIS Server help. See {@link https://developers.arcgis.com/web-map-specification/objects/wmsLayer/}.",