AnyChart
API Reference
Still have questions?
Contact support
Top

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.
xAxis()X-axis settings.
xGrid()Grid settings by X-scale.
xScale()X scale settings.
yAxis()Y-axis settings.
yGrid()Grid settings by X-scale.
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.
selectMarqueeFill()Select marquee fill settings.
selectMarqueeStroke()Stroke settings.
stroke()Stroke settings.
Data
data()Data settings.
getStat()Getter for a statistical value by the key.
noData()NoData settings.
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
exports()Exports settings
print()Prints all elements.
saveAsCsv()Saves chart data as a CSV file.
saveAsJson()Saves chart config as JSON document.
saveAsXlsx()Saves chart data as an Excel document.
saveAsXml()Saves chart config as XML document.
toCsv()Returns CSV string with the chart data.
Interactivity
hover()Hovers point by index.
hovered()Hovered state settings.
interactivity()Interactivity settings.
normal()Normal state settings.
select()Selects point by index.
selected()Selected state settings.
startSelectMarquee()Starts select marquee drawing.
tooltip()Tooltip settings.
xZoom()X Zoom settings.
yZoom()Y Zoom settings.
Point Elements
labels()Labels settings.
labelsDisplayMode()Labels display mode.
markers()Markers settings.
Size and Position
bottom()Bottom bound settings.
bounds()Bounds settings.
getPixelBounds()Returns pixel bounds.
height()Height settings.
left()Left bound settings.
margin()Margin settings.
maxHeight()Maximum height.
maxWidth()Maximum width.
minHeight()Minimum height.
minWidth()Minimum width.
padding()Padding settings.
right()Right bound settings.
top()Top bound settings.
width()Width settings.
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
autoRedraw()Redraw chart after changes or not.
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 animation settings.

Returns:

anychart.core.utils.Animation - Returns true if the animation is enabled.

Try it:

Setter for animation settings by one value.

Params:

Name Type Default Description
value boolean | Object
false
Whether to enable animation.

Returns:

anychart.core.Chart - Self instance for method chaining.
Setter for animation settings using several parameters.

Params:

Name Type Default Description
enabled boolean
false
Whether to enable animation.
duration number
1000
Duration in milliseconds.

Returns:

anychart.core.Chart - Self instance for method chaining.

Try it:

autoRedraw

Getter for the autoRedraw flag.
Flag whether to automatically call chart.draw() on any changes or not.

Returns:

boolean - AutoRedraw flag.
See listing
var autoRedraw = chart.autoRedraw();
Setter for the autoRedraw flag.
Flag whether to automatically call chart.draw() on any changes or not.

Params:

Name Type Default Description
value boolean
true
Value to set.

Returns:

anychart.core.Chart - Self instance for method chaining.

Try it:

background

Getter for the chart background.

Returns:

anychart.core.ui.Background - 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.core.Chart - Self instance for method chaining.

Try it:

bottom

Getter for element bottom bound settings.

Returns:

number string undefined - Element's bottom bound setting.
Setter for element bottom bound settings.

Params:

Name Type Default Description
value number | string | null
null
Bottom bound settings for the element.

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

bounds

Getter for element bounds settings.

Returns:

anychart.core.utils.Bounds - Bounds of the element.
Setter for 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.core.VisualBase - Self instance for method chaining.

Try it:

Setter for 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.core.VisualBase - Self instance for method chaining.

Try it:

cancelMarquee

Stops current marquee action if any.

Returns:

anychart.core.Chart - Self instance for method chaining.

colorScale

Getter for the current color scale.

Returns:

anychart.scales.OrdinalColor - Color scale instance.
See listing
var colorScale = chart.colorScale();
Setter for the color scale.

Params:

Name Type Description
value anychart.scales.OrdinalColor | Object | anychart.enums.ScaleTypes | string 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.

Params:

Name Type Description
value anychart.graphics.vector.Layer | anychart.graphics.vector.Stage | string | Element The value to set.

Returns:

anychart.core.Chart - 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 context menu.

Returns:

anychart.ui.ContextMenu - Context menu.

Try it:

Setter for the context menu.

Params:

Name Type Description
value Object | boolean | null Context menu settings

Returns:

anychart.core.Chart - Self instance for method chaining.

credits

Getter for the credits.

Returns:

anychart.core.ui.ChartCredits - Chart credits.

Try it:

Setter for the chart credits. Learn more about credits settings.

Params:

Name Type Default Description
value Object | boolean | null
true
Credits settings

Returns:

anychart.core.Chart - An instance of the class for method chaining.

data

Getter for the current chart data.

Returns:

anychart.data.View - Current data view.

Try it:

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 | string | 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.core.Chart - Self instance for method chaining.

exports

Getter for the export charts.

Returns:

anychart.core.utils.Exports - Exports settings.
See listing
var exports = chart.exports();
Setter for the export charts.

Params:

Name Type Description
value Object Export settings.

Returns:

anychart.core.Chart - Self instance for method chaining.

Try it:

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.

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.
Sets fill settings 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 with opacity. Fill as a string or an object.

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:

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 anychart.enums.Statistics | string Key.

Returns:

* - Statistics value.

Try it:

globalToLocal

Converts the global coordinates to local coordinates. Note: Works only after anychart.core.Chart#draw is called.

Params:

Name Type Description
xCoord number Global X coordinate.
yCoord number Global Y coordinate.

Returns:

Object.<string, number> - Object with XY coordinates.

Try it:

hatchFill

Getter for the current hatch fill settings.

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 settings.

Returns:

number string undefined - Element's height setting.
Setter for element height setting.

Params:

Name Type Default Description
value number | string | null
null
Height settings for the element.

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

hover

Hovers point by index. Note: Works only after anychart.charts.HeatMap#draw is called.

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:

hovered

Getter for hovered state settings.

Returns:

anychart.core.StateSettings - Hovered state settings

Try it:

Setter for hovered state settings.

Params:

Name Type Description
value Object State settings to set.

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

Getter for interactivity settings for the chart.

Returns:

anychart.core.utils.Interactivity - Interactivity settings.
Setter for interactivity settings for the chart.

Params:

Name Type Description
value Object | anychart.enums.HoverMode | string Settings object or boolean value like enabled state.

Returns:

anychart.core.SeparateChart - Self instance for method chaining.

Try it:

label

Getter for the chart label.

Params:

Name Type Default Description
index string | number
0
Index of instance.

Returns:

anychart.core.ui.Label - Label instance.

Try it:

Setter for the chart label.

Params:

Name Type Default Description
value null | boolean | Object | string
false
Chart label instance to add by index 0.

Returns:

anychart.core.Chart - Self instance for method chaining.
Setter for the chart label.

Params:

Name Type Default Description
index string | number
Label index.
value null | boolean | Object | string
false
Chart label settings.

Returns:

anychart.core.Chart - 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.

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:

anychart.enums.LabelsDisplayMode string - The current mode.

Try it:

Setter for the labels display mode.

Params:

Name Type Default Description
value anychart.enums.LabelsDisplayMode | string
"drop"
Mode to set.

Returns:

anychart.charts.HeatMap - Self instance for method chaining.

Try it:

left

Getter for element left bound settings.

Returns:

number string undefined - Element's left bound setting.
Setter for element left bound settings.

Params:

Name Type Default Description
value number | string | null
null
Left bound setting for the element.

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

legend

Getter for the chart legend.

Returns:

anychart.core.ui.Legend - Legend instance.

Try it:

Setter for chart legend settings.

Params:

Name Type Default Description
value Object | boolean | null
false
Legend settings.

Returns:

anychart.core.Chart - An instance of the class for method chaining.

listen

Adds an event listener to an implementing object.

Params:

Name Type Default Description
type string
The event type id.
listener function(Object e)
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.

Params:

Name Type Default Description
type string
The event type id.
listener function(Object e)
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.

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

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.core.Chart - 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.core.Chart - 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.

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 the maximum height.

Returns:

number string null - Element's maximum height.
Setter for the maximum height.

Params:

Name Type Default Description
value number | string | null
null
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

maxWidth

Getter for the maximum width.

Returns:

number string null - Element's maximum width.
Setter for the maximum width.

Params:

Name Type Default Description
value number | string | null
null
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

minHeight

Getter for the minimum height.

Returns:

number string null - Element's minimum height.
Setter for the minimum height.

Params:

Name Type Default Description
value number | string | null
null
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

minWidth

Getter for the minimum width.

Returns:

number string null - Element's minimum width.
Setter for the minimum width.

Params:

Name Type Default Description
value number | string | null
null
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

noData

Getter for noData settings.

Returns:

anychart.core.NoDataSettings - NoData settings.

Try it:

Setter for noData settings.
Learn more about "No data" feature

Params:

Name Type Description
value Object NoData settings.

Returns:

anychart.core.Chart - Self instance for method chaining.

Try it:

normal

Getter for normal state settings.

Returns:

anychart.core.StateSettings - Normal state settings.

Try it:

Setter for normal state settings.

Params:

Name Type Description
value Object State settings to set.

Returns:

anychart.charts.HeatMap - Self instance for method chaining.

Try it:

padding

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.core.Chart - 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.core.Chart - 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:

print

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:

Getter for element right bound settings.

Returns:

number string undefined - Element's right bound setting.
Setter for element right bound setting.

Params:

Name Type Default Description
value number | string | null
null
Right bound setting for the element.

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

saveAsCsv

Saves chart data as a CSV file.

Params:

Name Type Description
chartDataExportMode anychart.enums.ChartDataExportMode | string 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
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 an Excel document.

Params:

Name Type Description
chartDataExportMode anychart.enums.ChartDataExportMode | string Data export mode.
filename string File name to save.

Try it:

saveAsXml

Saves chart config as XML document.

Params:

Name Type Description
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:

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.core.Chart - Self instance for method chaining.
Fill color with opacity. Fill as a string or an object.

Params:

Name Type Description
color string Color as a string.
opacity number Color opacity.

Returns:

anychart.core.Chart - 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.core.Chart - 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.core.Chart - Self instance for method chaining.

Try it:

Params:

Name Type Description
imageSettings anychart.graphics.vector.Fill Object with settings.

Returns:

anychart.core.Chart - 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 string | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCap string | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.core.Chart - Self instance for method chaining.

Try it:

selected

Getter for selected state settings.

Returns:

anychart.core.StateSettings - Selected state settings

Try it:

Setter for selected state settings.

Params:

Name Type Description
value Object State settings to set.

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.core.Chart - 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 string | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCap string | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.charts.HeatMap - Self instance for method chaining.

Try it:

title

Getter for the chart title.

Returns:

anychart.core.ui.Title - Chart title.

Try it:

Setter for the chart title.

Params:

Name Type Default Description
value null | boolean | Object | string
false
Chart title text or title instance for copy settings from.

Returns:

anychart.core.Chart - Self instance for method chaining.

toCsv

Returns CSV string with the chart data.

Params:

Name Type Description
chartDataExportMode anychart.enums.ChartDataExportMode | string Data export mode.
csvSettings Object.<string, (string|boolean|undefined|function(* name,* value)|Object)> CSV settings. CSV settings object: rowsSeparator - string or undefined (default is '\n') columnsSeparator - string or undefined (default is ',') ignoreFirstRow - boolean or undefined (default is 'false') formats - a function with two arguments such as the field name and value, that returns the formatted value, the object with the key as the field name, and the value as a format function. Default is 'undefined'.

Returns:

string - CSV string.

toJson

Return chart configuration as JSON object or string.

Params:

Name Type Default Description
stringify boolean
false
Returns JSON as string.

Returns:

Object string - Chart configuration.

toSvg

Returns SVG string with paper size and landscape.

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.

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.

Returns:

string Node - Chart configuration.

tooltip

Getter for the chart tooltip.

Returns:

anychart.core.ui.Tooltip - Tooltip instance.
Example
var tooltipSettings = chart.tooltip();
Setter for the chart tooltip.

Params:

Name Type Description
tooltipSettings Object | boolean | null Tooltip settings to set.

Returns:

anychart.core.Chart - Self instance for method chaining.

top

Getter for element top bound settings.

Returns:

number string undefined - Element's top bound setting.
Setter for element top bound settings.

Params:

Name Type Default Description
value number | string | null
null
Top bound setting for the element.

Returns:

anychart.core.VisualBaseWithBounds - 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 settings.

Returns:

number string undefined - Element's width setting.
Setter for element width setting.

Params:

Name Type Default Description
value number | string | null
null
Width settings for the element.

Returns:

anychart.core.VisualBaseWithBounds - 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.

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.

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.

xGrid

Getter for the chart grid by X-scale.

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 by X-scale.

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.

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.

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 Default Description
value anychart.enums.ScaleTypes | string | anychart.scales.Ordinal
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.

Params:

Name Type Description
value Object | boolean | null X scroller settings.

Returns:

anychart.charts.HeatMap - Self instance for method chaining.

xZoom

Getter for X Zoom settings.

Returns:

anychart.core.utils.OrdinalZoom - X Zoom settings.

Try it:

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.

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.

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.

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.

yGrid

Getter for the chart grid by X-scale.

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 by X-scale.

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.

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.

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 Default Description
value anychart.enums.ScaleTypes | string | anychart.scales.Ordinal
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.

Params:

Name Type Description
value Object | boolean | null Y scroller settings.

Returns:

anychart.charts.HeatMap - Self instance for method chaining.

yZoom

Getter for Y Zoom settings.

Returns:

anychart.core.utils.OrdinalZoom - Y Zoom settings.

Try it:

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.

zIndex

Getter for the Z-index of the element.

Returns:

number - Z-index.

Try it:

Setter for the Z-index of the element.

Params:

Name Type Default Description
value number
0
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it: