ChartStateCategory

Namespace ChartForgeX.Core

Assembly ChartForgeX

Modifiers sealed

Describes one categorical state, such as an operational state or a severity: the key that data refers to, its display label, its colour, and how its marks are drawn. Categories are listed in legends in the order they are registered.

Inheritance

Object
ChartStateCategory

Usage

Explore 5 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 4

Property ChartOptions.StateCategories
Method VisualStatusTokens.OperationalStateCategories
Method VisualStatusTokens.OutcomeCategories
Method VisualStatusTokens.SeverityCategories

Accepted by parameters 1

Method Chart.WithStateCategories parameter states

Constructors

public ChartStateCategory(String key, String label, ChartColor color, ChartStatePattern pattern = Solid, ChartStateEmphasis emphasis = Normal)

Initializes a new state definition.

Parameters

key System.String requiredposition: 0: The state key used by segments, for example up or degraded.
label System.String requiredposition: 1: The display label shown in the legend and tooltips.
color ChartForgeX.Primitives.ChartColor requiredposition: 2: The colour of marks in this state.
pattern ChartForgeX.Core.ChartStatePattern = Solid optionalposition: 3: How marks are filled: solid, hatched, cross-hatched, or outlined.
emphasis ChartForgeX.Core.ChartStateEmphasis = Normal optionalposition: 4: How much marks draw the eye; ChartStateEmphasis.Quiet lightens them.

Inherited Methods

Properties

public String Key { get; } #

Gets the state key used by segments.

public String Label { get; } #

Gets the display label shown in the legend and tooltips.

public ChartColor Color { get; } #

Gets the colour of marks in this state.

public ChartStatePattern Pattern { get; } #

Gets how marks in this state are filled.

public ChartStateEmphasis Emphasis { get; } #

Gets how much marks in this state draw the eye.