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

VertiGIS Viewer Specification

# command: charts.add-features
Description: Adds one or more features to charts. If `chart` is specified, then only the given chart will be updated, otherwise all charts will. Web only.

Inputs: `( @vertigis.api-docs.Features FeatureSet|FeatureList|FeatureStream | ( @vertigis.arcgis-extensions.data.Feature.FeatureProperties )[] | Results | UpdateChartFeaturesArgs )`

Results properties:
```json
{
  "features": {
    "description": "Features to use for the command/operation."
  },
  "maps": {
    "description": "Map(s) to use for the command/operation."
  }
}
```

UpdateChartFeaturesArgs properties:
```json
{
  "chart": {
    "description": "The chart(s) to update, referenced by layout ID or chart model.",
    "isRequired": "true"
  },
  "features": {
    "description": "Features to use for the command/operation."
  }
}
```

---
# command: charts.clear
Description: Clear features from active charts. If a chart is specified, then only the given chart will be updated, otherwise all charts will. Web only.

Inputs: `( Model | 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"
  }
}
```

---
# command: charts.display
Description: Updates charts with provided features. Only activated charts that receive features from all required feature sources will get displayed. Web only.

Inputs: `( @vertigis.api-docs.Features FeatureSet|FeatureList|FeatureStream | ( @vertigis.arcgis-extensions.data.Feature.FeatureProperties )[] | Results | UpdateChartFeaturesArgs )`

Results properties:
```json
{
  "features": {
    "description": "Features to use for the command/operation."
  },
  "maps": {
    "description": "Map(s) to use for the command/operation."
  }
}
```

UpdateChartFeaturesArgs properties:
```json
{
  "chart": {
    "description": "The chart(s) to update, referenced by layout ID or chart model.",
    "isRequired": "true"
  },
  "features": {
    "description": "Features to use for the command/operation."
  }
}
```

---
# command: charts.remove-features
Description: Remove one or more features from active charts. If `chart` is specified, then only the given chart will be updated, otherwise all charts will. Web only.

Inputs: `( @vertigis.api-docs.Features FeatureSet|FeatureList|FeatureStream | ( @vertigis.arcgis-extensions.data.Feature.FeatureProperties )[] | Results | UpdateChartFeaturesArgs )`

Results properties:
```json
{
  "features": {
    "description": "Features to use for the command/operation."
  },
  "maps": {
    "description": "Map(s) to use for the command/operation."
  }
}
```

UpdateChartFeaturesArgs properties:
```json
{
  "chart": {
    "description": "The chart(s) to update, referenced by layout ID or chart model.",
    "isRequired": "true"
  },
  "features": {
    "description": "Features to use for the command/operation."
  }
}
```

---
# command: charts.update-definition
Description: Updates the definition of a chart. Web only.

Inputs: `UpdateChartDefinitionArgs`

UpdateChartDefinitionArgs properties:
```json
{
  "chart": {
    "description": "The chart to update, referenced by chart model or its ID.",
    "isRequired": "true"
  },
  "definition": {
    "description": "The Highcharts definition with which to update the chart.",
    "isRequired": "true"
  }
}
```

---