@vertigis/viewer-spec/messaging/schema/web-layer-comparison-command-definitions.md

VertiGIS Viewer Specification

# command: layer-comparison.add-leading-layers
Description: Adds the layer(s) to the map's leading layers, which are used by the layer-comparison tool. Leading layers are positioned at the left of the map if the layer-comparison orientation is 'horizontal' and at the top of the map if the layer-comparison orientation is 'vertical'. Adding a layer to the leading layers will automatically remove it from the trailing layers. Only operational layers that exist within a given map are valid - others will be ignored. Web only.

Inputs: `Layers`

Layers properties:
```json
{
  "id": {
    "description": "The table's ID.",
    "type": "string"
  },
  "path": {
    "description": "The path to the geodatabase used by an MMAP layer. Mobile only.",
    "type": "string"
  },
  "subtype": {
    "description": "The Layer's type, used for Layer types with multiple possible layer extension mappings.",
    "type": "string"
  },
  "title": {
    "description": "The table's title.",
    "type": "string"
  },
  "url": {
    "description": "The layer's url.",
    "type": "string"
  },
  "@arcgis.core.layers.Layer.Layer": {
    "$ref": "esri.layers.Layer"
  },
  "layers": {
    "description": "Layer(s) to use for the command/operation."
  }
}
```

---
# command: layer-comparison.add-trailing-layers
Description: Adds the layer(s) to the map's trailing layers, which are used by the layer-comparison tool. Trailing layers are positioned at the right of the map if the layer-comparison orientation is 'horizontal' and at the bottom of the map if the layer-comparison orientation is 'vertical'. Adding a layer to the trailing layers will automatically remove it from the leading layers. Only operational layers that exist within a given map are valid - others will be ignored. Web only.

Inputs: `Layers`

Layers properties:
```json
{
  "id": {
    "description": "The table's ID.",
    "type": "string"
  },
  "path": {
    "description": "The path to the geodatabase used by an MMAP layer. Mobile only.",
    "type": "string"
  },
  "subtype": {
    "description": "The Layer's type, used for Layer types with multiple possible layer extension mappings.",
    "type": "string"
  },
  "title": {
    "description": "The table's title.",
    "type": "string"
  },
  "url": {
    "description": "The layer's url.",
    "type": "string"
  },
  "@arcgis.core.layers.Layer.Layer": {
    "$ref": "esri.layers.Layer"
  },
  "layers": {
    "description": "Layer(s) to use for the command/operation."
  }
}
```

---
# command: layer-comparison.clear-leading-layers
Description: Removes all leading layers from the map(s). Web only.

Inputs: `( @vertigis.arcgis-extensions.mapping.MapExtension.MapExtension | @vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[] )`

---
# command: layer-comparison.clear-trailing-layers
Description: Removes all trailing layers from the map(s). Web only.

Inputs: `( @vertigis.arcgis-extensions.mapping.MapExtension.MapExtension | @vertigis.arcgis-extensions.mapping.MapExtension.MapExtension[] )`

---
# command: layer-comparison.remove-leading-layers
Description: Removes the layer(s) from the map's leading layers, which are used by the layer-comparison tool. Web only.

Inputs: `Layers`

Layers properties:
```json
{
  "id": {
    "description": "The table's ID.",
    "type": "string"
  },
  "path": {
    "description": "The path to the geodatabase used by an MMAP layer. Mobile only.",
    "type": "string"
  },
  "subtype": {
    "description": "The Layer's type, used for Layer types with multiple possible layer extension mappings.",
    "type": "string"
  },
  "title": {
    "description": "The table's title.",
    "type": "string"
  },
  "url": {
    "description": "The layer's url.",
    "type": "string"
  },
  "@arcgis.core.layers.Layer.Layer": {
    "$ref": "esri.layers.Layer"
  },
  "layers": {
    "description": "Layer(s) to use for the command/operation."
  }
}
```

---
# command: layer-comparison.remove-trailing-layers
Description: Removes the layer(s) from the map's trailing layers, which are used by the layer-comparison tool. Web only.

Inputs: `Layers`

Layers properties:
```json
{
  "id": {
    "description": "The table's ID.",
    "type": "string"
  },
  "path": {
    "description": "The path to the geodatabase used by an MMAP layer. Mobile only.",
    "type": "string"
  },
  "subtype": {
    "description": "The Layer's type, used for Layer types with multiple possible layer extension mappings.",
    "type": "string"
  },
  "title": {
    "description": "The table's title.",
    "type": "string"
  },
  "url": {
    "description": "The layer's url.",
    "type": "string"
  },
  "@arcgis.core.layers.Layer.Layer": {
    "$ref": "esri.layers.Layer"
  },
  "layers": {
    "description": "Layer(s) to use for the command/operation."
  }
}
```

---
# command: layer-comparison.set-direction
Description: Changes the orientation of the map(s') layer-comparison bar between 'horizontal' and 'vertical'. Web only.

Inputs: `SetLayerComparisonDirectionArgs`

SetLayerComparisonDirectionArgs properties:
```json
{
  "direction": {
    "description": "The direction in which the layer-comparison tool should slide.",
    "enum": [
      "horizontal",
      "vertical"
    ],
    "type": "string",
    "isRequired": "true"
  },
  "maps": {
    "description": "The map(s) on which to set the layer-comparison direction."
  }
}
```

---
# command: layer-comparison.set-mode
Description: Activates or deactivates the layer-comparison mode on the map(s). Web only.

Inputs: `SetLayerComparisonModeArgs`

SetLayerComparisonModeArgs properties:
```json
{
  "active": {
    "description": "Whether or not the layer-comparison mode should be active.",
    "type": "boolean",
    "isRequired": "true"
  },
  "leadingLayers": {
    "description": "Sets the leading layers on the map."
  },
  "maps": {
    "description": "The map(s) on which to set the layer-comparison mode."
  },
  "trailingLayers": {
    "description": "Sets the trailing layers on the map."
  }
}
```

---