IHeatRule – amCharts 5 Documentation

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.

Click here for more info

Inheritance

IHeatRule does not extend any other symbol.

IHeatRule is not extended by any other symbol.

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` \| `true` Default `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.
target #	Type `Template` Template of the elements to set, e.g. `series.columns.template`.