Class Threshold (2.0.0)

Version 2.0.0

• 2.18.2 (latest)
• 2.18.0
• 2.17.0
• 2.16.1
• 2.15.3
• 2.14.1
• 2.13.0
• 2.12.3
• 2.11.1
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.4
• 2.6.1
• 2.5.1
• 2.4.1
• 2.3.0
• 2.2.4
• 2.1.0
• 2.0.0
• 1.0.2
• 0.1.2

Threshold(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Defines a threshold for categorizing time series values.

Attributes
Name	Description
label	str A label for the threshold.
value	float The value of the threshold. The value should be defined in the native scale of the metric.
color	.metrics.Threshold.Color The state color for this threshold. Color is not allowed in a XyChart.
direction	.metrics.Threshold.Direction The direction for the current threshold. Direction is not allowed in a XyChart.

Classes

Color

Color(value)

The color suggests an interpretation to the viewer when actual values cross the threshold. Comments on each color provide UX guidance on how users can be expected to interpret a given state color.

Direction

Direction(value)

Whether the threshold is considered crossed by an actual value above or below its threshold value.