graph » options » choropleth

choropleth

[ root » graph » options » choropleth ]

Interactive map chart only: Sets the configuration for choropleth map coloring.




AttributeTypeDescription
aspectStringSets the styling aspect for the choropleth data
Accepted Values: ['gradient', 'intervals']
Default Value: gradient
Introduced in: v2.8.4
Chart types: Interactive-maps
colorStringFor the 'gradient' aspect, use the 'color' attribute to set the primary color for the choropleth map. The library will automatically lighten and darken the color depending on the effect attribute.
Default Value: '#336699'
Introduced in: v2.8.4
Chart types: Interactive-maps
colorsArray.When using the 'intervals' aspect, set the color for each interval with the 'colors' array.
Default Value: []
Introduced in: v2.8.4
Chart types: Interactive-maps
effectStringSets the gradient effect when using the 'color' attribute and 'gradient' aspect.
Accepted Values: ['lighten', 'darken']
Default Value: 'lighten'
Introduced in: v2.8.4
Chart types: Interactive-maps
intervalsNumberSets the number of choropleth intervals or levels.
Default Value: 4
Introduced in: v2.8.4
Chart types: Interactive-maps
labelsArrayAdd labels to the map.
Default Value: []
Introduced in: v2.8.4
Chart types: Interactive-maps
maxPercent
max-percent
NumberSets the maximum percentage that a color will be lightened or darkened
Default Value: 50
Introduced in: v2.8.4
Chart types: Interactive-maps
mirroredBooleanMirrors the color scale values when using a gradient.
Introduced in: v2.8.4
Chart types: Interactive-maps
overrideTooltip
override-tooltip
BooleanSets whether the tooltip's background color is slighltly changed to a darker version of the assigned color.
Chart types: Interactive-maps
progressionStringSets whether the choropleth data should be analyzed on a linear ('lin') or logarithmic ('log') progression.
Accepted Values: ['lin', 'log']
Default Value: 'lin'
Introduced in: v2.8.4
Chart types: Interactive-maps
stepsArray.When using the 'intervals' aspect, set the choropleth value thresholds as an array of numbers.
Default Value: []
Introduced in: v2.8.4
Chart types: Interactive-maps