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

VertiGIS Viewer Specification

# command: kpi.add-features
Description: Add one or more features to active KPI cards. Web only.

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

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

UpdateKpiCardFeaturesArgs properties:
```json
{
  "features": {
    "description": "Features to use for the command/operation."
  },
  "kpiCard": {
    "description": "The KPI card to update, referenced by KPI card model or its ID.",
    "isRequired": "true"
  }
}
```

---
# command: kpi.clear
Description: Clear features from active KPI cards. 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: kpi.display
Description: Displays the KPI card and updates it with provided features. Web only.

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

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

UpdateKpiCardFeaturesArgs properties:
```json
{
  "features": {
    "description": "Features to use for the command/operation."
  },
  "kpiCard": {
    "description": "The KPI card to update, referenced by KPI card model or its ID.",
    "isRequired": "true"
  }
}
```

---
# command: kpi.remove-features
Description: Remove one or more features from active KPI cards. Web only.

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

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

UpdateKpiCardFeaturesArgs properties:
```json
{
  "features": {
    "description": "Features to use for the command/operation."
  },
  "kpiCard": {
    "description": "The KPI card to update, referenced by KPI card model or its ID.",
    "isRequired": "true"
  }
}
```

---
# command: kpi.update-definition
Description: Updates the definition of a KPI Card. Web only.

Inputs: `UpdateKpiCardDefinitionArgs`

UpdateKpiCardDefinitionArgs properties:
```json
{
  "kpiCard": {
    "description": "The KPI card model or its ID.",
    "isRequired": "true"
  },
  "referenceExpression": {
    "description": "The stringified Arcade script used to calculate the 'reference' token of the KPI card.",
    "type": "string"
  },
  "valueExpression": {
    "description": "The stringified Arcade script used to calculate the 'value' token of the KPI Card.",
    "type": "string"
  }
}
```

---