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
a11y()Accessibility setting.
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 Y-scale.
yScale()Y scale settings.
Chart Coloring
animation()Animation settings
background()Background settings.
dataArea()Data area 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.
shareWithFacebook()Opens Facebook sharing dialog.
shareWithLinkedIn()Opens LinkedIn sharing dialog.
shareWithPinterest()Opens Pinterest sharing dialog.
shareWithTwitter()Opens Twitter sharing dialog.
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.
unhover()Removes hover from all chart points.
unselect()Deselects all points or points by index.
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.
fullScreen()Fullscreen mode.
id()Chart id.
inMarquee()Gets marquee process running value.
isFullScreenAvailable()Whether the fullscreen mode available in the browser or not.
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

a11y

Getter for the accessibility setting.

Returns:

anychart.core.utils.ChartA11y - Accessibility settings object.
See listing.
var stateOfAccsessibility = chart.a11y();
Setter for the accessibility setting.

Params:

NameTypeDescription
settingsboolean | ObjectWhether to enable accessibility or object with settings.

Returns:

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

animation

Getter for animation settings.

Returns:

anychart.core.utils.Animation - Returns true if the animation is enabled.
Setter for animation settings by one value.

Params:

NameTypeDefaultDescription
settingsboolean | Object
false
Whether to enable animation.

Returns:

anychart.charts.HeatMap - Self instance for method chaining.
Setter for animation settings using several parameters.

Params:

NameTypeDefaultDescription
enabledboolean
false
Whether to enable animation.
durationnumber
1000
Duration in milliseconds.

Returns:

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

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:

NameTypeDefaultDescription
enabledboolean
true
Value to set.

Returns:

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

background

Getter for the chart background.

Returns:

anychart.core.ui.Background - Chart background.
Setter for the chart background.

Params:

NameTypeDefaultDescription
settingsObject
{enabled: true, fill: "#fff", stroke: 'none', zIndex: 1}
Background object to set.

Returns:

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

bottom

Getter for element bottom bound settings.

Returns:

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

Params:

NameTypeDefaultDescription
bottomnumber | string | null
null
Bottom bound settings for the element.

Returns:

anychart.charts.HeatMap - Returns self for method chaining.

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:

NameTypeDescription
boundsanychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.BoundsBounds of element.

Returns:

anychart.charts.HeatMap - Self instance for method chaining.
Setter for element bounds settings.

Params:

NameTypeDefaultDescription
xnumber | string
null
X-coordinate.
ynumber | string
null
Y-coordinate.
widthnumber | string
null
Width.
heightnumber | string
null
Height.

Returns:

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

cancelMarquee

Stops current marquee action if any.

Returns:

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

colorScale

Getter for the color scale.

Returns:

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

Params:

NameTypeDescription
settingsanychart.scales.OrdinalColor | Object | anychart.enums.ScaleTypes | stringValue to set.

Returns:

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

container

Getter for the element's container.
Setter for the element's container.

Params:

NameTypeDescription
elementanychart.graphics.vector.Layer | anychart.graphics.vector.Stage | string | ElementContainer 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() );

contextMenu

Getter for the context menu.

Returns:

anychart.ui.ContextMenu - Context menu.
Setter for the context menu.

Params:

NameTypeDescription
settingsObject | boolean | nullContext menu settings

Returns:

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

credits

Getter for the credits.

Returns:

anychart.core.ui.ChartCredits - Chart credits.
Setter for the chart credits. Learn more about credits settings.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
true
Credits settings

Returns:

anychart.charts.HeatMap - An instance of the class for method chaining.

data

Getter for the chart data.

Returns:

anychart.data.View - Data view.
Setter for the chart data.

Params:

NameTypeDescription
dataanychart.data.View | anychart.data.Set | Array | string | anychart.data.DataSettingsValue to set.
csvSettingsanychart.enums.TextParsingMode | string | anychart.data.TextParsingSettingsIf 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.

dataArea

Getter for the data area settings.

Returns:

anychart.core.ui.DataArea - Data area settings.
Setter for the data area settings.
The data area is drawn along the data bounds.

Params:

NameTypeDescription
settingsObject | booleanData area settings to set.

Returns:

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

draw

Starts the rendering of the chart into the container.

Params:

NameTypeDescription
asyncbooleanWhether do draw asynchronously. If set to true, the chart will be drawn asynchronously.

Returns:

anychart.charts.HeatMap - 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:

NameTypeDescription
settingsObjectExport settings.

Returns:

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

fill

Getter for the fill color.

Returns:

anychart.graphics.vector.Fill | function - Fill settings.
Setter for fill settings using an array, an object or a string. Learn more about coloring.

Params:

NameTypeDescription
coloranychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)>Color as an array, an object or a string.

Returns:

anychart.charts.HeatMap - Self instance for method chaining.
Setter for fill settings using function.

Params:

NameTypeDefaultDescription
fillFunctionfunction():anychart.graphics.vector.Fill
function
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.
Fill color with opacity.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity (0 to 1).

Returns:

anychart.charts.HeatMap - Self instance for method chaining.
Linear gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.charts.HeatMap - Self instance for method chaining.
Radial gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

anychart.charts.HeatMap - Self instance for method chaining.
Image fill. Learn more about coloring.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

fullScreen

Getter for the fullscreen mode.

Returns:

boolean - Full screen state (enabled/disabled).
See listing
var fullScreen = chart.fullScreen();
Setter for the fullscreen mode.

Params:

NameTypeDefaultDescription
enabledboolean
false
Enable/Disable fullscreen mode.

Returns:

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

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:

NameTypeDescription
keyanychart.enums.Statistics | stringKey.

Returns:

* - Statistics value.

globalToLocal

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

Params:

NameTypeDescription
xCoordnumberGlobal X coordinate.
yCoordnumberGlobal Y coordinate.

Returns:

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

hatchFill

Getter for the hatch fill settings.
Setter for the hatch fill settings.

Params:

NameTypeDefaultDescription
typeanychart.graphics.vector.HatchFill.HatchFillType | string
false
Type of the hatch fill.
colorstring
Color.
thicknessnumber
Thickness.
sizenumber
Pattern size.

Returns:

anychart.charts.HeatMap - Self instance for method chaining.
Setter for hatch fill settings using function. Learn more about coloring.

Params:

NameTypeDescription
hatchFillFunctionfunctionHatchFill function.

Returns:

anychart.charts.HeatMap - Self instance for method chaining.
Setter for hatch fill settings using pattern fill. Learn more about coloring.

Params:

NameTypeDescription
patternFillanychart.graphics.vector.PatternFillPattern fill to set.

Returns:

anychart.charts.HeatMap - Self instance for method chaining.
Setter for hatch fill settings using an instance. Learn more about coloring.

Params:

NameTypeDescription
settingsanychart.graphics.vector.HatchFillHatch fill instance.

Returns:

anychart.charts.HeatMap - Self instance for method chaining.
Setter for hatch fill using boolean. Learn more about hatch fill settings.

Params:

NameTypeDefaultDescription
enabledboolean
false
Whether to enable hatch fill or no.

Returns:

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

height

Getter for element height settings.

Returns:

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

Params:

NameTypeDefaultDescription
heightnumber | string | null
null
Height settings for the element.

Returns:

anychart.charts.HeatMap - Returns self for method chaining.

hover

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

Params:

NameTypeDescription
indexOrIndexesnumber | Array.<number>Point index or array of indexes.

Returns:

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

hovered

Getter for hovered state settings.

Returns:

anychart.core.StateSettings - Hovered state settings
Setter for hovered state settings.

Params:

NameTypeDescription
settingsObjectState settings to set.

Returns:

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

id

Getter for chart id.

Returns:

string - Return chart id.
Setter for chart id.

Params:

NameTypeDescription
idstringChart id.

Returns:

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

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:

NameTypeDescription
settingsObject | anychart.enums.HoverMode | stringSettings object or boolean value like enabled state.

Returns:

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

isFullScreenAvailable

Whether the fullscreen mode available in the browser or not.

Returns:

boolean - isFullScreenAvailable state.

label

Getter for the chart label.

Params:

NameTypeDefaultDescription
indexstring | number
0
Index of instance.

Returns:

anychart.core.ui.Label - Label instance.
Setter for the chart label.

Params:

NameTypeDefaultDescription
settingsnull | boolean | Object | string
false
Chart label instance to add by index 0.

Returns:

anychart.charts.HeatMap - Self instance for method chaining.
Setter for the chart label.

Params:

NameTypeDefaultDescription
indexstring | number
Label index.
settingsnull | boolean | Object | string
false
Chart label settings.

Returns:

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

labels

Getter for the chart data labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.
Setter for the chart data labels.

Params:

NameTypeDescription
settingsObject | boolean | nullChart data labels settings.

Returns:

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

labelsDisplayMode

Getter for the labels display mode.

Returns:

anychart.enums.LabelsDisplayMode | string - Labels display mode.
Setter for the labels display mode.

Params:

NameTypeDefaultDescription
modeanychart.enums.LabelsDisplayMode | string
'drop'
Mode to set.

Returns:

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

left

Getter for element left bound settings.

Returns:

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

Params:

NameTypeDefaultDescription
leftnumber | string | null
null
Left bound setting for the element.

Returns:

anychart.charts.HeatMap - Returns self for method chaining.

legend

Getter for the chart legend.

Returns:

anychart.core.ui.Legend - Legend instance.
Setter for chart legend settings.

Params:

NameTypeDefaultDescription
settingsObject | 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.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
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
}
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

localToGlobal

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

Params:

NameTypeDescription
xCoordnumberLocal X coordinate.
yCoordnumberLocal Y coordinate.

Returns:

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

margin

Setter for the chart margin in pixels using a single complex object.

Params:

NameTypeDefaultDescription
marginArray.<(number|string)> | Object
{top: 0, right: 0, bottom: 0, left: 0}
Margin 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));
Setter for the chart margin in pixels using several simple values.

Params:

NameTypeDefaultDescription
value1string | number
0
Top or top-bottom space.
value2string | number
0
Right or right-left space.
value3string | number
0
Bottom space.
value4string | 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);

markers

Getter for the data markers.

Returns:

anychart.core.ui.MarkersFactory - Markers instance.
Setter for data markers.

Params:

NameTypeDefaultDescription
settingsObject | 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:

NameTypeDefaultDescription
heightnumber | string | null
null
Maximum height to set.

Returns:

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

maxWidth

Getter for the maximum width.

Returns:

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

Params:

NameTypeDefaultDescription
widthnumber | string | null
null
Maximum width to set.

Returns:

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

minHeight

Getter for the minimum height.

Returns:

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

Params:

NameTypeDefaultDescription
heightnumber | string | null
null
Minimum height to set.

Returns:

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

minWidth

Getter for the minimum width.

Returns:

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

Params:

NameTypeDefaultDescription
widthnumber | string | null
null
Minimum width to set.

Returns:

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

noData

Getter for noData settings.

Returns:

anychart.core.NoDataSettings - NoData settings.
Setter for noData settings.
Learn more about "No data" feature

Params:

NameTypeDescription
settingsObjectNoData settings.

Returns:

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

normal

Getter for normal state settings.

Returns:

anychart.core.StateSettings - Normal state settings.
Setter for normal state settings.

Params:

NameTypeDescription
settingsObjectState settings to set.

Returns:

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

padding

Setter for the chart paddings in pixels using a single value.

Params:

NameTypeDefaultDescription
paddingArray.<(number|string)> | Object
{top: 0, right: 0, bottom: 0, left: 0}
Padding 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%"}});
Setter for the chart paddings in pixels using several numbers.

Params:

NameTypeDefaultDescription
value1string | number
0
Top or top-bottom space.
value2string | number
0
Right or right-left space.
value3string | number
0
Bottom space.
value4string | 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);

print

Prints all elements on related stage.

Params:

NameTypeDefaultDescription
paperSizeOrOptionsanychart.graphics.vector.PaperSize | Object
Paper size or object with options.
landscapeboolean
false
Flag of landscape.

removeAllListeners

Removes all listeners from an object. You can also optionally remove listeners of some particular type.

Params:

NameTypeDescription
typestringType of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.
Getter for element right bound settings.

Returns:

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

Params:

NameTypeDefaultDescription
rightnumber | string | null
null
Right bound setting for the element.

Returns:

anychart.charts.HeatMap - Returns self for method chaining.

saveAsCsv

Saves chart data as a CSV file.

Params:

NameTypeDescription
chartDataExportModeanychart.enums.ChartDataExportMode | stringData export mode.
csvSettingsObject.<string, (string|boolean|undefined|function(name:*, value:*))>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 -
1) a function with two arguments such as the field name and value, that returns the formatted value
or
2) the object with the key as the field name, and the value as a format function.
(default is 'undefined').
filenamestringFile name to save.

saveAsJpg

Saves the current chart as JPEG image.

Params:

NameTypeDescription
widthnumber | ObjectImage width or object with options.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.
forceTransparentWhitebooleanForce transparent to white or not.
filenamestringFile name to save.

saveAsJson

Saves chart config as JSON document.

Params:

NameTypeDescription
filenamestringFile name to save.

saveAsPdf

Saves the current chart as PDF image.

Params:

NameTypeDescription
paperSizeOrWidthOrOptionsnumber | string | ObjectAny paper format like 'a0', 'tabloid', 'b4', etc or width, or object with options.
landscapebooleanDefine, is landscape.
xnumberOffset X.
ynumberOffset Y.
filenamestringFile name to save.

saveAsPng

Saves the current chart as PNG image.

Params:

NameTypeDescription
widthnumber | ObjectImage width or object with options.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.
filenamestringFile name to save.

saveAsSvg

Saves the current chart as SVG image.

Params:

NameTypeDescription
paperSizestring | ObjectPaper Size or object with options.
landscapebooleanLandscape.
filenamestringFile name to save.
Saves the stage as SVG image using width and height.

Params:

NameTypeDescription
widthnumberImage width.
heightnumberImage height.

saveAsXlsx

Saves chart data as an Excel document.

Params:

NameTypeDescription
chartDataExportModeanychart.enums.ChartDataExportMode | stringData export mode.
filenamestringFile name to save.

saveAsXml

Saves chart config as XML document.

Params:

NameTypeDescription
filenamestringFile name to save.

select

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

Params:

NameTypeDescription
indexnumberIndex of the point to select

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, an object or a string. Learn more about coloring.

Params:

NameTypeDescription
coloranychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)>Color as an object, an array or a string.

Returns:

anychart.charts.HeatMap - Self instance for method chaining.
Fill color with opacity. Fill as a string or an object.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.charts.HeatMap - Self instance for method chaining.
Linear gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.charts.HeatMap - Self instance for method chaining.
Radial gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

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

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

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:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
Stroke settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

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

selected

Getter for selected state settings.

Returns:

anychart.core.StateSettings - Selected state settings
Setter for selected state settings.

Params:

NameTypeDescription
settingsObjectState settings to set.

Returns:

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

shareWithFacebook

Opens Facebook sharing dialog.

Params:

NameTypeDescription
captionOrOptionsstring | ObjectCaption for the main link or object with options.
linkstringThe URL is attached to the publication.
namestringThe title for the attached link.
descriptionstringDescription for the attached link.

shareWithLinkedIn

Opens LinkedIn sharing dialog.

Params:

NameTypeDescription
captionOrOptionsstring | ObjectCaption for publication or object with options. If not set 'AnyChart' will be used.
descriptionstringDescription.

shareWithPinterest

Opens Pinterest sharing dialog.

Params:

NameTypeDescription
linkOrOptionsstring | ObjectAttached link or object with options. If not set, the image URL will be used.
descriptionstringDescription.

shareWithTwitter

Opens Twitter sharing dialog.

startSelectMarquee

Starts select marquee drawing. Note: Works only after anychart.core.Chart#draw is called.

Params:

NameTypeDescription
repeatbooleanWhether to start select marquee drawing.

Returns:

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

stroke

Setter for the stroke using function. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
valuefunction():anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFill
'1 #ffffff'
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 strokeValue; //anychart.graphics.vector.Stroke
};

Returns:

anychart.charts.HeatMap - Self instance for method chaining.
Setter for the stroke settings. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
'1 #ffffff'
Stroke settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.charts.HeatMap - Self instance for method chaining.
Setter for stroke settings using an object.

Params:

NameTypeDefaultDescription
settingsObject
'1 #ffffff'
Object with stroke settings from anychart.graphics.vector.Stroke

Returns:

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

title

Getter for the chart title.

Returns:

anychart.core.ui.Title - Chart title.
Setter for the chart title.

Params:

NameTypeDefaultDescription
settingsnull | 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 the chart data.

Params:

NameTypeDescription
chartDataExportModeanychart.enums.ChartDataExportMode | stringData export mode.
csvSettingsObject.<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 -
1) a function with two arguments such as the field name and value, that returns the formatted value
or
2) 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:

NameTypeDefaultDescription
stringifyboolean
false
Returns JSON as string.

Returns:

Object | string - Chart configuration.

toSvg

Returns SVG string with paper size and landscape.

Params:

NameTypeDescription
paperSizestring | ObjectPaper Size or object of options.
landscapebooleanLandscape.

Returns:

string - SVG content or empty string.
Returns SVG string with with determined the width and height.

Params:

NameTypeDescription
widthnumberImage width.
heightnumberImage height.

Returns:

string - SVG content or empty string.

toXml

Return chart configuration as XML string or XMLNode.

Params:

NameTypeDefaultDescription
asXmlNodeboolean
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:

NameTypeDescription
settingsObject | boolean | nullTooltip settings to set.

Returns:

anychart.charts.HeatMap - 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:

NameTypeDefaultDescription
topnumber | string | null
null
Top bound setting for the element.

Returns:

anychart.charts.HeatMap - Returns self for method chaining.

unhover

Removes hover from all chart points.

Returns:

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

unlisten

Removes a listener added using listen() or listenOnce() methods.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object):boolean|undefined
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

unlistenByKey

Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().

Params:

NameTypeDescription
keyObjectThe key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

unselect

Deselects all points or points by index.

Params:

NameTypeDescription
indexOrIndexesnumber | Array.<number>Index or array of indexes of the point to select.

width

Getter for element width settings.

Returns:

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

Params:

NameTypeDefaultDescription
widthnumber | string | null
null
Width settings for the element.

Returns:

anychart.charts.HeatMap - Returns self for method chaining.

xAxis

Getter for the chart X-axis.

Params:

NameTypeDescription
indexnumberChart axis index.

Returns:

anychart.core.axes.Linear - Axis instance by index.
Setter for the chart X-axis.

Params:

NameTypeDefaultDescription
settingsObject | 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:

NameTypeDescription
indexnumberChart axis index.
settingsObject | boolean | nullChart axis settings to set.

Returns:

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

xGrid

Getter for the chart grid by X-scale.

Params:

NameTypeDescription
indexnumberChart 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.
Setter for the chart grid by X-scale.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
false
Grid settings to set.

Returns:

anychart.charts.HeatMap - Self instance for method chaining.
Setter for the chart grid by index.

Params:

NameTypeDescription
indexnumberChart grid index.
settingsObject | boolean | nullGrid settings to set.

Returns:

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

xScale

Getter for the chart X scale.

Returns:

anychart.scales.Ordinal - Chart scale.
See listing
var xScale = chart.xScale();
Setter for the chart X scale.

Params:

NameTypeDefaultDescription
settingsanychart.enums.ScaleTypes | string | anychart.scales.Ordinal
anychart.scales.Ordinal
X scale to set.

Returns:

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

xScroller

Getter for the X scroller.

Returns:

anychart.core.ui.ChartScroller - Scroller instance.
Setter for the X scroller.

Params:

NameTypeDescription
settingsObject | boolean | nullX 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.
Setter for X Zoom settings.

Params:

NameTypeDescription
settingsnumber | boolean | null | ObjectValue 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 chart Y-axis.

Params:

NameTypeDescription
indexnumberChart axis index.

Returns:

anychart.core.axes.Linear - Axis instance by index.
Setter for the chart Y-axis.

Params:

NameTypeDescription
settingsObject | boolean | nullChart axis settings to set.

Returns:

anychart.charts.HeatMap - Self instance for method chaining.
Setter for the chart Y-axis by index.

Params:

NameTypeDescription
indexnumberChart axis index.
settingsObject | boolean | nullChart axis settings to set.

Returns:

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

yGrid

Getter for the chart grid by Y-scale.

Params:

NameTypeDescription
indexnumberChart 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.
Setter for the chart grid by Y-scale.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
false
Grid settings to set.

Returns:

anychart.charts.HeatMap - Self instance for method chaining.
Setter for the chart grid by index.

Params:

NameTypeDescription
indexnumberChart grid index.
settingsObject | boolean | nullGrid settings to set.

Returns:

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

yScale

Getter for the chart Y scale.

Returns:

anychart.scales.Ordinal - Chart scale value.
See listing
var yScale = chart.yScale();
Setter for the chart Y scale.

Params:

NameTypeDefaultDescription
settingsanychart.enums.ScaleTypes | string | anychart.scales.Ordinal
anychart.scales.Ordinal
Y Scale to set.

Returns:

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

yScroller

Getter for the Y scroller.

Returns:

anychart.core.ui.ChartScroller - Scroller instance.
Setter for the Y scroller.

Params:

NameTypeDescription
settingsObject | boolean | nullY 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.
Setter for Y Zoom settings.

Params:

NameTypeDescription
settingsnumber | boolean | null | ObjectValue 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.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
zIndexnumber
0
Value to set.

Returns:

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