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. Learn more about HeatMap chart

Methods Overview

Specific settings
a11y()	Accessibility settings.
annotations()	Creates annotations.
getType()	Defines the chart type.
globalToLocal()	Converts the global coordinates to local coordinates.
localToGlobal()	Converts the local coordinates to global coordinates.
toA11yTable()	Creates and returns the chart represented as an invisible HTML table.
toHtmlTable()	Creates and returns a chart as HTML table.
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
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.
selectRectangleMarqueeFill()	Select marquee fill settings.
selectRectangleMarqueeStroke()	Stroke settings.
stroke()	Stroke settings.
Data
data()	Data settings.
getSelectedPoints()	Getter for the selected points.
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
getJpgBase64String()	Returns JPG as base64 string.
getPdfBase64String()	Returns PDF as base64 string.
getPngBase64String()	Returns PNG as base64 string.
getSvgBase64String()	Returns SVG as base64 string.
print()	Prints chart.
saveAsCsv()	Saves chart data as a CSV file.
saveAsJpg()	Saves the chart as JPEG image.
saveAsJson()	Saves chart config as JSON document.
saveAsPdf()	Saves the chart as PDF image.
saveAsPng()	Saves the chart as PNG image.
saveAsSvg()	Saves the chart as SVG image.
saveAsXlsx()	Saves chart data as an Excel document.
saveAsXml()	Saves chart config as XML document.
shareAsJpg()	Shares a chart as a JPG file and returns a link to the shared image.
shareAsPdf()	Shares a chart as a PDF file and returns a link to the shared image.
shareAsPng()	Shares a chart as a PNG file and returns a link to the shared image.
shareAsSvg()	Shares a chart as a SVG file and returns a link to the shared image.
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.
toSvg()	Returns SVG string.
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.
startSelectRectangleMarquee()	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 of the chart.
height()	Height setting.
left()	Left bound setting.
margin()	Margin settings.
maxHeight()	Maximum height setting.
maxWidth()	Maximum width setting.
minHeight()	Minimum height setting.
minWidth()	Minimum width setting.
padding()	Padding settings.
right()	Right bound settings.
top()	Top bound settings.
width()	Width setting.
zIndex()	Z-index of the chart.
XML/JSON
toJson()	Returns chart configuration as JSON object or string.
toXml()	Returns chart configuration as XML string or XMLNode.
Miscellaneous
autoRedraw()	Redraw chart after changes or not.
cancelMarquee()	Stops marquee action if any.
container()	Chart container
draw()	Chart drawing
fullScreen()	Fullscreen mode.
id()	Chart id.
inMarquee()	Gets marquee process running value.
isFullScreenAvailable()	Whether the fullscreen mode available in the browser or not.

Methods Description

a11y(settings)

Setter for the accessibility settings.

Detailed description

Params:

Name	Type	Description
settings	boolean \| Object	Whether to enable accessibility or object with settings.

Returns:

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

Try it:

annotations

annotations()

Getter for the annotations.

Returns:

anychart.core.annotations.PlotController - The plot annotations.

Try it:

Usage sample

annotations(annotationsList)

Setter for the annotations.

Params:

Name	Type	Description
annotationsList	Array	Annotations list to set.

Returns:

anychart.charts.HeatMap - Self instance for method chaining

Try it:

Usage sample

autoRedraw

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();

autoRedraw(enabled)

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

Params:

Name	Type	Default	Description
enabled	boolean	true	Value to set.

Returns:

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

Try it:

Usage sample

background

background()

Getter for the chart background.

Returns:

anychart.core.ui.Background - Chart background.

Try it:

Usage sample

background(settings)

Setter for the chart background settings.

Detailed description

Sets chart background settings depending on parameter type:

null/boolean - disable or enable chart background.
object - sets chart background settings.
string - sets chart background color.

Params:

Name	Type	Description
settings	string \| Object \| null \| boolean	Background settings to set.

Returns:

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

Try it:

bottom

bottom()

Getter for the chart's bottom bound setting.

Returns:

number | string | undefined - Chart's bottom bound settings.

See listing

var bottom = chart.bottom();

bottom(bottom)

Setter for the chart's top bound setting.

Params:

Name	Type	Description
bottom	number \| string \| null	Bottom bound for the chart.

Returns:

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

Try it:

Usage sample

bounds

bounds()

Getter for the chart bounds settings.

Returns:

anychart.core.utils.Bounds - Bounds of the element.

See listing

var bounds = chart.bounds();

bounds(bounds)

Setter for the chart bounds using one parameter.

Params:

Name	Type	Description
bounds	anychart.utils.RectObj \| anychart.math.Rect \| anychart.core.utils.Bounds	Bounds of teh chart.

Returns:

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

Try it:

Usage sample

bounds(x, y, width, height)

Setter for the chart 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:

Usage sample

cancelMarquee

cancelMarquee()

Stops marquee action if any.

Returns:

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

colorScale

colorScale()Since version 7.8.0

Getter for the color scale.

Returns:

anychart.scales.OrdinalColor - Color scale instance.

See listing

var colorScale = chart.colorScale();

colorScale(settings)Since version 7.8.0

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
settings	anychart.scales.OrdinalColor \| Object \| anychart.enums.ScaleTypes \| string	Value to set.

Returns:

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

Try it:

Usage sample

container

container()

Getter for the chart container.

Returns:

anychart.graphics.vector.Layer | anychart.graphics.vector.Stage - Chart container.

container(element)

Setter for the chart container.

Params:

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

Returns:

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

Try it:

Usage sample

contextMenu

contextMenu()

Getter for the context menu.

Returns:

anychart.ui.ContextMenu - Context menu.

Try it:

Usage sample

contextMenu(settings)

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
settings	Object \| boolean \| null	Context menu settings

Returns:

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

Try it:

credits

credits()

Getter for the credits.

Returns:

anychart.core.ui.ChartCredits - Chart credits.

Try it:

Usage sample

credits(settings)

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:

null/boolean - disable or enable chart credits.
object - sets chart credits settings.

Params:

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

Returns:

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

Try it:

data

data()Since version 7.8.0

Getter for the chart data.

Returns:

anychart.data.View - Data view.

Try it:

Usage sample

data(data, csvSettings)Since version 7.8.0

Setter for the chart data.

Params:

Name	Type	Description
data	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.

Try it:

dataArea

dataArea()Since version 8.3.0

Getter for the data area settings.

Returns:

anychart.core.ui.DataArea - Data area settings.

Try it:

Usage sample

dataArea(settings)Since version 8.3.0

Setter for the data area settings.
The data area is drawn along the data bounds.

Detailed description

Sets data area settings depending on parameter type:

boolean - disable or enable data area.
object - sets data area settings.

Params:

Name	Type	Description
settings	Object \| boolean	Data area settings to set.

Returns:

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

Try it:

draw

draw(async)

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.

Try it:

Usage sample

exports

exports()

Getter for the export charts.

Returns:

anychart.core.utils.Exports - Exports settings.

See listing

var exports = chart.exports();

exports(settings)

Setter for the export charts.

Detailed description

To work with exports you need to reference the exports module from AnyChart CDN (https://cdn.anychart.com/releases/8.13.0/js/anychart-exports.min.js for latest or https://cdn.anychart.com/releases/8.13.0/js/anychart-exports.min.js for the versioned file)

Params:

Name	Type	Description
settings	Object	Export settings.

Returns:

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

Try it:

Usage sample

fill

fill()Since version 7.8.0

Getter for the fill color.

Returns:

anychart.graphics.vector.Fill | function - Fill settings.

Try it:

Usage sample

fill(color)Since version 7.8.0

Setter for fill settings using an array, an object 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
color	anychart.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.

Try it:

fill(fillFunction)Since version 7.8.0

Setter for 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():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 }

Name

Type

Default

Description

fillFunction

function():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.

Try it:

Usage sample

fill(color, opacity)Since version 7.8.0

Fill color with opacity.

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 (0 to 1).

Returns:

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

Try it:

Usage sample

fill(keys, angle, mode, opacity)Since version 7.8.0

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:

Usage sample

fill(keys, cx, cy, mode, opacity, fx, fy)Since version 7.8.0

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:

Usage sample

fill(imageSettings)Since version 7.8.0

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:

Usage sample

fullScreen

fullScreen()

Getter for the fullscreen mode.

Returns:

boolean - Full screen state (enabled/disabled).

See listing

var fullScreen = chart.fullScreen();

fullScreen(enabled)

Setter for the fullscreen mode.

Params:

Name	Type	Default	Description
enabled	boolean	false	Enable/Disable fullscreen mode.

Returns:

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

Try it:

Usage sample

getJpgBase64String

getJpgBase64String(onSuccessOrOptions, onError, width, height, quality, forceTransparentWhite)

Returns JPG as base64 string.

Params:

Name	Type	Description
onSuccessOrOptions	function(response:string) \| Object	Function that is called when sharing is complete or object with options.
onError	function(response:string)	Function that is called if sharing fails.
width	number	Image width.
height	number	Image height.
quality	number	Image quality in ratio 0-1.
forceTransparentWhite	boolean	Force transparent to white or not.

Try it:

Usage sample

getPdfBase64String

getPdfBase64String(onSuccessOrOptions, onError, paperSizeOrWidth, landscapeOrWidth, x, y)

Returns PDF as base64 string.

Params:

Name	Type	Description
onSuccessOrOptions	function(response:string) \| Object	Function that is called when sharing is complete or object with options.
onError	function(response:string)	Function that is called if sharing fails.
paperSizeOrWidth	number \| string	Any paper format like 'a0', 'tabloid', 'b4', etc.
landscapeOrWidth	number \| boolean	Define, is landscape.
x	number	Offset X.
y	number	Offset Y.

Try it:

Usage sample

getPixelBounds

getPixelBounds()

Returns pixel bounds of the chart.
Returns pixel bounds of the chart due to parent bounds and self bounds settings.

Returns:

anychart.math.Rect - Pixel bounds of the chart.

Try it:

Usage sample

getPngBase64String

getPngBase64String(onSuccessOrOptions, onError, width, height, quality)

Returns PNG as base64 string.

Params:

Name	Type	Description
onSuccessOrOptions	function(response:string) \| Object	Function that is called when sharing is complete or object with options.
onError	function(response:string)	Function that is called if sharing fails.
width	number	Image width.
height	number	Image height.
quality	number	Image quality in ratio 0-1.

Try it:

Usage sample

getSelectedPoints

getSelectedPoints()

Getter for the selected points.

Returns:

Array.<anychart.core.Point> - An array of the selected points.

Try it:

Usage sample

getStat

getStat(key)

Getter for a statistical value by the key.

Params:

Name	Type	Description
key	anychart.enums.Statistics \| string	Key.

Returns:

* - Statistics value.

Try it:

Usage sample

getSvgBase64String

getSvgBase64String(onSuccessOrOptions, onError, paperSizeOrWidth, landscapeOrHeight)

Returns SVG as base64 string.

Params:

Name	Type	Description
onSuccessOrOptions	function(response:string) \| Object	Function that is called when sharing is complete or object with options.
onError	function(response:string)	Function that is called if sharing fails.
paperSizeOrWidth	string \| number	Paper Size or width.
landscapeOrHeight	boolean \| string	Landscape or height.

Try it:

Usage sample

getType

getType()

Returns chart type.

Returns:

string - Chart type.

Try it:

Usage sample

globalToLocal

globalToLocal(xCoord, yCoord)

Converts the global coordinates to local coordinates. Note: Works only after anychart.charts.HeatMap#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).

Params:

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

Returns:

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

Try it:

Usage sample

hatchFill

hatchFill()Since version 7.8.0

Getter for the hatch fill settings.

Returns:

anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - Chart hatch fill.

Try it:

Usage sample

hatchFill(type, color, thickness, size)Since version 7.8.0

Setter for the hatch fill settings.

Params:

Name	Type	Default	Description
type	anychart.graphics.vector.HatchFill.HatchFillType \| string	false	Type of the hatch fill.
color	string		Color.
thickness	number		Thickness.
size	number		Pattern size.

Returns:

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

Try it:

Usage sample

hatchFill(hatchFillFunction)Since version 7.8.0

Setter for hatch fill settings using function. Learn more about coloring.

Params:

Name	Type	Description
hatchFillFunction	function	HatchFill function.

Returns:

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

Try it:

Usage sample

hatchFill(patternFill)Since version 7.8.0

Setter for hatch fill settings using pattern fill. Learn more about coloring.

Params:

Name	Type	Description
patternFill	anychart.graphics.vector.PatternFill	Pattern fill to set.

Returns:

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

Try it:

Usage sample

hatchFill(settings)Since version 7.8.0

Setter for hatch fill settings using an instance. Learn more about coloring.

Params:

Name	Type	Description
settings	anychart.graphics.vector.HatchFill	Hatch fill instance.

Returns:

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

Try it:

Usage sample

hatchFill(enabled)Since version 7.8.0

Setter for hatch fill using boolean. Learn more about hatch fill settings.

Params:

Name	Type	Default	Description
enabled	boolean	false	Whether to enable hatch fill or no.

Returns:

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

Try it:

Usage sample

height

height()

Getter for the chart's height setting.

Returns:

number | string | undefined - Chart's height setting.

See listing

var height = chart.height();

height(height)

Setter for the chart's height setting.

Params:

Name	Type	Default	Description
height	number \| string \| null	null	Height settings for the chart.

Returns:

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

Try it:

Usage sample

hover

hover(indexOrIndexes)Since version 7.8.0

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:

Usage sample

hovered

hovered()Since version 8.0.0

Getter for hovered state settings.

Returns:

anychart.core.StateSettings - Hovered state settings

Try it:

Usage sample

hovered(settings)Since version 8.0.0

Setter for hovered state settings.

Params:

Name	Type	Description
settings	Object	State settings to set.

Returns:

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

Try it:

Usage sample

id

id()

Getter for chart id.

Returns:

string - Return chart id.

Try it:

Usage sample

id(id)

Setter for chart id.

Params:

Name	Type	Description
id	string	Chart id.

Returns:

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

Try it:

Usage sample

inMarquee

inMarquee()

Gets marquee process running value.

Returns:

boolean - Returns true if there is a marquee process running.

interactivity

interactivity()

Getter for the interactivity settings.

Returns:

anychart.core.utils.Interactivity - Interactivity settings.

Try it:

Usage sample

interactivity(settings)

Setter for the interactivity settings.

Params:

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

Returns:

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

Try it:

Usage sample

isFullScreenAvailable

isFullScreenAvailable()

Whether the fullscreen mode available in the browser or not.

Returns:

boolean - isFullScreenAvailable state.

Try it:

Usage sample

label

label(index)

Getter for the 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:

Usage sample

label(settings)

Setter for the 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
settings	null \| boolean \| Object \| string	false	Chart label instance to add by index 0.

Returns:

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

Try it:

label(index, settings)

Setter for chart label using index.

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	0	Label index.
settings	null \| boolean \| Object \| string	false	Chart label settings.

Returns:

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

Try it:

labels

labels()Since version 7.8.0

Getter for the chart data labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Usage sample

labels(settings)Since version 7.8.0

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
settings	Object \| boolean \| null	Chart data labels settings.

Returns:

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

Try it:

labelsDisplayMode

labelsDisplayMode()Since version 7.8.0

Getter for the labels display mode.

Returns:

anychart.enums.LabelsDisplayMode | string - Labels display mode.

Try it:

Usage sample

labelsDisplayMode(mode)Since version 7.8.0

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
mode	anychart.enums.LabelsDisplayMode \| string	'drop'	Mode to set.

Returns:

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

Try it:

Usage sample

left

left()

Getter for the chart's left bound setting.

Returns:

number | string | undefined - Chart's left bound setting.

See listing

var left = chart.left();

left(value)

Setter for the chart's left bound setting.

Params:

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

Returns:

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

Try it:

Usage sample

legend

legend()

Getter for the chart legend.

Returns:

anychart.core.ui.Legend - Legend instance.

Try it:

Usage sample

legend(settings)

Setter for the 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
settings	Object \| boolean \| null	false	Legend settings.

Returns:

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

Try it:

listen

listen(type, listener, useCapture, listenerScope)

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.

Params:

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

Usage sample

listenOnce

listenOnce(type, listener, useCapture, listenerScope)

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

Params:

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

Usage sample

localToGlobal

localToGlobal(xCoord, yCoord)

Converts the local coordinates to global coordinates. Note: Works only after anychart.charts.HeatMap#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).

Params:

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

Returns:

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

Try it:

Usage sample

margin

margin()

Getter for the 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:

Usage sample

margin(margin)

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

Params:

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

Usage sample

margin(value1, value2, value3, value4)

Setter for the chart margin in pixels using several simple values.

Params:

Name	Type	Description
value1	string \| number	Top or top-bottom space.
value2	string \| number	Right or right-left space.
value3	string \| number	Bottom space.
value4	string \| number	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:

Usage sample

markers

markers()Since version 7.8.0

Getter for the data markers.

Returns:

anychart.core.ui.MarkersFactory - Markers instance.

Try it:

Usage sample

markers(settings)Since version 7.8.0

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
settings	Object \| boolean \| null \| string	false	Data markers settings.

Returns:

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

Try it:

maxHeight

maxHeight()

Getter for the chart's maximum height.

Returns:

number | string | null - Chart's maximum height.

See listing

var maxHeight = chart.maxHeight();

maxHeight(maxHeight)

Setter for the chart's maximum height.

Params:

Name	Type	Default	Description
maxHeight	number \| string \| null	null	Maximum height to set.

Returns:

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

Try it:

Usage sample

maxWidth

maxWidth()

Getter for the chart's maximum width.

Returns:

number | string | null - Chart's maximum width.

See listing

var maxWidth = chart.maxWidth();

maxWidth(maxWidth)

Setter for the chart's maximum width.

Params:

Name	Type	Default	Description
maxWidth	number \| string \| null	null	Maximum width to set.

Returns:

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

Try it:

Usage sample

minHeight

minHeight()

Getter for the chart's minimum height.

Returns:

number | string | null - Chart's minimum height.

See listing

var minHeight = chart.minHeight();

minHeight(minHeight)

Setter for the chart's 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
minHeight	number \| string \| null	null	Minimum height to set.

Returns:

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

Try it:

Usage sample

minWidth

minWidth()

Getter for the chart's minimum width.

Returns:

number | string | null - Chart's minimum width.

See listing

var minWidth = chart.minWidth();

minWidth(minWidth)

Setter for the chart's 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
minWidth	number \| string \| null	null	Minimum width to set.

Returns:

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

Try it:

Usage sample

noData

noData()

Getter for noData settings.

Returns:

anychart.core.NoDataSettings - NoData settings.

Try it:

Usage sample

noData(settings)

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

Params:

Name	Type	Description
settings	Object	NoData settings.

Returns:

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

Try it:

Usage sample

normal

normal()Since version 8.0.0

Getter for normal state settings.

Returns:

anychart.core.StateSettings - Normal state settings.

Try it:

Usage sample

normal(settings)Since version 8.0.0

Setter for normal state settings.

Params:

Name	Type	Description
settings	Object	State settings to set.

Returns:

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

Try it:

Usage sample

padding

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:

Usage sample

padding(padding)

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

Params:

Name	Type	Default	Description
padding	Array.<(number\|string)> \| Object	{top: 0, right: 0, bottom: 0, left: 0}	Value to set.

Returns:

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

See listing.

chart.padding([5, 15]);
or
chart.padding({left: 10, top: 20, bottom: 30, right: "40%"}});

Try it:

Usage sample

padding(value1, value2, value3, value4)

Setter for the chart paddings in pixels using several numbers.

Params:

Name	Type	Description
value1	string \| number	Top or top-bottom space.
value2	string \| number	Right or right-left space.
value3	string \| number	Bottom space.
value4	string \| number	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:

Usage sample

print

print(paperSize, landscape)

Prints chart.

Params:

Name	Type	Default	Description
paperSize	anychart.graphics.vector.PaperSize		Paper size.
landscape	boolean	false	Flag of landscape.

Try it:

Usage sample

removeAllListeners

removeAllListeners(type)

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:

Usage sample

right

right()

Getter for the chart's right bound setting.

Returns:

number | string | undefined - Chart's right bound setting.

See listing

var right = chart.right();

right(right)

Setter for the chart's right bound setting.

Params:

Name	Type	Description
right	number \| string \| null	Right bound for the chart.

Returns:

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

Try it:

Usage sample

saveAsCsv

saveAsCsv(chartDataExportMode, csvSettings, filename)

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|function(name:*, value:*))>

CSV settings object:

rowsSeparator - string or undefined (default is '\n')
columnsSeparator - string or undefined (default is ',')
ignoreFirstRow - boolean or undefined (default is 'false')
formats - Values formatter
headers - Headers formatter

Formatters must be represented as one of:

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.

filename

string

File name to save.

Try it:

Usage sample

saveAsJpg

saveAsJpg(width, height, quality, forceTransparentWhite, filename)

Saves the chart as JPEG image.

Params:

Name	Type	Description
width	number	Image width.
height	number	Image height.
quality	number	Image quality in ratio 0-1.
forceTransparentWhite	boolean	Define, should we force transparent to white background.
filename	string	File name to save.

Try it:

Usage sample

saveAsJson

saveAsJson(filename)

Saves chart config as JSON document.

Params:

Name	Type	Description
filename	string	File name to save.

Try it:

Usage sample

saveAsPdf

saveAsPdf(paperSize, landscape, x, y, filename)

Saves the chart as PDF image.

Params:

Name	Type	Description
paperSize	string	Any paper format like 'a0', 'tabloid', 'b4', etc.
landscape	boolean	Define, is landscape.
x	number	Offset X.
y	number	Offset Y.
filename	string	File name to save.

Try it:

Usage sample

saveAsPng

saveAsPng(width, height, quality, filename)

Saves the chart as PNG image.

Params:

Name	Type	Description
width	number	Image width.
height	number	Image height.
quality	number	Image quality in ratio 0-1.
filename	string	File name to save.

Try it:

Usage sample

saveAsSvg

saveAsSvg(paperSize, landscape, filename)

Saves the chart as SVG image using paper size and landscape.

Params:

Name	Type	Description
paperSize	string	Paper Size.
landscape	boolean	Landscape.
filename	string	File name to save.

Try it:

Usage sample

saveAsSvg(width, height)

Saves the stage as SVG image using width and height.

Params:

Name	Type	Description
width	number	Image width.
height	number	Image height.

Try it:

Usage sample

saveAsXlsx

saveAsXlsx(chartDataExportMode, filename, exportOptions)

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.

exportOptions

Object.<string, (function(name:*, value:*))>

Export options:

headers - Headers formatter

Formatter must be represented as one of:

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.

Try it:

Usage sample

saveAsXml

saveAsXml(filename)

Saves chart config as XML document.

Params:

Name	Type	Description
filename	string	File name to save.

Try it:

Usage sample

select

select(index)Since version 7.8.0

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

Params:

Name	Type	Description
index	number	Index of the point to select

Returns:

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

Try it:

Usage sample

select(indexes)Since version 7.8.0

Selects points by indexes.
Note: Works only after anychart.charts.Funnel#draw is called.

Params:

Name	Type	Description
indexes	Array.<number>	Array of indexes of the point to select.

Returns:

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

Try it:

Usage sample

select()Since version 7.8.0

Selects all points of the series. Note: Works only after anychart.charts.Funnel#draw is called.

Returns:

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

Try it:

Usage sample

selectRectangleMarqueeFill

selectRectangleMarqueeFill()

Getter for the select marquee fill.

Returns:

anychart.graphics.vector.Fill - Select marquee fill.

See listing

var selectRectangleMarqueeFill = chart.selectRectangleMarqueeFill();

selectRectangleMarqueeFill(color)

Setter for fill settings using an array, an object or a string. Learn more about coloring.

Params:

Name	Type	Description
color	anychart.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.

Try it:

selectRectangleMarqueeFill(color, opacity)

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:

Usage sample

selectRectangleMarqueeFill(keys, angle, mode, opacity)

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:

Usage sample

selectRectangleMarqueeFill(keys, cx, cy, mode, opacity, fx, fy)

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:

Usage sample

selectRectangleMarqueeFill(imageSettings)

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:

Usage sample

selectRectangleMarqueeStroke

selectRectangleMarqueeStroke()

Getter for the select marquee stroke.

Returns:

anychart.graphics.vector.Stroke - Select marquee stroke.

See listing.

var selectRectangleMarqueeStroke = chart.selectRectangleMarqueeStroke();

selectRectangleMarqueeStroke(color, thickness, dashpattern, lineJoin, lineCap)

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.charts.HeatMap - Self instance for method chaining.

Try it:

Usage sample

selected

selected()Since version 8.0.0

Getter for selected state settings.

Returns:

anychart.core.StateSettings - Selected state settings

Try it:

Usage sample

selected(settings)Since version 8.0.0

Setter for selected state settings.

Params:

Name	Type	Description
settings	Object	State settings to set.

Returns:

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

Try it:

Usage sample

shareAsJpg

shareAsJpg(onSuccessOrOptions, onError, asBase64, width, height, quality, forceTransparentWhite, filename)

Shares a chart as a JPG file and returns a link to the shared image.

Params:

Name	Type	Description
onSuccessOrOptions	function(response:string) \| Object	Function that is called when sharing is complete or object with options.
onError	function(response:string)	Function that is called if sharing fails.
asBase64	boolean	Share as base64 file.
width	number	Image width.
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:

Usage sample

shareAsPdf

shareAsPdf(onSuccessOrOptions, onError, asBase64, paperSizeOrWidth, landscapeOrWidth, x, y, filename)

Shares a chart as a PDF file and returns a link to the shared image.

Params:

Name	Type	Description
onSuccessOrOptions	function(response:string) \| Object	Function that is called when sharing is complete or object with options.
onError	function(response:string)	Function that is called if sharing fails.
asBase64	boolean	Share as base64 file.
paperSizeOrWidth	number \| string	Any paper format like 'a0', 'tabloid', 'b4', etc.
landscapeOrWidth	number \| boolean	Define, is landscape.
x	number	Offset X.
y	number	Offset Y.
filename	string	File name to save.

Try it:

Usage sample

shareAsPng

shareAsPng(onSuccessOrOptions, onError, asBase64, width, height, quality, filename)

Shares a chart as a PNG file and returns a link to the shared image.

Params:

Name	Type	Description
onSuccessOrOptions	function(response:string) \| Object	Function that is called when sharing is complete or object with options.
onError	function(response:string)	Function that is called if sharing fails.
asBase64	boolean	Share as base64 file.
width	number	Image width.
height	number	Image height.
quality	number	Image quality in ratio 0-1.
filename	string	File name to save.

Try it:

Usage sample

shareAsSvg

shareAsSvg(onSuccessOrOptions, onError, asBase64, paperSizeOrWidth, landscapeOrHeight, filename)

Shares a chart as a SVG file and returns a link to the shared image.

Params:

Name	Type	Description
onSuccessOrOptions	function(response:string) \| Object	Function that is called when sharing is complete or object with options.
onError	function(response:string)	Function that is called if sharing fails.
asBase64	boolean	Share as base64 file.
paperSizeOrWidth	string \| number	Paper Size or width.
landscapeOrHeight	boolean \| string	Landscape or height.
filename	string	File name to save.

Try it:

Usage sample

shareWithFacebook

shareWithFacebook(captionOrOptions, link, name, description)

Opens Facebook sharing dialog.

Params:

Name	Type	Description
captionOrOptions	string \| Object	Caption for the main link or object with options.
link	string	The URL is attached to the publication.
name	string	The title for the attached link.
description	string	Description for the attached link.

Try it:

Usage sample

shareWithLinkedIn

shareWithLinkedIn(captionOrOptions, description)

Opens LinkedIn sharing dialog.

Params:

Name	Type	Description
captionOrOptions	string \| Object	Caption for publication or object with options. If not set 'AnyChart' will be used.
description	string	Description.

Try it:

Usage sample

shareWithPinterest

shareWithPinterest(linkOrOptions, description)

Opens Pinterest sharing dialog.

Params:

Name	Type	Description
linkOrOptions	string \| Object	Attached link or object with options. If not set, the image URL will be used.
description	string	Description.

Try it:

Usage sample

shareWithTwitter

shareWithTwitter()

Opens Twitter sharing dialog.

Try it:

Usage sample

startSelectRectangleMarquee

startSelectRectangleMarquee(repeat)

Starts select marquee drawing. Note: Works only after anychart.charts.HeatMap#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:

Usage sample

stroke

stroke()Since version 7.8.0

Getter for the stroke settings.

Returns:

anychart.graphics.vector.Stroke | function():anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFill - Stroke settings.

Try it:

Usage sample

stroke(value)Since version 7.8.0

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

Params:

Name

Type

Default

Description

value

function():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.

Try it:

Usage sample

stroke(color, thickness, dashpattern, lineJoin, lineCap)Since version 7.8.0

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	'1 #ffffff'	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:

Usage sample

stroke(settings)Since version 7.8.0

Setter for stroke settings using an object.

Params:

Name	Type	Default	Description
settings	Object	'1 #ffffff'	Object with stroke settings from anychart.graphics.vector.Stroke

Returns:

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

Try it:

Usage sample

title

title()

Getter for the chart title.

Returns:

anychart.core.ui.Title - Chart title.

Try it:

Usage sample

title(settings)

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
settings	null \| boolean \| Object \| string	false	Chart title text or title instance for copy settings from.

Returns:

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

Try it:

toA11yTable

toA11yTable(title, asString)

Creates and returns the chart represented as an invisible HTML table.

Detailed description

This method generates an invisible HTML table for accessibility purposes. The table is only available for Screen Readers.

Params:

Name	Type	Description
title	string	Title to set.
asString	boolean	Defines output: HTML string if True, DOM element if False.

Returns:

Element | string | null - HTML table instance with a11y style (invisible), HTML string or null if parsing chart to table fails.

Try it:

Usage sample

toCsv

toCsv(chartDataExportMode, csvSettings)

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

Try it:

toHtmlTable

toHtmlTable(title, asString)

Creates and returns a chart as HTML table.

Detailed description

This method generates an HTML table which contains chart data.

Params:

Name	Type	Description
title	string	Title to set.
asString	boolean	Defines output: HTML string if True, DOM element if False.

Returns:

Element | string | null - HTML table instance, HTML string or null if parsing chart to table fails.

Try it:

Usage sample

toJson

toJson(stringify)

Returns chart configuration as JSON object or string.

Params:

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

Returns:

Object | string - Chart configuration.

Try it:

toSvg

toSvg(paperSize, landscape)

Returns SVG string using 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	Paper Size.
landscape	boolean	Landscape.

Returns:

string - SVG content or empty string.

Try it:

Usage sample

toSvg(width, height)

Returns SVG string using 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:

Usage sample

toXml

toXml(asXmlNode)

Returns chart configuration as XML string or XMLNode.

Params:

Name	Type	Default	Description
asXmlNode	boolean	false	Return XML as XMLNode.

Returns:

string | Node - Chart configuration.

Try it:

tooltip()

tooltip(settings)

Setter for the chart tooltip.

Detailed description

Params:

Name	Type	Default	Description
settings	Object \| boolean \| null	false	Chart tooltip settings.

Returns:

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

Try it:

top

top()

Getter for the chart's top bound setting.

Returns:

number | string | undefined - Chart's top bound settings.

See listing

var top = chart.top();

top(top)

Setter for the chart's top bound setting.

Params:

Name	Type	Description
top	number \| string \| null	Top bound for the chart.

Returns:

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

Try it:

Usage sample

unhover

unhover()

Removes hover from all chart points.

Detailed description

Note: Works only after anychart.charts.HeatMap#draw is called.

Returns:

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

Try it:

Usage sample

unlisten

unlisten(type, listener, useCapture, listenerScope)

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

Params:

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

Usage sample

unlistenByKey

unlistenByKey(key)

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:

Usage sample

unselect

unselect(indexOrIndexes)

Deselects all points or points by index.

Params:

Name	Type	Description
indexOrIndexes	number \| Array.<number>	Index or array of indexes of the point to select.

Try it:

Usage sample

width

width()

Getter for the chart's width setting.

Returns:

number | string | undefined - Chart's width setting.

See listing

var width = chart.width();

width(width)

Setter for the chart's width setting.

Params:

Name	Type	Default	Description
width	number \| string \| null	null	Width settings for the chart.

Returns:

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

Try it:

Usage sample

xAxis

xAxis(index)Since version 7.8.0

Getter for the chart X-axis.

Params:

Name	Type	Description
index	number	Chart axis index.

Returns:

anychart.core.axes.Linear - Axis instance by index.

Try it:

Usage sample

xAxis(settings)Since version 7.8.0

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
settings	Object \| boolean \| null	true	Chart axis settings to set.

Returns:

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

Try it:

xAxis(index, settings)Since version 7.8.0

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.
settings	Object \| boolean \| null	Chart axis settings to set.

Returns:

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

Try it:

xGrid

xGrid(index)Since version 8.0.0

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:

Usage sample

xGrid(settings)Since version 8.0.0

Setter for the chart grid by X-scale.

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
settings	Object \| boolean \| null	false	Grid settings to set.

Returns:

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

Try it:

xGrid(index, settings)Since version 8.0.0

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.
settings	Object \| boolean \| null	Grid settings to set.

Returns:

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

Try it:

xScale

xScale()Since version 7.8.0

Getter for the chart X scale.

Returns:

anychart.scales.Ordinal - Chart scale.

See listing

var xScale = chart.xScale();

xScale(settings)Since version 7.8.0

Setter for the chart X scale.

Params:

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

Usage sample

xScroller

xScroller()Since version 7.8.0

Getter for the X scroller.

Returns:

anychart.core.ui.ChartScroller - Scroller instance.

Try it:

Usage sample

xScroller(settings)Since version 7.8.0

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
settings	Object \| boolean \| null	X scroller settings.

Returns:

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

Try it:

xZoom

xZoom()

Getter for X Zoom settings.

Returns:

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

Try it:

Usage sample

xZoom(settings)

Setter for X Zoom settings.

Params:

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

yAxis(index)Since version 7.8.0

Getter for the chart Y-axis.

Params:

Name	Type	Description
index	number	Chart axis index.

Returns:

anychart.core.axes.Linear - Axis instance by index.

Try it:

Usage sample

yAxis(settings)Since version 7.8.0

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
settings	Object \| boolean \| null	Chart axis settings to set.

Returns:

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

Try it:

yAxis(index, settings)Since version 7.8.0

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.
settings	Object \| boolean \| null	Chart axis settings to set.

Returns:

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

Try it:

yGrid

yGrid(index)Since version 8.0.0

Getter for the chart grid by Y-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:

Usage sample

yGrid(settings)Since version 8.0.0

Setter for the chart grid by Y-scale.

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
settings	Object \| boolean \| null	false	Grid settings to set.

Returns:

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

Try it:

yGrid(index, settings)Since version 8.0.0

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.
settings	Object \| boolean \| null	Grid settings to set.

Returns:

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

Try it:

yScale

yScale()Since version 7.8.0

Getter for the chart Y scale.

Returns:

anychart.scales.Ordinal - Chart scale value.

See listing

var yScale = chart.yScale();

yScale(settings)Since version 7.8.0

Setter for the chart Y scale.

Params:

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

Usage sample

yScroller

yScroller()Since version 7.8.0

Getter for the Y scroller.

Returns:

anychart.core.ui.ChartScroller - Scroller instance.

Try it:

Usage sample

yScroller(settings)Since version 7.8.0

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
settings	Object \| boolean \| null	Y scroller settings.

Returns:

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

Try it:

yZoom

yZoom()

Getter for Y Zoom settings.

Returns:

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

Try it:

Usage sample

yZoom(settings)

Setter for Y Zoom settings.

Params:

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

zIndex()

Getter for the Z-index of the chart.

Returns:

number - Chart Z-index.

See listing

var zIndex = chart.zIndex();

zIndex(zIndex)

Setter for the Z-index of the chart.

Detailed description

The bigger the index - the higher the element position is.

Params:

Name	Type	Default	Description
zIndex	number	0	Z-index to set.

Returns:

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

Try it:

Usage sample