graph » shapes » options » choropleth
choropleth
[ root » graph » shapes » options » choropleth ]
Interactive map chart only: Sets the configuration for choropleth map coloring.
| Attribute | Type | Description |
|---|---|---|
| aspect | String | Sets the styling aspect for the choropleth data Accepted Values: ['gradient', 'intervals'] Default Value: 'gradient' Introduced in: v2.8.4 Chart types: Interactive-maps |
| color | String | For 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 |
| colors | Array.<String> | 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 |
| effect | String | Sets 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 |
| intervals | Number | Sets the number of choropleth intervals or levels. Default Value: 4 Introduced in: v2.8.4 Chart types: Interactive-maps |
| maxPercent max-percent | Number | Sets the maximum percentage that a color will be lightened or darkened Default Value: 50 Introduced in: v2.8.4 Chart types: Interactive-maps |
| mirrored | Boolean | Mirrors the color scale values when using a gradient. Introduced in: v2.8.4 Chart types: Interactive-maps |
| overrideTooltip override-tooltip | Boolean | Sets whether the tooltip's background color is slighltly changed to a darker version of the assigned color. Chart types: Interactive-maps |
| progression | String | Sets 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 |
| steps | Array.<Number> | 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 |