Interface CategorySet

A set of categories that are used together, e.g. to categorize a specific metric's values into "low", "medium", and "high" categories.

Example

{
id: "default",
categories: [
{ id: "low", "name": "Low", "color": "green" },
{ id: "medium", "name": "Medium", "color": "yellow" },
{ id: "high", "name": "High", "color": "red" },
],
defaultCategory: { id: "unknown", "name": "Unknown", "color": "grey" }
}

Hierarchy

  • CategorySet

Properties

categories: Category[]

The categories that make up this set. Note that by convention, categories should be ordered from lowest severity to highest severity.

defaultCategory: Category

A "default" category that's used e.g. when a metric value cannot be explicitly graded or categorized due to missing data.

id: string

The ID used to identify this category set.

Generated using TypeDoc