graph » heat map
heat map
[ root » graph » heat map ]
The heatmap object can be used to change the look and functionality of the heat map display.
| Attribute | Type | Description |
|---|---|---|
| alpha | Number | Sets the alpha value of the heatmap overlay. Set between 0 (fully transparent) and 1 (fully opaque). Default Value: 0.5 Introduced in: v2.8.6 Chart types: Heatmap-plugin |
| async | Boolean | Forces the heatmap to paint the data in async mode (in batches) to avoid blocking the browser. Default Value: false Introduced in: v2.8.6 Chart types: Heatmap-plugin |
| blur | Number | Sets the amount of blur that appears around each shape. Increasing this will increase the amount of surface area each shape takes up. Introduced in: v2.8.6 Chart types: Heatmap-plugin |
| brushType brush-type | String | Sets the shape the heatmap is painted with Accepted Values: ['circle', 'square', 'rectangle'] Default Value: 'circle' Introduced in: v2.8.6 Chart types: Heatmap-plugin |
| composite | Boolean | Sets whether to blend shapes together for the classic heatmap look (the color shifts more towards red where a greater number of stacked shapes are present) Introduced in: v2.8.6 Chart types: Heatmap-plugin |
| gradientColors gradient-colors | String | Sets the colors to use for the gradient Default Value: ['#0000ff', '#00ffff', '#bfff00', '#ffff00', '#ff0000'] Introduced in: v2.8.6 Chart types: Heatmap-plugin |
| gradientStops gradient-stops | String | Sets where each gradient stop (ie transition to another color) should be Default Value: [0.4, 0.6, 0.7, 0.8, 1.0] Introduced in: v2.8.6 Chart types: Heatmap-plugin |
| graph | Boolean, Object | Sets the configuration for a graph.
Set to true to create a scatter-heatmap chart. Use with `brushType`, `gradientColors`, and `gradientStops` to
add heatmap features to scatter chart.
Set to object to configure graph. Default Value: false Chart types: Heatmap-plugin,Scatter Heatmap |
| maxValue max-value | Number | Sets a maximum value. Introduced in: v2.8.6 Chart types: Heatmap-plugin |
| minValue min-value | Number | Sets a minimum value. Introduced in: v2.8.6 Chart types: Heatmap-plugin |
| placement | String | Sets the position of the heatmap layer in the chart's layer hierarchy (top|bottom). Accepted Values: ['top', 'bottom'] Introduced in: v2.8.6 Chart types: Heatmap-plugin |
| size | Array.<Number>, Number | Modifies how large each painted shape is. Enter one value as a string or two values as an array of strings. Introduced in: v2.8.6 Chart types: Heatmap-plugin |
| sortData sort-data | Boolean | Sets whether the data is sorted by value (which will also affect the order of paint). Introduced in: v2.8.6 Chart types: Heatmap-plugin |
| tooltip | Object | Configures the tooltip element, which appears when hovering over an object. Introduced in: v2.8.6 Chart types: Heatmap-plugin |