API Reference
VisualStatusTokens
Status colours shared by the three reporting vocabularies: finding severity, outcome, and operational state. Operational states reuse the severity and outcome hues but keep their own words. Status colours are never used for data series. Defaults are the Graphite palette v1 light pairs; every ink is at least 4.5:1 on card surfaces.
Inheritance
- Object
- VisualStatusTokens
Usage
Explore 3 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 3
- Property VisualDesignTokens.Status
- Method VisualStatusTokens.Clone
- Property VisualThemeColors.Status
Constructors
public VisualStatusTokens() #Methods
public VisualStatusTokens Clone() #VisualStatusTokensCreates a copy of these status colours.
public IReadOnlyList<ChartStateCategory> OperationalStateCategories(IReadOnlyDictionary<String, String>? labels = null) #IReadOnlyList<ChartStateCategory>Returns the operational states keyed up, degraded, down, recovering, maintenance, notObservable, and unknown. Up uses the pass colour, degraded medium, down critical, recovering low; not observable (hatched) and unknown (dashed outline) are neutral.
Parameters
- labels System.Collections.Generic.IReadOnlyDictionary<System.String, System.String>? = null
- Optional localized labels by key; missing keys keep the English label.
public IReadOnlyList<ChartStateCategory> OutcomeCategories(IReadOnlyDictionary<String, String>? labels = null) #IReadOnlyList<ChartStateCategory>Returns the outcomes that have their own colour, keyed pass, notEvaluated (hatched), and couldNotEvaluate (dashed outline). A failed result has no colour of its own; colour it by its severity.
Parameters
- labels System.Collections.Generic.IReadOnlyDictionary<System.String, System.String>? = null
- Optional localized labels by key; missing keys keep the English label.
public IReadOnlyList<ChartStateCategory> SeverityCategories(IReadOnlyDictionary<String, String>? labels = null) #IReadOnlyList<ChartStateCategory>Returns the five finding severities, most severe first, keyed critical, high, medium, low, and info.
Parameters
- labels System.Collections.Generic.IReadOnlyDictionary<System.String, System.String>? = null
- Optional localized labels by key; missing keys keep the English label.
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public VisualTokenColor Critical { get; set; } #Gets or sets the critical severity colours.
public VisualTokenColor High { get; set; } #Gets or sets the high severity colours.
public VisualTokenColor Medium { get; set; } #Gets or sets the medium severity colours.
public VisualTokenColor Low { get; set; } #Gets or sets the low severity colours.
public VisualTokenColor Info { get; set; } #Gets or sets the informational severity colours.
public VisualTokenColor Pass { get; set; } #Gets or sets the passed outcome colours (also operational state up).
public VisualTokenColor Neutral { get; set; } #Gets or sets the neutral colours for not evaluated, could not evaluate, not observable, and unknown.
public VisualTokenColor Maintenance { get; set; } #Gets or sets the maintenance state colours.