Interface Category

An arbitrary category definition, consisting of category name, color, etc.

Categories are used for example when categorizing metric values (e.g. values <10 are categorized as "low" or the value 0 is categorized as "Off", etc.) See MetricCatalogOptions.metricCategorySets and categorySetId.

Example

{ id: "low", "name": "Low", "color": "green" }

Example

{ id: "unknown", "name": "Unknown", "color": "grey", default: true }

Hierarchy

  • Category

Properties

color description? id name?

Properties

color

color: string

The color used to represent this category (e.g. on maps or charts).

Optional description

description?: string

Optional user-facing description for this category that could show up in UI or tooltips.

id

id: string

An arbitrary ID used to identify this category.

Optional name

name?: string

Optional user-facing name for this category that could show up in UI or tooltips.

Settings

Member Visibility

Theme

Generated using TypeDoc