@vertigis/viewer-spec
Version:
VertiGIS Viewer Specification
272 lines (255 loc) • 6.67 kB
Markdown
# command: location-marker.clear
Description: Removes all Markers. Web only.
Inputs: `( Model | .arcgis-extensions.mapping.MapExtension.MapExtension | .arcgis-extensions.mapping.MapExtension.MapExtension[] | HasMapsRef | ModelRef[] | string )`
Model properties:
```json
{
"id": {
"description": "The unique ID for this entity.",
"type": "string",
"isRequired": "true"
},
"itemType": {
"description": "The item type for this entity when it participates in an App.",
"type": "string",
"isRequired": "true"
}
}
```
HasMapsRef properties:
```json
{
"maps": {
"description": "The map(s) to use for the command/operation."
}
}
```
---
# command: location-marker.create
Description: Create a new Marker. Web only.
**Example:** Create a user draggable location marker with a heading and fov.
_Note:_ The geometry here must be a Geometry object rather than a JSON representation. You can use the Workflow task 'Get Geometry From JSON' or be passed one from another step in the command chain.
```
{
"color": [24, 128, 255, 255],
"fov": 120,
"heading": 60,
"id": "custom-marker-1",
"symbol": "dot",
"userDraggable": true
}
```
Inputs: `CreateLocationMarkerArgs`
CreateLocationMarkerArgs properties:
```json
{
"color": {
"anyOf": [
{
"$ref": "#/definitions/@arcgis.core.Color.Color"
},
{
"items": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"maxItems": 4,
"minItems": 4,
"type": "array"
},
{
"items": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"maxItems": 3,
"minItems": 3,
"type": "array"
}
],
"description": "Indicates the color for the Marker. This property is only used if the symbol is a well-known ID."
},
"fov": {
"description": "Indicates the horizontal field of view in degrees for the marker. Ranges from 0 to 360. This property is currently only supported by the \"dot\" symbol.",
"type": "number"
},
"geometry": {
"description": "The location of the Marker.",
"isRequired": "true"
},
"heading": {
"description": "The clockwise rotation of the symbol in the horizontal plane in degrees.",
"type": "number"
},
"id": {
"description": "The ID of the Marker.",
"type": "string"
},
"maps": {
"description": "The map(s) for the Marker. If maps are undefined, all maps will be targeted."
},
"onUpdate": {
"description": "Optional Action to perform when a Marker is updated."
},
"scale": {
"description": "The scale of the Marker, defaults to 1.",
"type": "number"
},
"symbol": {
"anyOf": [
{
"items": {
"$ref": "#/definitions/MarkerSymbolConfig"
},
"type": "array"
},
{
"type": "string"
}
],
"description": "The symbol used to display the marker. The symbol can be an array of Symbols or one of the following well-known IDs: \"dot\", \"callout\", or \"exclamation\". Defaults to \"dot\"."
},
"tilt": {
"description": "In 3D, the tilt angle of the location marker symbol. Ranges from 0 (straight down) to 180 (straight up) degrees. Defaults to 90 (straight ahead).",
"type": "number"
},
"userDraggable": {
"description": "Sets whether the Marker should be user draggable.",
"type": "boolean"
}
}
```
---
# command: location-marker.remove
Description: Remove a Marker. Web only.
Inputs: `RemoveLocationMarkerArgs`
RemoveLocationMarkerArgs properties:
```json
{
"id": {
"description": "The ID of the Marker to be removed.",
"type": "string"
},
"maps": {
"description": "The map(s) for the Marker. If maps are undefined, all maps will be targeted."
}
}
```
---
# command: location-marker.update
Description: Update an existing Marker. Web only.
Inputs: `UpdateLocationMarkerArgs`
UpdateLocationMarkerArgs properties:
```json
{
"color": {
"anyOf": [
{
"$ref": "#/definitions/@arcgis.core.Color.Color"
},
{
"items": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"maxItems": 4,
"minItems": 4,
"type": "array"
},
{
"items": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"maxItems": 3,
"minItems": 3,
"type": "array"
}
],
"description": "Indicates the color for the Marker. This property is only used if the symbol is a well-known ID."
},
"fov": {
"description": "Indicates the horizontal field of view in degrees for the marker. Ranges from 0 to 360. This property is currently only supported by the \"dot\" symbol.",
"type": "number"
},
"geometry": {
"description": "The location of the Marker."
},
"heading": {
"description": "The clockwise rotation of the symbol in the horizontal plane in degrees.",
"type": "number"
},
"id": {
"description": "The ID of the Marker.",
"type": "string",
"isRequired": "true"
},
"maps": {
"description": "The map(s) for the Marker. If maps are undefined, all maps will be targeted."
},
"onUpdate": {
"description": "Optional Action to perform when a Marker is updated."
},
"scale": {
"description": "The scale of the Marker, defaults to 1.",
"type": "number"
},
"symbol": {
"anyOf": [
{
"items": {
"$ref": "#/definitions/MarkerSymbolConfig"
},
"type": "array"
},
{
"type": "string"
}
],
"description": "The symbol used to display the marker. The symbol can be an array of Symbols or one of the following well-known IDs: \"dot\", \"callout\", or \"exclamation\". Defaults to \"dot\"."
},
"tilt": {
"description": "In 3D, the tilt angle of the location marker symbol. Ranges from 0 (straight down) to 180 (straight up) degrees. Defaults to 90 (straight ahead).",
"type": "number"
},
"userDraggable": {
"description": "Sets whether the Marker should be user draggable.",
"type": "boolean"
}
}
```
---