@vertigis/viewer-spec
Version:
VertiGIS Viewer Specification
1,476 lines (1,435 loc) • 39.8 kB
Markdown
# command: layers.ensure-can-set-symbol
Description: Guard command for enabling the layers.set-symbol command. Web only.
Inputs: `SetSymbolArgs`
SetSymbolArgs properties:
```json
{
"layers": {
"description": "Layer(s) to use for the command/operation."
},
"maps": {
"description": "Map(s) to use for the command/operation."
},
"renderers": {
"anyOf": [
{
"$ref": "#/definitions/esri.rest-api.RendererJson.ClassBreaksRendererJson"
},
{
"$ref": "#/definitions/esri.rest-api.RendererJson.HeatmapRendererJson"
},
{
"$ref": "#/definitions/esri.rest-api.RendererJson.PointCloudClassBreaksRendererJson"
},
{
"$ref": "#/definitions/esri.rest-api.RendererJson.PointCloudRGBRendererJson"
},
{
"$ref": "#/definitions/esri.rest-api.RendererJson.PointCloudStretchRendererJson"
},
{
"$ref": "#/definitions/esri.rest-api.RendererJson.PointCloudUniqueValueRendererJson"
},
{
"$ref": "#/definitions/esri.rest-api.RendererJson.PredominanceRendererJson"
},
{
"$ref": "#/definitions/esri.rest-api.RendererJson.SimpleRendererJson"
},
{
"$ref": "#/definitions/esri.rest-api.RendererJson.TemporalRendererJson"
},
{
"$ref": "#/definitions/esri.rest-api.RendererJson.UniqueValueFromStyleRendererJson"
},
{
"$ref": "#/definitions/esri.rest-api.RendererJson.UniqueValueRendererJson"
},
{
"$ref": "#/definitions/esri.rest-api.RendererJson.VectorFieldRendererJson"
},
{
"$ref": "#/definitions/@arcgis.core.renderers.SimpleRenderer.SimpleRenderer"
},
{
"$ref": "#/definitions/@arcgis.core.renderers.ClassBreaksRenderer.ClassBreaksRenderer"
},
{
"$ref": "#/definitions/@arcgis.core.renderers.UniqueValueRenderer.UniqueValueRenderer"
},
{
"$ref": "#/definitions/@arcgis.core.renderers.DotDensityRenderer.DotDensityRenderer"
},
{
"$ref": "#/definitions/@arcgis.core.renderers.DictionaryRenderer.DictionaryRenderer"
},
{
"$ref": "#/definitions/@arcgis.core.renderers.PieChartRenderer.PieChartRenderer"
},
{
"$ref": "#/definitions/@arcgis.core.renderers.HeatmapRenderer.HeatmapRenderer"
},
{
"items": {
"$ref": "#/definitions/RendererLike"
},
"type": "array"
}
],
"description": "The renderers to use for the command/operation."
},
"symbols": {
"anyOf": [
{
"$ref": "#/definitions/@arcgis.core.symbols.PictureFillSymbol.PictureFillSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.PictureMarkerSymbol.PictureMarkerSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.SimpleFillSymbol.SimpleFillSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.SimpleLineSymbol.SimpleLineSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.SimpleMarkerSymbol.SimpleMarkerSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.TextSymbol.TextSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.CIMSymbol.CIMSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.LineSymbol3D.LineSymbol3D"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.PointSymbol3D.PointSymbol3D"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.PolygonSymbol3D.PolygonSymbol3D"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.CIMSymbolReferenceJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.PictureFillSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.PictureMarkerSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleFillSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleLineSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleMarkerSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.TextSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.LineSymbol3DJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.PointSymbol3DJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.PolygonSymbol3DJson"
},
{
"items": {
"$ref": "SymbolLike"
},
"type": "array"
}
],
"description": "The symbols to use for the command/operation."
}
}
```
---
# command: layers.hide-labels
Description: Turns off the layer's labels on the map. Web only.
Inputs: `SetLabelVisibilityArgs`
SetLabelVisibilityArgs properties:
```json
{
"layers": {
"description": "Layer(s) to use for the command/operation."
},
"maps": {
"description": "Map(s) to use for the command/operation."
}
}
```
---
# command: layers.reset-definition-expression
Description: Resets the definition expression of a layer to its initial state. If the `layer` argument is undefined or an empty array, all layers will be reset. Web only.
Inputs: `LayerSettingsArgs`
LayerSettingsArgs properties:
```json
{
"definitionExpression": {
"description": "The definitionExpression of the layer.",
"type": "string"
},
"labelingInfo": {
"anyOf": [
{
"items": {
"$ref": "#/definitions/esri.rest-api.DrawingInfoJson.LabelingInfoJson"
},
"type": "array"
},
{
"items": {
"items": {
"$ref": "#/definitions/esri.rest-api.DrawingInfoJson.LabelingInfoJson"
},
"type": "array"
},
"type": "array"
}
],
"description": "The labeling class of the layer."
},
"layers": {
"description": "Layer(s) to use for the command/operation."
},
"maps": {
"description": "Map(s) to use for the command/operation."
},
"popupTemplate": {
"anyOf": [
{
"$ref": "#/definitions/esri.rest-api.PopupInfoJson.PopupInfoJson"
},
{
"items": {
"$ref": "#/definitions/esri.rest-api.PopupInfoJson.PopupInfoJson"
},
"type": "array"
}
],
"description": "Configuration for a popup template to be used by features in the layer."
},
"symbols": {
"anyOf": [
{
"$ref": "#/definitions/@arcgis.core.symbols.PictureFillSymbol.PictureFillSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.PictureMarkerSymbol.PictureMarkerSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.SimpleFillSymbol.SimpleFillSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.SimpleLineSymbol.SimpleLineSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.SimpleMarkerSymbol.SimpleMarkerSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.TextSymbol.TextSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.CIMSymbol.CIMSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.LineSymbol3D.LineSymbol3D"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.PointSymbol3D.PointSymbol3D"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.PolygonSymbol3D.PolygonSymbol3D"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.CIMSymbolReferenceJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.PictureFillSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.PictureMarkerSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleFillSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleLineSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleMarkerSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.TextSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.LineSymbol3DJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.PointSymbol3DJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.PolygonSymbol3DJson"
},
{
"items": {
"$ref": "SymbolLike"
},
"type": "array"
}
],
"description": "The symbols to use for the command/operation."
},
"taskSettings": {
"anyOf": [
{
"$ref": "#/definitions/@vertigis.arcgis-extensions.data.TaskSettings.TaskSettingsProperties"
},
{
"items": {
"$ref": "#/definitions/@vertigis.arcgis-extensions.data.TaskSettings.TaskSettingsProperties"
},
"type": "array"
}
],
"description": "Settings relevant to layer tasks."
},
"title": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
],
"description": "The title of the layer."
}
}
```
---
# command: layers.reset-symbol
Description: Resets the symbol of a layer to its initial state. If the `layer` argument is undefined or an empty array, all layers will be reset. Web only.
Inputs: `LayerSettingsArgs`
LayerSettingsArgs properties:
```json
{
"definitionExpression": {
"description": "The definitionExpression of the layer.",
"type": "string"
},
"labelingInfo": {
"anyOf": [
{
"items": {
"$ref": "#/definitions/esri.rest-api.DrawingInfoJson.LabelingInfoJson"
},
"type": "array"
},
{
"items": {
"items": {
"$ref": "#/definitions/esri.rest-api.DrawingInfoJson.LabelingInfoJson"
},
"type": "array"
},
"type": "array"
}
],
"description": "The labeling class of the layer."
},
"layers": {
"description": "Layer(s) to use for the command/operation."
},
"maps": {
"description": "Map(s) to use for the command/operation."
},
"popupTemplate": {
"anyOf": [
{
"$ref": "#/definitions/esri.rest-api.PopupInfoJson.PopupInfoJson"
},
{
"items": {
"$ref": "#/definitions/esri.rest-api.PopupInfoJson.PopupInfoJson"
},
"type": "array"
}
],
"description": "Configuration for a popup template to be used by features in the layer."
},
"symbols": {
"anyOf": [
{
"$ref": "#/definitions/@arcgis.core.symbols.PictureFillSymbol.PictureFillSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.PictureMarkerSymbol.PictureMarkerSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.SimpleFillSymbol.SimpleFillSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.SimpleLineSymbol.SimpleLineSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.SimpleMarkerSymbol.SimpleMarkerSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.TextSymbol.TextSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.CIMSymbol.CIMSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.LineSymbol3D.LineSymbol3D"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.PointSymbol3D.PointSymbol3D"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.PolygonSymbol3D.PolygonSymbol3D"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.CIMSymbolReferenceJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.PictureFillSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.PictureMarkerSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleFillSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleLineSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleMarkerSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.TextSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.LineSymbol3DJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.PointSymbol3DJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.PolygonSymbol3DJson"
},
{
"items": {
"$ref": "SymbolLike"
},
"type": "array"
}
],
"description": "The symbols to use for the command/operation."
},
"taskSettings": {
"anyOf": [
{
"$ref": "#/definitions/@vertigis.arcgis-extensions.data.TaskSettings.TaskSettingsProperties"
},
{
"items": {
"$ref": "#/definitions/@vertigis.arcgis-extensions.data.TaskSettings.TaskSettingsProperties"
},
"type": "array"
}
],
"description": "Settings relevant to layer tasks."
},
"title": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
],
"description": "The title of the layer."
}
}
```
---
# command: layers.set-definition-expression
Description: Sets a definition expression on a layer to filter its features. Web only.
Inputs: `LayerSettingsArgs`
LayerSettingsArgs properties:
```json
{
"definitionExpression": {
"description": "The definitionExpression of the layer.",
"type": "string"
},
"labelingInfo": {
"anyOf": [
{
"items": {
"$ref": "#/definitions/esri.rest-api.DrawingInfoJson.LabelingInfoJson"
},
"type": "array"
},
{
"items": {
"items": {
"$ref": "#/definitions/esri.rest-api.DrawingInfoJson.LabelingInfoJson"
},
"type": "array"
},
"type": "array"
}
],
"description": "The labeling class of the layer."
},
"layers": {
"description": "Layer(s) to use for the command/operation."
},
"maps": {
"description": "Map(s) to use for the command/operation."
},
"popupTemplate": {
"anyOf": [
{
"$ref": "#/definitions/esri.rest-api.PopupInfoJson.PopupInfoJson"
},
{
"items": {
"$ref": "#/definitions/esri.rest-api.PopupInfoJson.PopupInfoJson"
},
"type": "array"
}
],
"description": "Configuration for a popup template to be used by features in the layer."
},
"symbols": {
"anyOf": [
{
"$ref": "#/definitions/@arcgis.core.symbols.PictureFillSymbol.PictureFillSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.PictureMarkerSymbol.PictureMarkerSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.SimpleFillSymbol.SimpleFillSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.SimpleLineSymbol.SimpleLineSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.SimpleMarkerSymbol.SimpleMarkerSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.TextSymbol.TextSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.CIMSymbol.CIMSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.LineSymbol3D.LineSymbol3D"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.PointSymbol3D.PointSymbol3D"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.PolygonSymbol3D.PolygonSymbol3D"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.CIMSymbolReferenceJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.PictureFillSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.PictureMarkerSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleFillSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleLineSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleMarkerSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.TextSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.LineSymbol3DJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.PointSymbol3DJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.PolygonSymbol3DJson"
},
{
"items": {
"$ref": "SymbolLike"
},
"type": "array"
}
],
"description": "The symbols to use for the command/operation."
},
"taskSettings": {
"anyOf": [
{
"$ref": "#/definitions/@vertigis.arcgis-extensions.data.TaskSettings.TaskSettingsProperties"
},
{
"items": {
"$ref": "#/definitions/@vertigis.arcgis-extensions.data.TaskSettings.TaskSettingsProperties"
},
"type": "array"
}
],
"description": "Settings relevant to layer tasks."
},
"title": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
],
"description": "The title of the layer."
}
}
```
---
# command: layers.set-label-classes
Description: Updates the label classes of the provided layer(s). Web only.
Inputs: `LayerSettingsArgs`
LayerSettingsArgs properties:
```json
{
"definitionExpression": {
"description": "The definitionExpression of the layer.",
"type": "string"
},
"labelingInfo": {
"anyOf": [
{
"items": {
"$ref": "#/definitions/esri.rest-api.DrawingInfoJson.LabelingInfoJson"
},
"type": "array"
},
{
"items": {
"items": {
"$ref": "#/definitions/esri.rest-api.DrawingInfoJson.LabelingInfoJson"
},
"type": "array"
},
"type": "array"
}
],
"description": "The labeling class of the layer."
},
"layers": {
"description": "Layer(s) to use for the command/operation."
},
"maps": {
"description": "Map(s) to use for the command/operation."
},
"popupTemplate": {
"anyOf": [
{
"$ref": "#/definitions/esri.rest-api.PopupInfoJson.PopupInfoJson"
},
{
"items": {
"$ref": "#/definitions/esri.rest-api.PopupInfoJson.PopupInfoJson"
},
"type": "array"
}
],
"description": "Configuration for a popup template to be used by features in the layer."
},
"symbols": {
"anyOf": [
{
"$ref": "#/definitions/@arcgis.core.symbols.PictureFillSymbol.PictureFillSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.PictureMarkerSymbol.PictureMarkerSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.SimpleFillSymbol.SimpleFillSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.SimpleLineSymbol.SimpleLineSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.SimpleMarkerSymbol.SimpleMarkerSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.TextSymbol.TextSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.CIMSymbol.CIMSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.LineSymbol3D.LineSymbol3D"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.PointSymbol3D.PointSymbol3D"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.PolygonSymbol3D.PolygonSymbol3D"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.CIMSymbolReferenceJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.PictureFillSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.PictureMarkerSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleFillSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleLineSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleMarkerSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.TextSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.LineSymbol3DJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.PointSymbol3DJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.PolygonSymbol3DJson"
},
{
"items": {
"$ref": "SymbolLike"
},
"type": "array"
}
],
"description": "The symbols to use for the command/operation."
},
"taskSettings": {
"anyOf": [
{
"$ref": "#/definitions/@vertigis.arcgis-extensions.data.TaskSettings.TaskSettingsProperties"
},
{
"items": {
"$ref": "#/definitions/@vertigis.arcgis-extensions.data.TaskSettings.TaskSettingsProperties"
},
"type": "array"
}
],
"description": "Settings relevant to layer tasks."
},
"title": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
],
"description": "The title of the layer."
}
}
```
---
# command: layers.set-popup-template
Description: Updates the provided layer(s) with new popup template configuration. Web only.
Inputs: `LayerSettingsArgs`
LayerSettingsArgs properties:
```json
{
"definitionExpression": {
"description": "The definitionExpression of the layer.",
"type": "string"
},
"labelingInfo": {
"anyOf": [
{
"items": {
"$ref": "#/definitions/esri.rest-api.DrawingInfoJson.LabelingInfoJson"
},
"type": "array"
},
{
"items": {
"items": {
"$ref": "#/definitions/esri.rest-api.DrawingInfoJson.LabelingInfoJson"
},
"type": "array"
},
"type": "array"
}
],
"description": "The labeling class of the layer."
},
"layers": {
"description": "Layer(s) to use for the command/operation."
},
"maps": {
"description": "Map(s) to use for the command/operation."
},
"popupTemplate": {
"anyOf": [
{
"$ref": "#/definitions/esri.rest-api.PopupInfoJson.PopupInfoJson"
},
{
"items": {
"$ref": "#/definitions/esri.rest-api.PopupInfoJson.PopupInfoJson"
},
"type": "array"
}
],
"description": "Configuration for a popup template to be used by features in the layer."
},
"symbols": {
"anyOf": [
{
"$ref": "#/definitions/@arcgis.core.symbols.PictureFillSymbol.PictureFillSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.PictureMarkerSymbol.PictureMarkerSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.SimpleFillSymbol.SimpleFillSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.SimpleLineSymbol.SimpleLineSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.SimpleMarkerSymbol.SimpleMarkerSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.TextSymbol.TextSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.CIMSymbol.CIMSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.LineSymbol3D.LineSymbol3D"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.PointSymbol3D.PointSymbol3D"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.PolygonSymbol3D.PolygonSymbol3D"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.CIMSymbolReferenceJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.PictureFillSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.PictureMarkerSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleFillSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleLineSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleMarkerSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.TextSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.LineSymbol3DJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.PointSymbol3DJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.PolygonSymbol3DJson"
},
{
"items": {
"$ref": "SymbolLike"
},
"type": "array"
}
],
"description": "The symbols to use for the command/operation."
},
"taskSettings": {
"anyOf": [
{
"$ref": "#/definitions/@vertigis.arcgis-extensions.data.TaskSettings.TaskSettingsProperties"
},
{
"items": {
"$ref": "#/definitions/@vertigis.arcgis-extensions.data.TaskSettings.TaskSettingsProperties"
},
"type": "array"
}
],
"description": "Settings relevant to layer tasks."
},
"title": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
],
"description": "The title of the layer."
}
}
```
---
# command: layers.set-symbol
Description: Updates the symbol for the provided layer(s). Web only.
Inputs: `SetSymbolArgs`
SetSymbolArgs properties:
```json
{
"layers": {
"description": "Layer(s) to use for the command/operation."
},
"maps": {
"description": "Map(s) to use for the command/operation."
},
"renderers": {
"anyOf": [
{
"$ref": "#/definitions/esri.rest-api.RendererJson.ClassBreaksRendererJson"
},
{
"$ref": "#/definitions/esri.rest-api.RendererJson.HeatmapRendererJson"
},
{
"$ref": "#/definitions/esri.rest-api.RendererJson.PointCloudClassBreaksRendererJson"
},
{
"$ref": "#/definitions/esri.rest-api.RendererJson.PointCloudRGBRendererJson"
},
{
"$ref": "#/definitions/esri.rest-api.RendererJson.PointCloudStretchRendererJson"
},
{
"$ref": "#/definitions/esri.rest-api.RendererJson.PointCloudUniqueValueRendererJson"
},
{
"$ref": "#/definitions/esri.rest-api.RendererJson.PredominanceRendererJson"
},
{
"$ref": "#/definitions/esri.rest-api.RendererJson.SimpleRendererJson"
},
{
"$ref": "#/definitions/esri.rest-api.RendererJson.TemporalRendererJson"
},
{
"$ref": "#/definitions/esri.rest-api.RendererJson.UniqueValueFromStyleRendererJson"
},
{
"$ref": "#/definitions/esri.rest-api.RendererJson.UniqueValueRendererJson"
},
{
"$ref": "#/definitions/esri.rest-api.RendererJson.VectorFieldRendererJson"
},
{
"$ref": "#/definitions/@arcgis.core.renderers.SimpleRenderer.SimpleRenderer"
},
{
"$ref": "#/definitions/@arcgis.core.renderers.ClassBreaksRenderer.ClassBreaksRenderer"
},
{
"$ref": "#/definitions/@arcgis.core.renderers.UniqueValueRenderer.UniqueValueRenderer"
},
{
"$ref": "#/definitions/@arcgis.core.renderers.DotDensityRenderer.DotDensityRenderer"
},
{
"$ref": "#/definitions/@arcgis.core.renderers.DictionaryRenderer.DictionaryRenderer"
},
{
"$ref": "#/definitions/@arcgis.core.renderers.PieChartRenderer.PieChartRenderer"
},
{
"$ref": "#/definitions/@arcgis.core.renderers.HeatmapRenderer.HeatmapRenderer"
},
{
"items": {
"$ref": "#/definitions/RendererLike"
},
"type": "array"
}
],
"description": "The renderers to use for the command/operation."
},
"symbols": {
"anyOf": [
{
"$ref": "#/definitions/@arcgis.core.symbols.PictureFillSymbol.PictureFillSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.PictureMarkerSymbol.PictureMarkerSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.SimpleFillSymbol.SimpleFillSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.SimpleLineSymbol.SimpleLineSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.SimpleMarkerSymbol.SimpleMarkerSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.TextSymbol.TextSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.CIMSymbol.CIMSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.LineSymbol3D.LineSymbol3D"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.PointSymbol3D.PointSymbol3D"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.PolygonSymbol3D.PolygonSymbol3D"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.CIMSymbolReferenceJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.PictureFillSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.PictureMarkerSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleFillSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleLineSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleMarkerSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.TextSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.LineSymbol3DJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.PointSymbol3DJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.PolygonSymbol3DJson"
},
{
"items": {
"$ref": "SymbolLike"
},
"type": "array"
}
],
"description": "The symbols to use for the command/operation."
}
}
```
---
# command: layers.set-task-settings
Description: Updates the provided layer(s) with new task settings. Web only.
Inputs: `LayerSettingsArgs`
LayerSettingsArgs properties:
```json
{
"definitionExpression": {
"description": "The definitionExpression of the layer.",
"type": "string"
},
"labelingInfo": {
"anyOf": [
{
"items": {
"$ref": "#/definitions/esri.rest-api.DrawingInfoJson.LabelingInfoJson"
},
"type": "array"
},
{
"items": {
"items": {
"$ref": "#/definitions/esri.rest-api.DrawingInfoJson.LabelingInfoJson"
},
"type": "array"
},
"type": "array"
}
],
"description": "The labeling class of the layer."
},
"layers": {
"description": "Layer(s) to use for the command/operation."
},
"maps": {
"description": "Map(s) to use for the command/operation."
},
"popupTemplate": {
"anyOf": [
{
"$ref": "#/definitions/esri.rest-api.PopupInfoJson.PopupInfoJson"
},
{
"items": {
"$ref": "#/definitions/esri.rest-api.PopupInfoJson.PopupInfoJson"
},
"type": "array"
}
],
"description": "Configuration for a popup template to be used by features in the layer."
},
"symbols": {
"anyOf": [
{
"$ref": "#/definitions/@arcgis.core.symbols.PictureFillSymbol.PictureFillSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.PictureMarkerSymbol.PictureMarkerSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.SimpleFillSymbol.SimpleFillSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.SimpleLineSymbol.SimpleLineSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.SimpleMarkerSymbol.SimpleMarkerSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.TextSymbol.TextSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.CIMSymbol.CIMSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.LineSymbol3D.LineSymbol3D"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.PointSymbol3D.PointSymbol3D"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.PolygonSymbol3D.PolygonSymbol3D"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.CIMSymbolReferenceJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.PictureFillSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.PictureMarkerSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleFillSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleLineSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleMarkerSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.TextSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.LineSymbol3DJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.PointSymbol3DJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.PolygonSymbol3DJson"
},
{
"items": {
"$ref": "SymbolLike"
},
"type": "array"
}
],
"description": "The symbols to use for the command/operation."
},
"taskSettings": {
"anyOf": [
{
"$ref": "#/definitions/@vertigis.arcgis-extensions.data.TaskSettings.TaskSettingsProperties"
},
{
"items": {
"$ref": "#/definitions/@vertigis.arcgis-extensions.data.TaskSettings.TaskSettingsProperties"
},
"type": "array"
}
],
"description": "Settings relevant to layer tasks."
},
"title": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
],
"description": "The title of the layer."
}
}
```
---
# command: layers.set-title
Description: Changes the title of the provided layer(s). Web only.
Inputs: `LayerSettingsArgs`
LayerSettingsArgs properties:
```json
{
"definitionExpression": {
"description": "The definitionExpression of the layer.",
"type": "string"
},
"labelingInfo": {
"anyOf": [
{
"items": {
"$ref": "#/definitions/esri.rest-api.DrawingInfoJson.LabelingInfoJson"
},
"type": "array"
},
{
"items": {
"items": {
"$ref": "#/definitions/esri.rest-api.DrawingInfoJson.LabelingInfoJson"
},
"type": "array"
},
"type": "array"
}
],
"description": "The labeling class of the layer."
},
"layers": {
"description": "Layer(s) to use for the command/operation."
},
"maps": {
"description": "Map(s) to use for the command/operation."
},
"popupTemplate": {
"anyOf": [
{
"$ref": "#/definitions/esri.rest-api.PopupInfoJson.PopupInfoJson"
},
{
"items": {
"$ref": "#/definitions/esri.rest-api.PopupInfoJson.PopupInfoJson"
},
"type": "array"
}
],
"description": "Configuration for a popup template to be used by features in the layer."
},
"symbols": {
"anyOf": [
{
"$ref": "#/definitions/@arcgis.core.symbols.PictureFillSymbol.PictureFillSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.PictureMarkerSymbol.PictureMarkerSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.SimpleFillSymbol.SimpleFillSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.SimpleLineSymbol.SimpleLineSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.SimpleMarkerSymbol.SimpleMarkerSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.TextSymbol.TextSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.CIMSymbol.CIMSymbol"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.LineSymbol3D.LineSymbol3D"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.PointSymbol3D.PointSymbol3D"
},
{
"$ref": "#/definitions/@arcgis.core.symbols.PolygonSymbol3D.PolygonSymbol3D"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.CIMSymbolReferenceJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.PictureFillSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.PictureMarkerSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleFillSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleLineSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleMarkerSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.TextSymbolJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.LineSymbol3DJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.PointSymbol3DJson"
},
{
"$ref": "#/definitions/esri.rest-api.SymbolJson.PolygonSymbol3DJson"
},
{
"items": {
"$ref": "SymbolLike"
},
"type": "array"
}
],
"description": "The symbols to use for the command/operation."
},
"taskSettings": {
"anyOf": [
{
"$ref": "#/definitions/@vertigis.arcgis-extensions.data.TaskSettings.TaskSettingsProperties"
},
{
"items": {
"$ref": "#/definitions/@vertigis.arcgis-extensions.data.TaskSettings.TaskSettingsProperties"
},
"type": "array"
}
],
"description": "Settings relevant to layer tasks."
},
"title": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
],
"description": "The title of the layer."
}
}
```
---
# command: layers.set-visibility
Description: Updates the visibility of the provided layer(s). Web only.
**Example:** Toggle a layer's visibility off by id.
```
{
"layers": "Victoria_Fire_Hydrants_8780",
"visible": false
}
```
**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:
```json
{
"layers": {
"description": "Layer(s) to use for the command/operation."
},
"maps": {
"description": "Map(s) to use for the command/operation."
},
"visible": {
"description": "The visibility of the provided layers. If arg is not provided, visibility will be toggled.",
"type": "boolean"
}
}
```
---
# command: layers.show-labels
Description: Turns on the layer's labels on the map. Web only.
Inputs: `SetLabelVisibilityArgs`
SetLabelVisibilityArgs properties:
```json
{
"layers": {
"description": "Layer(s) to use for the command/operation."
},
"maps": {
"description": "Map(s) to use for the command/operation."
}
}
```
---