IHeatRule

Type interface

A rule that sets a setting of each series element, such as its color or size, by its data item's value: from min at the lowest value to max at the highest.

More info: Heat rules

Sources

IHeatRule is an interface: it describes a shape of data and is not imported on its own.

Properties

#customFunction

Type undefined | (target: Sprite, minValue: number, maxValue: number, value: any) => void

A function that sets the element's settings itself, in place of min, max and key. It is called for each element, also for one with no value.

#dataField

Type string

Data item field that holds the value, e.g. "value" or "valueY".

#key

Type undefined | string

The setting to set, e.g. "fill".

#logarithmic

Type undefined | false | trueDefault false

Spreads the values between min and max on a logarithmic scale.

#max

Type any

Setting value for the element with the highest value.

#maxValue

Type undefined | number

Highest value of the range. If not set, the series' highest value is used, which needs calculateAggregates.

#min

Type any

Setting value for the element with the lowest value.

#minValue

Type undefined | number

Lowest value of the range. If not set, the series' lowest value is used, which needs calculateAggregates.

#neutral

Type any

Setting value for elements whose data item has no value.

#stops

Type ArraySince 5.21.2

Setting values for a scale through more than two, in place of min and max: the element with the lowest value gets the first, the one with the highest the last, and the ones between blend through the stops between. Numbers, percents or colors, all of one kind, e.g.

[negative, warning, positive] from the interface colors. Values outside minValue and maxValue get the first or last stop.

#target

Type Template

Template of the elements to set, e.g. series.columns.template.