Class MetricData<T>

Ensures the metric data is boolean.

Only strictly-boolean values are allowed (true, false). Use convertToBoolean() to coerce near-boolean values to boolean (e.g. "yes", 1, "True")

Returns

This MetricData cast to MetricData<boolean>.

Ensures the metric data is numeric.

Null values are treated as finite and will not throw an error.

Returns

This MetricData cast to MetricData<number>.

Ensures the metric data is of type string.

Null values are treated as strings and will not throw an error.

Returns

This MetricData cast to MetricData<string>.

Converts near-boolean metric data (e.g. "yes", "True", 1) to boolean.

Throws an error if any data is not coercible to a boolean.

Returns

This MetricData with its data coerced to boolean, and cast to MetricData<boolean>

Removes timeseries data for this metric.

Returns

new MetricData object without timeseries data.

Formats the metric value for display purposes, using this metric's formatting logic.

Returns

The formatted value.

Uses this metric's categorization logic (based on categoryThresholds or categoryValues) to categorize the current value to a Category.

Returns

The category that the value falls into.

Uses this metric's grading logic or categories to color the currentValue.

Returns

The color associated with the metric's value.

Checks if timeseries data is available.

Returns

True if timeseries data was fetched for this metric. False means the metric is not timeseries-enabled or includeTimeseries was set to false when fetching the data.

Removes any empty (null) values from the timeseries, Ensures the remaining data is numeric, and returns a new Timeseries<number> with the data.

Returns

The timeseries cast to Timeseries<number>.

Rounds the metric value to the appropriate number of significant digits based on this metric's formatting logic.

Returns

Rounded value.