class anychart.charts.HeatMap Improve this Doc
Extends: anychart.core.SeparateChart
AnyChart HeatMap class.
Note: Use anychart#heatMap method to get an instance of this class.
Methods Overview
| Specific settings | |
| globalToLocal() | Converts the global coordinates to local coordinates. |
| localToGlobal() | Converts the local coordinates to global coordinates. |
| Axes and Scales | |
| colorScale() | Color scale settings. |
| grid() | Grid settings. |
| xAxis() | X-axis settings. |
| xScale() | X scale settings. |
| yAxis() | Y-axis settings. |
| yScale() | Y scale settings. |
| Chart Coloring | |
| animation() | Animation settings |
| background() | Background settings. |
| Chart Controls | |
| contextMenu() | Context menu settings. |
| credits() | Credits settings |
| label() | Label settings. |
| legend() | Legend settings. |
| title() | Title settings. |
| xScroller() | X scroller settings. |
| yScroller() | Y scroller settings. |
| Coloring | |
| fill() | Fill settings. |
| hatchFill() | Hatch fill settings. |
| hoverFill() | Fill settings in hover mode. |
| hoverHatchFill() | Hatch fill settings in hover mode. |
| hoverStroke() | Stroke settings in hover mode. |
| selectFill() | Fill settings in selected mode. |
| selectHatchFill() | Hatch fill settings in selected mode. |
| selectMarqueeFill() | Select marquee fill settings. |
| selectMarqueeStroke() | Stroke settings. |
| selectStroke() | Stroke settings in selected mode. |
| stroke() | Stroke settings. |
| Data | |
| data() | Data settings. |
| getStat() | Getter for a statistical value by the key. |
| Events | |
| listen() | Adds an event listener. |
| listenOnce() | Adds a single time event listener. |
| removeAllListeners() | Removes all listeners. |
| unlisten() | Removes the listener. |
| unlistenByKey() | Removes the listener by the key. |
| Export | |
| print() | Prints all elements. |
| saveAsCsv() | Saves chart data as CSV file. |
| saveAsJson() | Saves chart config as JSON document. |
| saveAsXlsx() | Saves chart data as Excel document. |
| saveAsXml() | Saves chart config as XML document. |
| toCsv() | Returns CSV string with series data. |
| Interactivity | |
| hover() | Hovers point by index. |
| interactivity() | Interactivity settings. |
| select() | Selects point by index. |
| startSelectMarquee() | Starts select marquee drawing. |
| tooltip() | Tooltip settings. |
| xZoom() | X Zoom settings. |
| yZoom() | Y Zoom settings. |
| Point Elements | |
| hoverLabels() | Labels settings in hover mode. |
| hoverMarkers() | Markers settings in hover mode. |
| labels() | Labels settings. |
| labelsDisplayMode() | Labels display mode. |
| markers() | Markers settings. |
| selectLabels() | Labels settings in selected mode. |
| selectMarkers() | Markers settings in selected mode. |
| Size and Position | |
| bottom() | Bottom bound setting. |
| bounds() | Bounds settings. |
| getPixelBounds() | Returns pixel bounds. |
| height() | Height setting. |
| left() | Left bound setting. |
| margin() | Margin settings. |
| maxHeight() | Maximum height. |
| maxWidth() | Maximum width. |
| minHeight() | Minimum height. |
| minWidth() | Minimum width. |
| padding() | Padding settings. |
| right() | Right bound setting. |
| top() | Top bound setting. |
| width() | Width setting. |
| zIndex() | Z-index of the element. |
| XML/JSON | |
| toJson() | Return chart configuration as JSON object or string. |
| toXml() | Return chart configuration as XML string or XMLNode. |
| Miscellaneous | |
| cancelMarquee() | Stops current marquee action if any. |
| container() | Getter for the element's container. |
| draw() | Drawing of the chart. |
| inMarquee() | Gets marquee process running value. |
| saveAsJpg() | Saves the current chart as JPEG image. |
| saveAsPdf() | Saves the current chart as PDF image. |
| saveAsPng() | Saves the current chart as PNG image. |
| saveAsSvg() | Saves the current chart as SVG image. |
| toSvg() | Returns SVG string. |
Methods Description
animation
Getter for the current animation setting.
Returns:
anychart.core.utils.Animation - Returns true if the animation is enabled.Try it:
Setter for the animation setting by one value.
Detailed description
Sets animation settings depending on parameter type:
- null/boolean - disable or enable animation.
- object - sets animation settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean | Object | false | Whether to enable animation. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Setter for the animation settings using several parameters.
Detailed description
Note If you use anychart.graphics.vector.Stage#suspend, you will not see animation.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | false | Whether to enable animation. |
| duration | number | 1000 | Duration in milliseconds. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
background
Getter for the current chart background.
Returns:
anychart.core.ui.Background - The current chart background.Try it:
Setter for the chart background.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Object | {enabled: true, fill: "#fff", stroke: 'none', zIndex: 1} | Background object to set. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
bottom
Getter for element bottom bound setting.
Returns:
number | string | undefined - Current element's bottom bound setting.Sets element bottom bound setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Bottom bound setting for the element. |
Returns:
anychart.charts.HeatMap - Returns self for method chaining.Try it:
bounds
Getter for the element bounds settings.
Returns:
anychart.core.utils.Bounds - Current bounds of the element.Sets bounds of the element using one parameter.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.Bounds | Bounds of element. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
Setter for the element bounds settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| x | number | string | null | X-coordinate. |
| y | number | string | null | Y-coordinate. |
| width | number | string | null | Width. |
| height | number | string | null | Height. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
cancelMarquee
Stops current marquee action if any.
Returns:
anychart.charts.HeatMap - Self instance for method chaining.colorScale
Getter for the current color scale.
Returns:
anychart.scales.OrdinalColor - Color scale instance. See listing
var currentColorScale = chart.colorScale();
Setter for the color scale.
Detailed description
Note: If you call a fill method, the colorScale settings will not be applied.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.scales.OrdinalColor | Value to set. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
container
Getter for the element's container.
Setter for the element's container.
Detailed description
Each element appends all its content to this container.
The order of adding is not defined, but usually it will be the order in which elements are drawn for the first time. If you need to specify the order use anychart.core.VisualBase#zIndex.
The order of adding is not defined, but usually it will be the order in which elements are drawn for the first time. If you need to specify the order use anychart.core.VisualBase#zIndex.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.graphics.vector.Layer | anychart.graphics.vector.Stage | string | Element | The value to set. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining. Example
// string
element.container('containerIdentifier');
// DOM-element
var domElement = document.getElementById('containerIdentifier');
element.container(domElement);
// Framework-element
var fwElement = anychart.standalones.title();
element.container( fwElement.container() );Try it:
contextMenu
Getter for the current context menu.
Returns:
anychart.ui.ContextMenu - The current context menu.Try it:
Setter for the context menu.
Detailed description
Sets context menu settings depending on parameter type:
- null/boolean - disable or enable context menu.
- object - sets context menu settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | boolean | null | Context menu settings |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.credits
Setter for the chart credits.
Learn more about credits settings.
Detailed description
Note: You can't customize credits without your licence key. To buy licence key go to
Buy page.
Sets chart credits settings depending on parameter type:
Sets chart credits settings depending on parameter type:
- null/boolean - disable or enable chart credits.
- object - sets chart credits settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Object | boolean | null | true | Credits settings |
Returns:
anychart.charts.HeatMap - An instance of the class for method chaining.data
Setter for the chart data.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.data.View | anychart.data.Set | Array | string | anychart.data.DataSettings | Value to set. |
| csvSettings | anychart.enums.TextParsingMode | anychart.data.TextParsingSettings | If CSV string is passed by first param, you can pass CSV parser settings here as a hash map. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.draw
Starts the rendering of the chart into the container.
Params:
| Name | Type | Description |
|---|---|---|
| async | boolean | Whether do draw asynchronously. If set to true, the chart will be drawn asynchronously. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.fill
Getter for the current fill color.
Returns:
anychart.graphics.vector.Fill | function - The current fill color.Try it:
Sets fill settings using an array or a string.
Learn more about coloring.
Detailed description
Note: If you call a fill method, the colorScale settings will not be applied.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.graphics.vector.Fill | Color as an array or a string. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
Sets fill settings using function.
Detailed description
Note: If you call a fill method, the colorScale settings will not be applied.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| fillFunction | function | function() {
return anychart.color.darken(this.sourceColor);
} | Function that looks like function(){
// this.index - series index.
// this.sourceColor - color returned by fill() getter.
// this.iterator - series point iterator.
return fillValue; // type anychart.graphics.vector.Fill
}. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
Fill color with opacity. Fill as a string or an object.
Detailed description
Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which
means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.
Note: If you call a fill method, the colorScale settings will not be applied.
Params:
| Name | Type | Description |
|---|---|---|
| color | string | Color as a string. |
| opacity | number | Color opacity. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
Linear gradient fill.
Learn more about coloring.
Detailed description
Note: If you call a fill method, the colorScale settings will not be applied.
Params:
| Name | Type | Description |
|---|---|---|
| keys | Array.<(anychart.graphics.vector.GradientKey|string)> | Gradient keys. |
| angle | number | Gradient angle. |
| mode | boolean | anychart.graphics.vector.Rect | Object | Gradient mode. |
| opacity | number | Gradient opacity. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
Radial gradient fill.
Learn more about coloring.
Detailed description
Note: If you call a fill method, the colorScale settings will not be applied.
Params:
| Name | Type | Description |
|---|---|---|
| keys | Array.<(anychart.graphics.vector.GradientKey|string)> | Color-stop gradient keys. |
| cx | number | X ratio of center radial gradient. |
| cy | number | Y ratio of center radial gradient. |
| mode | anychart.graphics.math.Rect | If defined then userSpaceOnUse mode, else objectBoundingBox. |
| opacity | number | Opacity of the gradient. |
| fx | number | X ratio of focal point. |
| fy | number | Y ratio of focal point. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
Image fill.
Learn more about coloring.
Detailed description
Note: If you call a fill method, the colorScale settings will not be applied.
Params:
| Name | Type | Description |
|---|---|---|
| imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
getPixelBounds
Returns pixel bounds of the element due to parent bounds and self bounds settings.
Returns:
anychart.math.Rect - Pixel bounds of the element.getStat
Getter for a statistical value by the key.
Params:
| Name | Type | Description |
|---|---|---|
| key | string | anychart.enums.Statistics | Key. |
Returns:
* - Statistics value.Try it:
globalToLocal
Converts the global coordinates to local coordinates.
Note: Works only after anychart.core.Chart#draw is called.
Detailed description
Converts global coordinates of the global document into local coordinates of the container or stage.
On image below, the red point is a starting coordinate point of the chart bounds. Local coordinates work only in area of the stage (container).
On image below, the red point is a starting coordinate point of the chart bounds. Local coordinates work only in area of the stage (container).
Params:
| Name | Type | Description |
|---|---|---|
| xCoord | number | Global X coordinate. |
| yCoord | number | Global Y coordinate. |
Returns:
Object.<string, number> - Object with XY coordinates.Try it:
grid
Getter for the current chart grid.
Params:
| Name | Type | Description |
|---|---|---|
| index | number | Chart grid index. If not set - creates a new instance and adds it to the end of grids array. |
Returns:
anychart.core.grids.Linear - Grid instance by index.Try it:
Setter for the chart grid.
Detailed description
Sets chart grid settings depending on parameter type:
- null/boolean - disable or enable chart grid.
- object - sets chart grid settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Object | boolean | null | false | Grid settings to set. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Setter for the chart grid by index.
Detailed description
Sets chart grid settings by index depending on parameter type:
- null/boolean - disable or enable chart grid by index.
- object - sets chart grid settings by index.
Params:
| Name | Type | Description |
|---|---|---|
| index | number | Chart grid index. |
| value | Object | boolean | null | Grid settings to set. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.hatchFill
Getter for the current hatch fill settings.
Returns:
anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - Current hatch fill.Try it:
Setter for the hatch fill settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| patternFillOrType | anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | string | boolean | false | PatternFill or HatchFill instance or type of hatch fill. |
| color | string | Color. | |
| thickness | number | Thickness. | |
| size | number | Pattern size. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
height
Getter for element height setting.
Returns:
number | string | undefined - Current element's height setting.Sets element height setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Height setting for the element. |
Returns:
anychart.charts.HeatMap - Returns self for method chaining.Try it:
hover
Hovers point by index.
Note: Works only after anychart.charts.HeatMap#draw is called.
Detailed description
If index is passed, hovers a point by its index, else hovers all points.
Params:
| Name | Type | Description |
|---|---|---|
| indexOrIndexes | number | Array.<number> | Point index or array of indexes. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
hoverFill
Getter for the current fill color in hover mode.
Returns:
anychart.graphics.vector.Fill | function - Current fill color.Try it:
Sets fill settings in hover mode using an object or a string.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.graphics.vector.Fill | Color as an object or a string. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
Sets fill settings in hover mode using function.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| fillFunction | function | function() {
return anychart.color.darken(this.sourceColor);
} | Function that looks like function(){
// this.index - series index.
// this.sourceColor - color returned by fill() getter.
// this.iterator - series point iterator.
return fillValue; // type anychart.graphics.vector.Fill
}. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
Fill color in hover mode with opacity.
Fill as a string or an object.
Detailed description
Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which
means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.
Params:
| Name | Type | Description |
|---|---|---|
| color | string | Color as a string. |
| opacity | number | Color opacity. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
Linear gradient fill in hover mode.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| keys | Array.<(anychart.graphics.vector.GradientKey|string)> | Gradient keys. |
| angle | number | Gradient angle. |
| mode | boolean | anychart.graphics.vector.Rect | Object | Gradient mode. |
| opacity | number | Gradient opacity. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
Radial gradient fill in hover mode.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| keys | Array.<(anychart.graphics.vector.GradientKey|string)> | Color-stop gradient keys. |
| cx | number | X ratio of center radial gradient. |
| cy | number | Y ratio of center radial gradient. |
| mode | anychart.graphics.math.Rect | If defined then userSpaceOnUse mode, else objectBoundingBox. |
| opacity | number | Opacity of the gradient. |
| fx | number | X ratio of focal point. |
| fy | number | Y ratio of focal point. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
Image fill in hover mode.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
hoverHatchFill
Getter for the current hatch fill settings in hover mode.
Returns:
anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - The current hatch fill.Try it:
Setter for the hatch fill settings in hover mode.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| patternFillOrType | anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | string | boolean | false | PatternFill or HatchFill instance or type of hatch fill. |
| color | string | Color. | |
| thickness | number | Thickness. | |
| size | number | Pattern size. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
hoverLabels
Getter for the current chart data labels in hover mode.
Returns:
anychart.core.ui.LabelsFactory - Labels instance.Try it:
Setter for the chart data labels in hover mode.
Detailed description
Sets chart labels settings depending on parameter type:
- null/boolean - disable or enable chart labels.
- object - sets chart labels settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | boolean | null | Chart data labels settings. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.hoverMarkers
Getter for the current data markers in hover mode.
Returns:
anychart.core.ui.MarkersFactory - Markers instance.Try it:
Setter for data markers in hover mode.
Detailed description
Sets chart markers settings depending on parameter type:
- null/boolean - disable or enable chart markers.
- object - sets chart markers settings.
- string - sets chart markers type.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Object | boolean | null | string | false | Data markers settings. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.hoverStroke
Getter for the stroke in hover mode.
Returns:
anychart.graphics.vector.Stroke | function - Current stroke in the normal state.Try it:
Setter for the stroke in hover mode using function.
Learn more about stroke settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | function | // return stroke from the default palette.
function() {
return anychart.color.darken(this.sourceColor);
}; | Stroke-function, which should look like:function() {
// this: {
// index : number - the index of the current point
// sourceColor : anychart.graphics.vector.Stroke - stroke of the current point
// }
return myStroke; //anychart.graphics.vector.Stroke
};. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
Setter for the stroke in hover mode.
Learn more about stroke settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| color | anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null | Stroke settings. | |
| thickness | number | 1 | Line thickness. |
| dashpattern | string | Controls the pattern of dashes and gaps used to stroke paths. | |
| lineJoin | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
| lineCap | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
inMarquee
Gets marquee process running value.
Returns:
boolean - Returns true if there is a marquee process running.interactivity
Gets the current interactivity settings for chart.
Returns:
anychart.core.utils.Interactivity - The current interactivity settings.Sets interactivity settings for chart.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | anychart.enums.HoverMode | Settings object or boolean value like enabled state. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
label
Getter for chart label.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | string | number | 0 | Index of instance. |
Returns:
anychart.core.ui.Label - An instance of class.Try it:
Setter for chart label.
Detailed description
Sets chart label settings depending on parameter type:
- null/boolean - disable or enable chart label.
- string - sets chart label text value.
- object - sets chart label settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | null | boolean | Object | string | false | Chart label instance to add by index 0. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Setter for chart label.
Detailed description
Sets chart label settings by index depending on parameter type:
- null/boolean - disable or enable chart label.
- string - sets chart label text value.
- object - sets chart label settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | string | number | Label index. | |
| value | null | boolean | Object | string | false | Chart label settings. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.labels
Getter for the current chart data labels.
Returns:
anychart.core.ui.LabelsFactory - Labels instance.Try it:
Setter for the chart data labels.
Detailed description
Sets chart labels settings depending on parameter type:
- null/boolean - disable or enable chart labels.
- object - sets chart labels settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | boolean | null | Chart data labels settings. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.labelsDisplayMode
Getter for the current labels display mode.
Returns:
string | anychart.enums.LabelsDisplayMode - The current mode.Try it:
Setter for the labels display mode.
Detailed description
Note: If the parameter for labels’ position() method is not “center”, you will have to set
"crop" or "alwaysShow" display mode for displaying labels.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | string | anychart.enums.LabelsDisplayMode | "drop" | Mode to set. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
left
Getter for element left bound setting.
Returns:
number | string | undefined - Current element's left bound setting.Sets element left bound setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Left bound setting for the element. |
Returns:
anychart.charts.HeatMap - Returns self for method chaining.Try it:
legend
Getter for the current chart legend.
Returns:
anychart.core.ui.Legend - An instance of the class for method chaining.Try it:
Setter for chart legend setting.
Detailed description
Sets chart legend settings depending on parameter type:
- null/boolean - disable or enable chart legend.
- object - sets chart legend settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Object | boolean | null | false | Legend settings. |
Returns:
anychart.charts.HeatMap - An instance of the class for method chaining.listen
Adds an event listener to an implementing object.
Detailed description
The listener can be added to an object once, and if it is added one more time, its key will be returned.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| type | string | The event type id. | |
| listener | function | Callback method. Function that looks like function(event){
// event.actualTarget - actual event target
// event.currentTarget - current event target
// event.iterator - event iterator
// event.originalEvent - original event
// event.point - event point
// event.pointIndex - event point index
}. | |
| useCapture | boolean | false | Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing |
| listenerScope | Object | Object in whose scope to call the listener. |
Returns:
Object - Unique key for the listener.Try it:
listenOnce
Adds an event listener to an implementing object.
Detailed description
After the event is called, its handler will be deleted.
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| type | string | The event type id. | |
| listener | function | Callback method. | |
| useCapture | boolean | false | Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing |
| listenerScope | Object | Object in whose scope to call the listener. |
Returns:
Object - Unique key for the listener.Try it:
localToGlobal
Converts the local coordinates to global coordinates.
Note: Works only after anychart.core.Chart#draw is called.
Detailed description
Converts local coordinates of the container or stage into global coordinates of the global document.
On image below, the red point is a starting coordinate point of the chart bounds. Local coordinates work only in area of the stage (container).
On image below, the red point is a starting coordinate point of the chart bounds. Local coordinates work only in area of the stage (container).
Params:
| Name | Type | Description |
|---|---|---|
| xCoord | number | Local X coordinate. |
| yCoord | number | Local Y coordinate. |
Returns:
Object.<string, number> - Object with XY coordinates.Try it:
margin
Getter for current chart margin.
Detailed description
Also, you can use anychart.core.utils.Margin#bottom, anychart.core.utils.Margin#left,
anychart.core.utils.Margin#right, anychart.core.utils.Margin#top methods to setting paddings.
Returns:
anychart.core.utils.Margin - Chart margin.Try it:
Setter for the chart margin in pixels using a single complex object.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Array.<(number|string)> | Object | {top: 0, right: 0, bottom: 0, left: 0} | Value to set. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining. Example.
// all margins 15px
chart.margin(15);
// all margins 15px
chart.margin("15px");
// top and bottom 5px, right and left 15px
chart.margin(anychart.utils.margin(5, 15));Try it:
Setter for the chart margin in pixels using several simple values.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value1 | string | number | 0 | Top or top-bottom space. |
| value2 | string | number | 0 | Right or right-left space. |
| value3 | string | number | 0 | Bottom space. |
| value4 | string | number | 0 | Left space. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining. Example.
// 1) all 10px chart.margin(10); // 2) top and bottom 10px, left and right 15px chart.margin(10, "15px"); // 3) top 10px, left and right 15px, bottom 5px chart.margin(10, "15px", 5); // 4) top 10px, right 15px, bottom 5px, left 12px chart.margin(10, "15px", "5px", 12);
Try it:
markers
Getter for the current data markers.
Returns:
anychart.core.ui.MarkersFactory - Markers instance.Try it:
Setter for data markers.
Detailed description
Sets chart markers settings depending on parameter type:
- null/boolean - disable or enable chart markers.
- object - sets chart markers settings.
- string - sets chart markers type.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Object | boolean | null | string | false | Data markers settings. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.maxHeight
Getter for maximum height.
Returns:
number | string | null - Current element's maximum height.Setter for maximum height.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Value to set. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
maxWidth
Getter for maximum width.
Returns:
number | string | null - Current element's maximum width.Setter for maximum width.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Value to set. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
minHeight
Getter for minimum height.
Returns:
number | string | null - Current element's minimum height.Setter for minimum height.
Detailed description
The method sets a minimum height of elements, that will be to remain after a resize of element.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Value to set. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
minWidth
Getter for minimum width.
Returns:
number | string | null - Current element's minimum width.Setter for minimum width.
Detailed description
The method sets a minimum width of elements, that will be to remain after a resize of element.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Value to set. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
padding
Getter for the chart padding.
Detailed description
Also, you can use anychart.core.utils.Padding#bottom, anychart.core.utils.Padding#left, anychart.core.utils.Padding#right, anychart.core.utils.Padding#top methods to setting paddings.
Returns:
anychart.core.utils.Padding - Chart padding.Try it:
Setter for the chart paddings in pixels using a single value.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Array.<(number|string)> | Object | {top: 0, right: 0, bottom: 0, left: 0} | Value to set. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining. Example.
chart.padding([5, 15]);
or
chart.padding({left: 10, top: 20, bottom: 30, right: "40%"}});Try it:
Setter for the chart paddings in pixels using several numbers.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value1 | string | number | 0 | Top or top-bottom space. |
| value2 | string | number | 0 | Right or right-left space. |
| value3 | string | number | 0 | Bottom space. |
| value4 | string | number | 0 | Left space. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining. Example.
// 1) all 10px chart.padding(10); // 2) top and bottom 10px, left and right 15px chart.padding(10, "15px"); // 3) top 10px, left and right 15px, bottom 5px chart.padding(10, "15px", 5); // 4) top 10px, right 15%, bottom 5px, left 12px chart.padding(10, "15%", "5px", 12);
Try it:
Prints all elements on related stage.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| paperSizeOrOptions | anychart.graphics.vector.PaperSize | Object | Paper size or object with options. | |
| landscape | boolean | false | Flag of landscape. |
Try it:
removeAllListeners
Removes all listeners from an object. You can also optionally remove listeners of some particular type.
Params:
| Name | Type | Description |
|---|---|---|
| type | string | Type of event to remove, default is to remove all types. |
Returns:
number - Number of listeners removed.Try it:
right
Getter for element right bound setting.
Returns:
number | string | undefined - Current element's right bound setting.Sets element right bound setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Right bound setting for the element. |
Returns:
anychart.charts.HeatMap - Returns self for method chaining.Try it:
saveAsCsv
Saves chart data as CSV file.
Params:
| Name | Type | Description |
|---|---|---|
| chartDataExportMode | string | anychart.enums.ChartDataExportMode | Data export mode. |
| csvSettings | Object.<string, (string|boolean|undefined)> | CSV settings. |
| filename | string | File name to save. |
Try it:
saveAsJpg
Saves the current chart as JPEG image.
Params:
| Name | Type | Description |
|---|---|---|
| width | number | Object | Image width or object with options. |
| height | number | Image height. |
| quality | number | Image quality in ratio 0-1. |
| forceTransparentWhite | boolean | Force transparent to white or not. |
| filename | string | File name to save. |
Try it:
saveAsJson
Saves chart config as JSON document.
Params:
| Name | Type | Description |
|---|---|---|
| includeTheme | boolean | If the current theme properties should be included into the result. |
| filename | string | File name to save. |
Try it:
saveAsPdf
Saves the current chart as PDF image.
Params:
| Name | Type | Description |
|---|---|---|
| paperSizeOrWidthOrOptions | number | string | Object | Any paper format like 'a0', 'tabloid', 'b4', etc or width, or object with options. |
| landscape | boolean | Define, is landscape. |
| x | number | Offset X. |
| y | number | Offset Y. |
| filename | string | File name to save. |
Try it:
saveAsPng
Saves the current chart as PNG image.
Params:
| Name | Type | Description |
|---|---|---|
| width | number | Object | Image width or object with options. |
| height | number | Image height. |
| quality | number | Image quality in ratio 0-1. |
| filename | string | File name to save. |
Try it:
saveAsSvg
Saves the current chart as SVG image.
Params:
| Name | Type | Description |
|---|---|---|
| paperSize | string | Object | Paper Size or object with options. |
| landscape | boolean | Landscape. |
| filename | string | File name to save. |
Try it:
Saves the stage as SVG image using width and height.
Params:
| Name | Type | Description |
|---|---|---|
| width | number | Image width. |
| height | number | Image height. |
Try it:
saveAsXlsx
Saves chart data as Excel document.
Params:
| Name | Type | Description |
|---|---|---|
| chartDataExportMode | string | anychart.enums.ChartDataExportMode | Data export mode. |
| filename | string | File name to save. |
Try it:
saveAsXml
Saves chart config as XML document.
Params:
| Name | Type | Description |
|---|---|---|
| includeTheme | boolean | If the current theme properties should be included into the result. |
| filename | string | File name to save. |
Try it:
select
Selects point by index.
Note: Works only after anychart.charts.HeatMap#draw is called.
Params:
| Name | Type | Description |
|---|---|---|
| indexOrIndexes | number | Array.<number> | Index or array of indexes of the point to select |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
selectFill
Getter for the current fill color in selected mode.
Returns:
anychart.graphics.vector.Fill | function - Current fill color.Try it:
Sets fill settings in selected mode using an array or a string.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.graphics.vector.Fill | Color as an array or a string. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
Sets fill settings in selected mode using function.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| fillFunction | function | function() {
return anychart.color.darken(this.sourceColor);
} | Function that looks like function(){
// this.index - series index.
// this.sourceColor - color returned by fill() getter.
// this.iterator - series point iterator.
return fillValue; // type anychart.graphics.vector.Fill
}. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
Fill color in selected mode with opacity.
Fill as a string or an object.
Detailed description
Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which
means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.
Params:
| Name | Type | Description |
|---|---|---|
| color | string | Color as a string. |
| opacity | number | Color opacity. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
Linear gradient fill in selected mode.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| keys | Array.<(anychart.graphics.vector.GradientKey|string)> | Gradient keys. |
| angle | number | Gradient angle. |
| mode | boolean | anychart.graphics.vector.Rect | Object | Gradient mode. |
| opacity | number | Gradient opacity. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
Radial gradient fill in selected mode.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| keys | Array.<(anychart.graphics.vector.GradientKey|string)> | Color-stop gradient keys. |
| cx | number | X ratio of center radial gradient. |
| cy | number | Y ratio of center radial gradient. |
| mode | anychart.graphics.math.Rect | If defined then userSpaceOnUse mode, else objectBoundingBox. |
| opacity | number | Opacity of the gradient. |
| fx | number | X ratio of focal point. |
| fy | number | Y ratio of focal point. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
Image fill in selected mode.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
selectHatchFill
Getter for the current hatch fill settings in selected mode.
Returns:
anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - Current hatch fill.Try it:
Setter for the hatch fill settings in selected mode.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| patternFillOrType | anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | string | boolean | false | PatternFill or HatchFill instance or type of hatch fill. |
| color | string | Color. | |
| thickness | number | Thickness. | |
| size | number | Pattern size. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
selectLabels
Getter for the current chart data labels in selected mode.
Returns:
anychart.core.ui.LabelsFactory - Labels instance.Try it:
Setter for the chart data labels in selected mode.
Detailed description
Sets chart labels settings depending on parameter type:
- null/boolean - disable or enable chart labels.
- object - sets chart labels settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | boolean | null | Chart data labels settings. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.selectMarkers
Getter for the current data markers in selected mode.
Returns:
anychart.core.ui.MarkersFactory - Markers instance.Try it:
Setter for data markers in selected mode.
Detailed description
Sets chart markers settings depending on parameter type:
- null/boolean - disable or enable chart markers.
- object - sets chart markers settings.
- string - sets chart markers type.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Object | boolean | null | string | false | Data markers settings. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.selectMarqueeFill
Getter for the select marquee fill.
Returns:
anychart.graphics.vector.Fill - Select marquee fill. See listing
var selectMarqueeFill = chart.selectMarqueeFill();
Setter for fill settings using an array or a string.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.graphics.vector.Fill | Color as an object or a string. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
Fill color with opacity. Fill as a string or an object.
Detailed description
Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which
means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.
Params:
| Name | Type | Description |
|---|---|---|
| color | string | Color as a string. |
| opacity | number | Color opacity. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
Linear gradient fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| keys | Array.<(anychart.graphics.vector.GradientKey|string)> | Gradient keys. |
| angle | number | Gradient angle. |
| mode | boolean | anychart.graphics.vector.Rect | Object | Gradient mode. |
| opacity | number | Gradient opacity. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
Radial gradient fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| keys | Array.<(anychart.graphics.vector.GradientKey|string)> | Color-stop gradient keys. |
| cx | number | X ratio of center radial gradient. |
| cy | number | Y ratio of center radial gradient. |
| mode | anychart.graphics.math.Rect | If defined then userSpaceOnUse mode, else objectBoundingBox. |
| opacity | number | Opacity of the gradient. |
| fx | number | X ratio of focal point. |
| fy | number | Y ratio of focal point. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
Image fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
selectMarqueeStroke
Getter for the select marquee stroke.
Returns:
anychart.graphics.vector.Stroke - Select marquee stroke. See listing.
var selectMarqueeStroke = chart.selectMarqueeStroke();
Setter for the select marquee stroke.
Learn more about stroke settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| color | anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null | Stroke settings. | |
| thickness | number | 1 | Line thickness. |
| dashpattern | string | Controls the pattern of dashes and gaps used to stroke paths. | |
| lineJoin | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
| lineCap | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
selectStroke
Getter for the current stroke in selected mode.
Returns:
anychart.graphics.vector.Stroke | function - Current stroke in the normal state.Try it:
Setter for the stroke in selected mode using function.
Learn more about stroke settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | anychart.graphics.vector.Stroke | function | // return stroke from the default palette.
function() {
return anychart.color.darken(this.sourceColor);
}; | Stroke-function, which should look like:function() {
// this: {
// index : number - the index of the current point
// sourceColor : anychart.graphics.vector.Stroke - stroke of the current point
// }
return myStroke; //anychart.graphics.vector.Stroke
};. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
Setter for the stroke in selected mode.
Learn more about stroke settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| color | anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null | Stroke settings. | |
| thickness | number | 1 | Line thickness. |
| dashpattern | string | Controls the pattern of dashes and gaps used to stroke paths. | |
| lineJoin | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
| lineCap | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
startSelectMarquee
Starts select marquee drawing.
Note: Works only after anychart.core.Chart#draw is called.
Params:
| Name | Type | Description |
|---|---|---|
| repeat | boolean | Whether to start select marquee drawing. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
stroke
Getter for the stroke settings.
Returns:
anychart.graphics.vector.Stroke | function - The current stroke settings.Try it:
Setter for the stroke using function.
Learn more about stroke settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | function | // return stroke from the default palette.
function() {
return anychart.color.darken(this.sourceColor);
}; | Stroke-function, which should look like:function() {
// this: {
// index : number - the index of the current point
// sourceColor : anychart.graphics.vector.Stroke - stroke of the current point
// }
return myStroke; //anychart.graphics.vector.Stroke
};. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
Setter for the stroke settings.
Learn more about stroke settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| color | anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null | Stroke settings. | |
| thickness | number | 1 | Line thickness. |
| dashpattern | string | Controls the pattern of dashes and gaps used to stroke paths. | |
| lineJoin | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
| lineCap | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
title
Setter for the chart title.
Detailed description
Sets chart title settings depending on parameter type:
- null/boolean - disable or enable chart title.
- string - sets chart title text value.
- object - sets chart title settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | null | boolean | Object | string | false | Chart title text or title instance for copy settings from. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.toCsv
Returns CSV string with series data.
Params:
| Name | Type | Description |
|---|---|---|
| chartDataExportMode | string | anychart.enums.ChartDataExportMode | Data export mode. |
| csvSettings | Object.<string, (string|boolean|undefined)> | CSV settings. |
Returns:
string - CSV string.Try it:
toJson
Return chart configuration as JSON object or string.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| stringify | boolean | false | Returns JSON as string. |
| includeTheme | boolean | false | If the current theme properties should be included into the result. |
Returns:
Object | string - Chart configuration.toSvg
Returns SVG string with paper size and landscape.
Detailed description
Returns SVG string if type of content is SVG otherwise returns empty string.
Params:
| Name | Type | Description |
|---|---|---|
| paperSize | string | Object | Paper Size or object of options. |
| landscape | boolean | Landscape. |
Returns:
string - SVG content or empty string.Try it:
Returns SVG string with with determined the width and height.
Detailed description
Returns SVG string if type of content is SVG otherwise returns empty string.
Params:
| Name | Type | Description |
|---|---|---|
| width | number | Image width. |
| height | number | Image height. |
Returns:
string - SVG content or empty string.Try it:
toXml
Return chart configuration as XML string or XMLNode.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| asXmlNode | boolean | false | Return XML as XMLNode. |
| includeTheme | boolean | false | If the current theme properties should be included into the result. |
Returns:
string | Node - Chart configuration.tooltip
Getter for current chart tooltip.
Returns:
anychart.core.ui.Tooltip - An instance of the class for method chaining. Example
var tooltipSettings = chart.tooltip();
Setter for chart tooltip.
Detailed description
Sets tooltip settings depending on parameter type:
- null/boolean - disable or enable tooltip.
- object - sets tooltip settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | boolean | null |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.top
Getter for element top bound setting.
Returns:
number | string | undefined - Current element's top bound setting.Sets element top bound setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Top bound setting for the element. |
Returns:
anychart.charts.HeatMap - Returns self for method chaining.Try it:
unlisten
Removes a listener added using listen() or listenOnce() methods.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| type | string | The event type id. | |
| listener | function | Callback method. | |
| useCapture | boolean | false | Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing |
| listenerScope | Object | Object in whose scope to call the listener. |
Returns:
boolean - Whether any listener was removed.Try it:
unlistenByKey
Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().
Params:
| Name | Type | Description |
|---|---|---|
| key | Object | The key returned by listen() or listenOnce(). |
Returns:
boolean - Whether any listener was removed.Try it:
width
Getter for element width setting.
Returns:
number | string | undefined - Current element's width setting.Sets element width setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Width setting for the element. |
Returns:
anychart.charts.HeatMap - Returns self for method chaining.Try it:
xAxis
Getter for the current chart X-axis.
Params:
| Name | Type | Description |
|---|---|---|
| index | number | Chart axis index. |
Returns:
anychart.core.axes.Linear - Axis instance by index.Try it:
Setter for the chart X-axis.
Detailed description
You can use multiple axes for a chart.
Sets chart X-axis settings depending on parameter type:
- null/boolean - disable or enable chart X-axis.
- object - sets chart X-axis settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Object | boolean | null | true | Chart axis settings to set. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Setter for the chart X-axis by index.
Detailed description
Sets chart X-axis settings by index depending on parameter type:
- null/boolean - disable or enable chart X-axis by index.
- object - sets chart X-axis settings by index.
Params:
| Name | Type | Description |
|---|---|---|
| index | number | Chart axis index. |
| value | Object | boolean | null | Chart axis settings to set. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.xScale
Getter for the current chart X scale.
Returns:
anychart.scales.Ordinal - The current chart scale value. See listing
var currentXScale = chart.xScale();
Setter for the chart X scale.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.enums.ScaleTypes | anychart.scales.Ordinal | X scale to set. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
xScroller
Getter for the current X scroller.
Returns:
anychart.core.ui.ChartScroller - Scroller instance.Try it:
Setter for the X scroller.
Detailed description
Sets chart X scroller settings depending on parameter type:
- null/boolean - disable or enable chart X scroller.
- object - sets chart X scroller settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | boolean | null | X scroller settings. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.xZoom
Setter for X Zoom settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | number | boolean | null | Object | Value to set. If you will pass null, true, false or number less than 1, then value will be converted in 1. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
yAxis
Getter for the current chart Y-axis.
Params:
| Name | Type | Description |
|---|---|---|
| index | number | Chart axis index. |
Returns:
anychart.core.axes.Linear - Axis instance by index.Try it:
Setter for the chart Y-axis.
Detailed description
You can use multiple axes for a chart.
Sets chart Y-axis settings depending on parameter type:
- null/boolean - disable or enable chart Y-axis.
- object - sets chart Y-axis settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | boolean | null | Chart axis settings to set. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Setter for the chart Y-axis by index.
Detailed description
Sets chart Y-axis settings by index depending on parameter type:
- null/boolean - disable or enable chart Y-axis by index.
- object - sets chart Y-axis settings by index.
Params:
| Name | Type | Description |
|---|---|---|
| index | number | Chart axis index. |
| value | Object | boolean | null | Chart axis settings to set. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.yScale
Getter for the current chart Y scale.
Returns:
anychart.scales.Ordinal - The current chart scale value. See listing
var currentYScale = chart.yScale();
Setter for the chart Y scale.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.enums.ScaleTypes | anychart.scales.Ordinal | Y Scale to set. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
yScroller
Getter for the current Y scroller.
Returns:
anychart.core.ui.ChartScroller - Scroller instance.Try it:
Setter for the Y scroller.
Detailed description
Sets chart Y scroller settings depending on parameter type:
- null/boolean - disable or enable chart Y scroller.
- object - sets chart Y scroller settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | boolean | null | Y scroller settings. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.yZoom
Setter for Y Zoom settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | number | boolean | null | Object | Value to set. If you will pass null, true, false or number less than 1, then value will be converted in 1. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it:
zIndex
Getter for the current Z-index of the element.
Returns:
number - The current zIndex.Try it:
Setter for the Z-index of the element.
Detailed description
The bigger the index - the higher the element position is.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | 0 | Value to set. |
Returns:
anychart.charts.HeatMap - Self instance for method chaining.Try it: