class anychart.charts.TreeMap Improve this Doc

AnyChart TreeMap class.

Methods Overview

Specific settings
globalToLocal()	Converts the global coordinates to local coordinates.
hintDepth()	Settings for the number of hint-levels
localToGlobal()	Converts the local coordinates to global coordinates.
maxDepth()	Settings for the number of levels headlines
selectionMode()	Selection mode
Axes and Scales
colorScale()	Color scale settings.
Chart Coloring
animation()	Animation settings
background()	Background settings.
Chart Controls
colorRange()	Color range settings.
credits()	Credits settings
label()	Label settings.
legend()	Legend settings.
title()	Title settings.
Chart coloring
hintOpacity()	Hint opacity settings
Coloring
fill()	Fill settings.
hatchFill()	Hatch fill settings.
hoverFill()	Fill settings in hover mode.
hoverHatchFill()	Hatch fill settings in hover mode.
hoverStroke()	Stroke settings in hover mode.
selectFill()	Fill settings in selected mode.
selectHatchFill()	Hatch fill settings in selected mode.
selectMarqueeFill()	Select marquee fill settings.
selectMarqueeStroke()	Stroke settings.
selectStroke()	Stroke settings in selected mode.
stroke()	Stroke settings.
Data
data()	Data settings.
getDrilldownPath()	Returns crumbs from the root to the current level.
sort()	Sort 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
print()	Prints all elements.
Interactivity
drillTo()	Drills down to target.
drillUp()	Drills one level up from current level.
enabled()	Element state (enabled or disabled).
interactivity()	Interactivity settings.
startSelectMarquee()	Starts select marquee drawing.
tooltip()	Tooltip settings.
Point Elements
headers()	Header labels settings.
headersDisplayMode()	Header labels display mode.
hoverHeaders()	Header labels settings in hover mode.
hoverLabels()	Labels settings in hover mode.
hoverMarkers()	Markers settings in hover mode.
labels()	Labels settings.
markers()	Markers settings.
selectLabels()	Labels settings in selected mode.
selectMarkers()	Markers settings in selected mode.
Size and Position
bottom()	Bottom bound setting.
bounds()	Bounds settings.
getPixelBounds()	Returns pixel bounds.
height()	Height setting.
left()	Left bound setting.
margin()	Margin settings.
maxHeadersHeight()	Maximum headers height
maxHeight()	Maximum height.
maxWidth()	Maximum width.
minHeight()	Minimum height.
minWidth()	Minimum width.
padding()	Padding settings.
right()	Right bound setting.
top()	Top bound setting.
width()	Width setting.
zIndex()	Z-index of the element.
XML/JSON
toJson()	Return chart configuration as JSON object or string.
toXml()	Return chart configuration as XML string or XMLNode.
Miscellaneous
cancelMarquee()	Stops current marquee action if any.
container()	Getter for the element's container.
draw()	Drawing of the chart.
inMarquee()	Gets marquee process running value.
saveAsJpg()	Saves the current chart as JPEG image.
saveAsPdf()	Saves the current chart as PDF image.
saveAsPng()	Saves the current chart as PNG image.
saveAsSvg()	Saves the current chart as SVG image.
toSvg()	Returns SVG string.

Methods Description

animation

animation()

Getter for the current animation setting.

Returns:

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

Try it:

Usage sample

animation(value)

Setter for the animation setting by one value.

Detailed description

Sets animation settings depending on parameter type:

null/boolean - disable or enable animation.
object - sets animation settings.

Note If you use anychart.graphics.vector.Stage#suspend, you will not see animation.

Params:

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

Returns:

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

Try it:

animation(enabled, duration)

Setter for the animation settings using several parameters.

Detailed description

Note If you use anychart.graphics.vector.Stage#suspend, you will not see animation.

Params:

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

Returns:

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

Try it:

Usage sample

background

background()

Getter for the current chart background.

Returns:

anychart.core.ui.Background - The current chart background.

Try it:

Usage sample

background(value)

Setter for the chart background.

Params:

Name	Type	Default	Description
value	Object	{enabled: true, fill: "#fff", stroke: 'none', zIndex: 1}	Background object to set.

Returns:

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

Try it:

Usage sample

bottom

bottom()

Getter for element bottom bound setting.

Returns:

number | string | undefined - Current element's bottom bound setting.

bottom(value)

Sets element bottom bound setting.

Params:

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

Returns:

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

Try it:

Usage sample

bounds

bounds()

Getter for the element bounds settings.

Returns:

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

bounds(value)

Sets bounds of the element using one parameter.

Params:

Name	Type	Description
value	anychart.utils.RectObj \| anychart.math.Rect \| anychart.core.utils.Bounds	Bounds of element.

Returns:

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

Try it:

Usage sample

bounds(x, y, width, height)

Setter for the element bounds settings.

Params:

Name	Type	Default	Description
x	number \| string	null	X-coordinate.
y	number \| string	null	Y-coordinate.
width	number \| string	null	Width.
height	number \| string	null	Height.

Returns:

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

Try it:

Usage sample

cancelMarquee

cancelMarquee()Since version 7.14.0

Stops current marquee action if any.

Returns:

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

colorRange

colorRange()Since version 7.10.0

Getter for the current color range.

Returns:

anychart.core.ui.ColorRange - The current color range.

Try it:

Usage sample

colorRange(value)Since version 7.10.0

Setter for the color range.

Params:

Name	Type	Description
value	Object	Color range settings to set.

Returns:

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

Try it:

Usage sample

colorScale

colorScale()Since version 7.10.0

Getter for the color scale.

Returns:

anychart.scales.OrdinalColor | anychart.scales.LinearColor - The color scale.

See listing.

var currentColorScale = chart.colorScale();

colorScale(value)Since version 7.10.0

Setter for the color scale.

Params:

Name	Type	Description
value	anychart.scales.OrdinalColor \| anychart.scales.LinearColor	Value to set.

Returns:

anychart.scales.LinearColor - Self instance for method chaining.

Try it:

container

container()

Getter for the element's container.

Returns:

anychart.graphics.vector.Layer | anychart.graphics.vector.Stage - The current container.

container(value)

Setter for the element's container.

Detailed description

Each element appends all its content to this container.
The order of adding is not defined, but usually it will be the order in which elements are drawn for the first time. If you need to specify the order use anychart.core.VisualBase#zIndex.

Params:

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

Returns:

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

Example

// string
 element.container('containerIdentifier');
// DOM-element
 var domElement = document.getElementById('containerIdentifier');
 element.container(domElement);
// Framework-element
 var fwElement = anychart.standalones.title();
 element.container( fwElement.container() );

Try it:

Usage sample

credits

credits()

Getter for the current credits.

Returns:

anychart.core.ui.ChartCredits - Chart credits.

Try it:

Usage sample

credits(value)

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
value	Object \| boolean \| null	true	Credits settings

Returns:

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

Try it:

data

data()Since version 7.10.0

Getter for the current data.

Returns:

anychart.data.Tree | anychart.data.TreeView - The current data tree.

Try it:

Usage sample

data(value, fillMethod)Since version 7.10.0

Setter for the data.

Params:

Name	Type	Description
value	anychart.data.Tree \| anychart.data.TreeView \| Array.<Object>	Data tree or raw data.
fillMethod	anychart.enums.TreeFillingMethod \| string	Fill method.

Returns:

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

Try it:

drillTo

drillTo(target)Since version 7.10.0

Drills down to target.

Params:

Name	Type	Description
target	anychart.data.Tree.DataItem \| Array \| string	Target to drill down to.

Try it:

Usage sample

drillUp

drillUp()Since version 7.10.0

Drills one level up from current level.

Try it:

Usage sample

enabled

enabled()

Getter for the current element state (enabled or disabled).

Returns:

boolean - The current element state.

Try it:

Usage sample

enabled(value)

Setter for the element enabled state.

Params:

Name	Type	Default	Description
value	boolean	true	Value to set.

Returns:

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

Example.

if (!element.enabled())
   element.enabled(true);

Try it:

Usage sample

fill

fill()Since version 7.10.0

Getter for the current fill color.

Returns:

anychart.graphics.vector.Fill | function - The current fill color.

See listing

var chart = anychart.treeMap(data);
var currentFill = chart.fill();

fill(value)Since version 7.10.0

Sets fill settings using an array or a string. Learn more about coloring.

Detailed description

Note: If you call a fill method, the colorScale settings will not be applied.

Params:

Name	Type	Description
value	anychart.graphics.vector.Fill	Color as an array or a string.

Returns:

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

Try it:

fill(fillFunction)Since version 7.10.0

Sets fill settings using function.

Detailed description

Note: If you call a fill method, the colorScale settings will not be applied.

Params:

Name	Type	Default	Description
fillFunction	function	function() { return anychart.color.darken(this.sourceColor); }	Function that looks like `function(){ // this.value - current value. // this.sourceColor - color returned by fill() getter. // this.colorScale - chart color scale. return fillValue; // type anychart.graphics.vector.Fill }`.

Returns:

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

Try it:

Usage sample

fill(color, opacity)Since version 7.10.0

Fill color with opacity. Fill as a string or an object.

Detailed description

Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity. Note: If you call a fill method, the colorScale settings will not be applied.

Params:

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

Returns:

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

Try it:

Usage sample

fill(keys, angle, mode, opacity)Since version 7.10.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.TreeMap - Self instance for method chaining.

Try it:

Usage sample

fill(keys, cx, cy, mode, opacity, fx, fy)Since version 7.10.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.TreeMap - Self instance for method chaining.

Try it:

Usage sample

fill(imageSettings)Since version 7.10.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.TreeMap - Self instance for method chaining.

Try it:

Usage sample

getDrilldownPath

getDrilldownPath()Since version 7.10.0

Returns crumbs from the root to the current level.

Returns:

Array - The current path.

Try it:

Usage sample

getPixelBounds

getPixelBounds()

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

Returns:

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

globalToLocal

globalToLocal(xCoord, yCoord)Since version 7.9.1

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

Detailed description

Converts global coordinates of the global document into local coordinates of the container or stage.
On image below, the red point is a starting coordinate point of the chart bounds. Local coordinates work only in area of the stage (container).

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

Getter for current hatch fill settings.

Returns:

anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - The current hatch fill.

See listing

var chart = anychart.treeMap(data);
var currentHatchFill = chart.hatchFill();

hatchFill(patternFillOrType, color, thickness, size)Since version 7.10.0

Setter for the hatch fill settings.

Params:

Name	Type	Default	Description
patternFillOrType	anychart.graphics.vector.PatternFill \| anychart.graphics.vector.HatchFill \| function \| anychart.graphics.vector.HatchFill.HatchFillType \| string \| boolean	false	PatternFill or HatchFill instance or type of hatch fill.
color	string		Color.
thickness	number		Thickness.
size	number		Pattern size.

Returns:

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

Try it:

Usage sample

headers

headers()Since version 7.10.0

Getter for the current point header labels.

Returns:

anychart.core.ui.LabelsFactory - The current point header labels.

Try it:

Usage sample

headers(value)Since version 7.10.0

Setter for the point header labels.

Detailed description

Sets chart header labels settings depending on parameter type:

null/boolean - disable or enable header labels.
object - sets header labels settings.

Params:

Name	Type	Description
value	Object \| boolean \| null	Point headers settings.

Returns:

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

Try it:

headersDisplayMode

headersDisplayMode()Since version 7.10.0

Getter for the current headers display mode.

Returns:

string | anychart.enums.LabelsDisplayMode - The current mode.

Try it:

Usage sample

headersDisplayMode(value)Since version 7.10.0

Setter for the headers display mode.

Params:

Name	Type	Description
value	string \| anychart.enums.LabelsDisplayMode	Mode to set.

Returns:

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

Try it:

Usage sample

height

height()

Getter for element height setting.

Returns:

number | string | undefined - Current element's height setting.

height(value)

Sets element height setting.

Params:

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

Returns:

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

Try it:

Usage sample

hintDepth

hintDepth()Since version 7.10.0

Getter for the current additional segmentation of treeMap points.

Detailed description

Shows the number of hint-levels that will be drawn below.

Returns:

number - Hint depth value.

Try it:

Usage sample

hintDepth(value)Since version 7.10.0

Setter for the additional segmentation of treeMap points.

Params:

Name	Type	Default	Description
value	number	0	Additional depth of visibility.

Returns:

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

Try it:

Usage sample

hintOpacity

hintOpacity()Since version 7.10.0

Getter for the current hint opacity.

Returns:

number - The current hint opacity.

Try it:

Usage sample

hintOpacity(value)Since version 7.10.0

Setter for current hint opacity.

Detailed description

The layer opacity above of the hint layers. Note that anychart.charts.TreeMap#hintDepth should be greater 0.

Params:

Name	Type	Default	Description
value	number	1	Opacity value from 0 to 1

Returns:

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

Try it:

Usage sample

hoverFill

hoverFill()Since version 7.10.0

Getter for the current fill color in hover mode.

Returns:

anychart.graphics.vector.Fill | function - The current fill color.

See listing

var chart = anychart.treeMap(data);
var currentHoverFill = chart.hoverFill();

hoverFill(value)Since version 7.10.0

Sets fill settings in hover mode using an array or a string. Learn more about coloring.

Params:

Name	Type	Description
value	anychart.graphics.vector.Fill	Color as an array or a string.

Returns:

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

Try it:

hoverFill(fillFunction)Since version 7.10.0

Sets fill settings in hover mode using function.

Params:

Name	Type	Default	Description
fillFunction	function	function() { return anychart.color.darken(this.sourceColor); }	Function that looks like `function(){ // this.index - series index. // this.sourceColor - color returned by fill() getter. // this.iterator - series point iterator. return fillValue; // type anychart.graphics.vector.Fill }`.

Returns:

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

Try it:

Usage sample

hoverFill(color, opacity)Since version 7.10.0

Fill color in hover mode with opacity. Fill as a string or an object.

Detailed description

Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.

Params:

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

Returns:

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

Try it:

Usage sample

hoverFill(keys, angle, mode, opacity)Since version 7.10.0

Linear gradient fill in hover mode. Learn more about coloring.

Params:

Name	Type	Description
keys	Array.<(anychart.graphics.vector.GradientKey\|string)>	Gradient keys.
angle	number	Gradient angle.
mode	boolean \| anychart.graphics.vector.Rect \| Object	Gradient mode.
opacity	number	Gradient opacity.

Returns:

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

Try it:

Usage sample

hoverFill(keys, cx, cy, mode, opacity, fx, fy)Since version 7.10.0

Radial gradient fill in hover mode. Learn more about coloring.

Params:

Name	Type	Description
keys	Array.<(anychart.graphics.vector.GradientKey\|string)>	Color-stop gradient keys.
cx	number	X ratio of center radial gradient.
cy	number	Y ratio of center radial gradient.
mode	anychart.graphics.math.Rect	If defined then userSpaceOnUse mode, else objectBoundingBox.
opacity	number	Opacity of the gradient.
fx	number	X ratio of focal point.
fy	number	Y ratio of focal point.

Returns:

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

Try it:

Usage sample

hoverFill(imageSettings)Since version 7.10.0

Image fill in hover mode. Learn more about coloring.

Params:

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

Returns:

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

Try it:

Usage sample

hoverHatchFill

hoverHatchFill()Since version 7.10.0

Getter for the current hatch fill settings in hover mode.

Returns:

anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - The current hatch fill.

See listing

var chart = anychart.treeMap(data);
var currentHoverHatchFill = chart.hoverHatchFill();

hoverHatchFill(patternFillOrType, color, thickness, size)Since version 7.10.0

Setter for the hatch fill settings in hover mode.

Params:

Name	Type	Default	Description
patternFillOrType	anychart.graphics.vector.PatternFill \| anychart.graphics.vector.HatchFill \| function \| anychart.graphics.vector.HatchFill.HatchFillType \| string \| boolean	true	PatternFill or HatchFill instance or type of hatch fill.
color	string		Color.
thickness	number		Thickness.
size	number		Pattern size.

Returns:

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

Try it:

Usage sample

hoverHeaders

hoverHeaders()Since version 7.10.0

Getter for the current hover header labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Usage sample

hoverHeaders(value)Since version 7.10.0

Setter for the hover header labels.

Detailed description

Sets chart header labels settings in hover mode depending on parameter type:

null/boolean - disable or enable header labels.
object - sets header labels settings.

Params:

Name	Type	Description
value	Object \| boolean \| null	Point hover headers settings.

Returns:

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

Try it:

hoverLabels

hoverLabels()Since version 7.10.0

Getter for the current point hover labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Usage sample

hoverLabels(value)Since version 7.10.0

Setter for the point hover labels.

Detailed description

Sets point hover labels settings depending on parameter type:

null/boolean - disable or enable point hover labels.
object - sets point hover labels settings.

Params:

Name	Type	Description
value	Object \| boolean \| null	Point hover labels settings.

Returns:

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

Try it:

hoverMarkers

hoverMarkers()Since version 7.10.0

Getter for the current point hover markers.

Returns:

anychart.core.ui.MarkersFactory - Markers instance.

Try it:

Usage sample

hoverMarkers(value)Since version 7.10.0

Setter for the point hover markers.

Detailed description

Sets point hover markers settings depending on parameter type:

null/boolean - disable or enable point markers.
object - sets point markers settings.

Params:

Name	Type	Description
value	Object \| boolean \| null \| string	Point hover markers settings.

Returns:

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

Try it:

hoverStroke

hoverStroke()Since version 7.10.0

Getter for the current stroke in hover mode.

Returns:

anychart.graphics.vector.Stroke | function - The current stroke in the normal state.

See listing

var chart = anychart.treeMap(data);
var currentHoverStroke = chart.hoverStroke();

hoverStroke(strokeFunction)Since version 7.10.0

Setter for the stroke in hover mode using function. Learn more about stroke settings.

Params:

Name	Type	Default	Description
strokeFunction	anychart.graphics.vector.Stroke \| function	// return stroke from the default palette. function() { return anychart.color.darken(this.sourceColor); };	Stroke-function, which should look like:`function() { // this.value - data value data value // this.sourceColor - stroke of the current point // this.colorScale - the current color scale settings // } return strokeValue; //anychart.graphics.vector.Stroke };`.

Returns:

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

Try it:

Usage sample

hoverStroke(color, thickness, dashpattern, lineJoin, lineCap)Since version 7.10.0

Setter for the stroke in hover mode. Learn more about stroke settings.

Params:

Name	Type	Default	Description
color	anychart.graphics.vector.Stroke \| anychart.graphics.vector.ColoredFill \| string \| function \| null		Stroke settings.
thickness	number	1	Line thickness.
dashpattern	string		Controls the pattern of dashes and gaps used to stroke paths.
lineJoin	anychart.graphics.vector.StrokeLineJoin		Line join style.
lineCap	anychart.graphics.vector.StrokeLineCap		Line cap style.

Returns:

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

Try it:

Usage sample

inMarquee

inMarquee()Since version 7.14.0

Gets marquee process running value.

Returns:

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

interactivity

interactivity()Since version 7.7.0

Gets the current interactivity settings for chart.

Returns:

anychart.core.utils.Interactivity - The current interactivity settings.

interactivity(value)Since version 7.7.0

Sets interactivity settings for chart.

Params:

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

Returns:

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

Try it:

Usage sample

label

label(index)

Getter for chart label.

Params:

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

Returns:

anychart.core.ui.Label - An instance of class.

Try it:

Usage sample

label(value)

Setter for chart label.

Detailed description

Sets chart label settings depending on parameter type:

null/boolean - disable or enable chart label.
string - sets chart label text value.
object - sets chart label settings.

Params:

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

Returns:

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

Try it:

label(index, value)

Setter for chart label.

Detailed description

Sets chart label settings by index depending on parameter type:

null/boolean - disable or enable chart label.
string - sets chart label text value.
object - sets chart label settings.

Params:

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

Returns:

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

Try it:

labels

labels()Since version 7.10.0

Getter for the current point labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Usage sample

labels(value)Since version 7.10.0

Setter for the point labels.

Detailed description

Sets point labels settings depending on parameter type:

null/boolean - disable or enable point labels.
object - sets point labels settings.

Params:

Name	Type	Description
value	Object \| boolean \| null	Point labels settings.

Returns:

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

Try it:

left

left()

Getter for element left bound setting.

Returns:

number | string | undefined - Current element's left bound setting.

left(value)

Sets element left bound setting.

Params:

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

Returns:

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

Try it:

Usage sample

legend

legend()

Getter for the current chart legend.

Returns:

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

Try it:

Usage sample

legend(value)

Setter for chart legend setting.

Detailed description

Sets chart legend settings depending on parameter type:

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

Params:

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

Returns:

anychart.charts.TreeMap - 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		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		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)Since version 7.9.1

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

Detailed description

Converts local coordinates of the container or stage into global coordinates of the global document.
On image below, the red point is a starting coordinate point of the chart bounds. Local coordinates work only in area of the stage (container).

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 current chart margin.

Detailed description

Also, you can use anychart.core.utils.Margin#bottom, anychart.core.utils.Margin#left, anychart.core.utils.Margin#right, anychart.core.utils.Margin#top methods to setting paddings.

Returns:

anychart.core.utils.Margin - Chart margin.

Try it:

Usage sample

margin(value)

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

Params:

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

Returns:

anychart.charts.TreeMap - 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.TreeMap - 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.10.0

Getter for the current point markers.

Returns:

anychart.core.ui.MarkersFactory - Markers instance.

Try it:

Usage sample

markers(value)Since version 7.10.0

Setter for the point markers.

Detailed description

Sets point markers settings depending on parameter type:

null/boolean - disable or enable point markers.
object - sets point markers settings.

Params:

Name	Type	Description
value	Object \| boolean \| null \| string	Point markers settings.

Returns:

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

Try it:

maxDepth

maxDepth()Since version 7.10.0

Getter for the current maximal drawing depth.

Detailed description

Shows the number of levels headlines that will be drawn.

Returns:

number - The current maximal drawing depth.

Try it:

Usage sample

maxDepth(value)Since version 7.10.0

Setter for the maximal drawing depth.

Detailed description

Shows the number of levels headlines that will be drawn.

Params:

Name	Type	Default	Description
value	number	1	Max depth to draw.

Returns:

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

Try it:

Usage sample

maxHeadersHeight

maxHeadersHeight()Since version 7.10.0

Getter for the current maximum headers height.

Returns:

number | string - The current maximum headers height.

Try it:

Usage sample

maxHeadersHeight(value)Since version 7.10.0

Setter for the maximum headers height.

Params:

Name	Type	Default	Description
value	number \| string	25	Max headers height value.

Returns:

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

Try it:

Usage sample

maxHeight

maxHeight()

Getter for maximum height.

Returns:

number | string | null - Current element's maximum height.

maxHeight(value)

Setter for maximum height.

Params:

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

Returns:

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

Try it:

Usage sample

maxWidth

maxWidth()

Getter for maximum width.

Returns:

number | string | null - Current element's maximum width.

maxWidth(value)

Setter for maximum width.

Params:

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

Returns:

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

Try it:

Usage sample

minHeight

minHeight()

Getter for minimum height.

Returns:

number | string | null - Current element's minimum height.

minHeight(value)

Setter for minimum height.

Detailed description

The method sets a minimum height of elements, that will be to remain after a resize of element.

Params:

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

Returns:

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

Try it:

Usage sample

minWidth

minWidth()

Getter for minimum width.

Returns:

number | string | null - Current element's minimum width.

minWidth(value)

Setter for minimum width.

Detailed description

The method sets a minimum width of elements, that will be to remain after a resize of element.

Params:

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

Returns:

anychart.charts.TreeMap - 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(value)

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

Params:

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

Returns:

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

Example.

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.TreeMap - 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(paperSizeOrOptions, landscape)

Prints all elements on related stage.

Params:

Name	Type	Default	Description
paperSizeOrOptions	anychart.graphics.vector.PaperSize \| Object		Paper size or object with options.
landscape	boolean	false	Flag of landscape.

Try it:

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 element right bound setting.

Returns:

number | string | undefined - Current element's right bound setting.

right(value)

Sets element right bound setting.

Params:

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

Returns:

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

Try it:

Usage sample

saveAsJpg

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

Saves the current chart as JPEG image.

Params:

Name	Type	Description
width	number \| Object	Image width or object with options.
height	number	Image height.
quality	number	Image quality in ratio 0-1.
forceTransparentWhite	boolean	Force transparent to white or not.
filename	string	File name to save.

Try it:

Usage sample

saveAsPdf

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

Saves the current chart as PDF image.

Params:

Name	Type	Description
paperSizeOrWidthOrOptions	number \| string \| Object	Any paper format like 'a0', 'tabloid', 'b4', etc or width, or object with options.
landscape	boolean	Define, is landscape.
x	number	Offset X.
y	number	Offset Y.
filename	string	File name to save.

Try it:

Usage sample

saveAsPng

saveAsPng(width, height, quality, filename)

Saves the current chart as PNG image.

Params:

Name	Type	Description
width	number \| Object	Image width or object with options.
height	number	Image height.
quality	number	Image quality in ratio 0-1.
filename	string	File name to save.

Try it:

Usage sample

saveAsSvg

saveAsSvg(paperSize, landscape, filename)

Saves the current chart as SVG image.

Params:

Name	Type	Description
paperSize	string \| Object	Paper Size or object with options.
landscape	boolean	Landscape.
filename	string	File name to save.

Try it:

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

selectFill

selectFill()Since version 7.10.0

Getter for the current fill color in selected mode.

Returns:

anychart.graphics.vector.Fill | function - The current fill color.

See listing

var chart = anychart.treeMap(data);
var currentSelectFill = chart.selectFill();

selectFill(value)Since version 7.10.0

Sets fill settings in selected mode using an array or a string. Learn more about coloring.

Params:

Name	Type	Description
value	anychart.graphics.vector.Fill	Color as an array or a string.

Returns:

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

Try it:

selectFill(fillFunction)Since version 7.10.0

Sets fill settings in selected mode using function.

Params:

Name	Type	Default	Description
fillFunction	function	function() { return anychart.color.darken(this.sourceColor); }	Function that looks like `function(){ // this.index - series index. // this.sourceColor - color returned by fill() getter. // this.iterator - series point iterator. return fillValue; // type anychart.graphics.vector.Fill }`.

Returns:

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

Try it:

Usage sample

selectFill(color, opacity)Since version 7.10.0

Fill color in selected mode with opacity. Fill as a string or an object.

Detailed description

Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.

Params:

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

Returns:

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

Try it:

Usage sample

selectFill(keys, angle, mode, opacity)Since version 7.10.0

Linear gradient fill in selected mode. Learn more about coloring.

Params:

Name	Type	Description
keys	Array.<(anychart.graphics.vector.GradientKey\|string)>	Gradient keys.
angle	number	Gradient angle.
mode	boolean \| anychart.graphics.vector.Rect \| Object	Gradient mode.
opacity	number	Gradient opacity.

Returns:

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

Try it:

Usage sample

selectFill(keys, cx, cy, mode, opacity, fx, fy)Since version 7.10.0

Radial gradient fill in selected mode. Learn more about coloring.

Params:

Name	Type	Description
keys	Array.<(anychart.graphics.vector.GradientKey\|string)>	Color-stop gradient keys.
cx	number	X ratio of center radial gradient.
cy	number	Y ratio of center radial gradient.
mode	anychart.graphics.math.Rect	If defined then userSpaceOnUse mode, else objectBoundingBox.
opacity	number	Opacity of the gradient.
fx	number	X ratio of focal point.
fy	number	Y ratio of focal point.

Returns:

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

Try it:

Usage sample

selectFill(imageSettings)Since version 7.10.0

Image fill in selected mode. Learn more about coloring.

Params:

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

Returns:

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

Try it:

Usage sample

selectHatchFill

selectHatchFill()Since version 7.10.0

Getter for the current hatch fill settings in selected mode.

Returns:

anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - The current hatch fill.

See listing

var chart = anychart.heatMap(data);
var currentSelectHatchFill = chart.selectHatchFill();

selectHatchFill(patternFillOrType, color, thickness, size)Since version 7.10.0

Setter for the hatch fill settings in selected mode.

Params:

Name	Type	Default	Description
patternFillOrType	anychart.graphics.vector.PatternFill \| anychart.graphics.vector.HatchFill \| function \| anychart.graphics.vector.HatchFill.HatchFillType \| string \| boolean	false	PatternFill or HatchFill instance or type of hatch fill.
color	string		Color.
thickness	number		Thickness.
size	number		Pattern size.

Returns:

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

Try it:

Usage sample

selectLabels

selectLabels()Since version 7.10.0

Getter for the current point select labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Usage sample

selectLabels(value)Since version 7.10.0

Setter for the point select labels.

Detailed description

Sets point select labels settings depending on parameter type:

null/boolean - disable or enable point select labels.
object - sets point select labels settings.

Params:

Name	Type	Description
value	Object \| boolean \| null	Point select labels settings.

Returns:

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

Try it:

selectMarkers

selectMarkers()Since version 7.10.0

Getter for the current point select markers.

Returns:

anychart.core.ui.MarkersFactory - Markers instance.

Try it:

Usage sample

selectMarkers(value)Since version 7.10.0

Setter for the point select markers.

Detailed description

Sets point select markers settings depending on parameter type:

null/boolean - disable or enable point markers.
object - sets point markers settings.

Params:

Name	Type	Description
value	Object \| boolean \| null \| string	Series select markers settings.

Returns:

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

Try it:

selectMarqueeFill

selectMarqueeFill()Since version 7.14.0

Getter for the select marquee fill.

Returns:

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

See listing

var selectMarqueeFill = chart.selectMarqueeFill();

selectMarqueeFill(value)Since version 7.14.0

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

Params:

Name	Type	Description
value	anychart.graphics.vector.Fill	Color as an object or a string.

Returns:

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

Try it:

selectMarqueeFill(color, opacity)Since version 7.14.0

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

Try it:

Usage sample

selectMarqueeFill(keys, angle, mode, opacity)Since version 7.14.0

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

Try it:

Usage sample

selectMarqueeFill(keys, cx, cy, mode, opacity, fx, fy)Since version 7.14.0

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

Try it:

Usage sample

selectMarqueeFill(imageSettings)Since version 7.14.0

Image fill. Learn more about coloring.

Params:

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

Returns:

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

Try it:

Usage sample

selectMarqueeStroke

selectMarqueeStroke()Since version 7.14.0

Getter for the select marquee stroke.

Returns:

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

See listing.

var selectMarqueeStroke = chart.selectMarqueeStroke();

selectMarqueeStroke(color, thickness, dashpattern, lineJoin, lineCap)Since version 7.14.0

Setter for the select marquee stroke. Learn more about stroke settings.

Params:

Name	Type	Default	Description
color	anychart.graphics.vector.Stroke \| anychart.graphics.vector.ColoredFill \| string \| null		Stroke settings.
thickness	number	1	Line thickness.
dashpattern	string		Controls the pattern of dashes and gaps used to stroke paths.
lineJoin	anychart.graphics.vector.StrokeLineJoin		Line join style.
lineCap	anychart.graphics.vector.StrokeLineCap		Line cap style.

Returns:

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

Try it:

Usage sample

selectStroke

selectStroke()Since version 7.10.0

Getter for the stroke in selected mode.

Returns:

anychart.graphics.vector.Stroke | function - The current stroke.

See listing

var chart = anychart.treeMap(data);
var currentSelectStroke = chart.selectStroke();

selectStroke(strokeFunction)Since version 7.10.0

Setter for the stroke in selected mode using function. Learn more about stroke settings.

Params:

Name	Type	Default	Description
strokeFunction	function	// return stroke from the default palette. function() { return anychart.color.darken(this.sourceColor); };	Stroke-function, which should look like:`function() { // this.value - data value data value // this.sourceColor - stroke of the current point // this.colorScale - the current color scale settings // } return strokeValue; //anychart.graphics.vector.Stroke };`.

Returns:

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

Try it:

Usage sample

selectStroke(color, thickness, dashpattern, lineJoin, lineCap)Since version 7.10.0

Setter for the stroke in selected mode. Learn more about stroke settings.

Params:

Name	Type	Default	Description
color	anychart.graphics.vector.Stroke \| anychart.graphics.vector.ColoredFill \| string \| function \| null		Stroke settings.
thickness	number	1	Line thickness.
dashpattern	string		Controls the pattern of dashes and gaps used to stroke paths.
lineJoin	anychart.graphics.vector.StrokeLineJoin		Line join style.
lineCap	anychart.graphics.vector.StrokeLineCap		Line cap style.

Returns:

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

Try it:

Usage sample

selectionMode

selectionMode()Since version 7.10.0

Getter for the current selection mode.

Returns:

anychart.enums.SelectionMode | null - The current selection mode.

See listing

var currentMode = chart.selectionMode();

selectionMode(value)Since version 7.10.0

Setter for the selection mode.

Detailed description

Allows to select points of the series. To select multiple points, press "ctrl" and click on them.

Params:

Name	Type	Description
value	anychart.enums.SelectionMode \| string \| null	Selection mode.

Returns:

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

Try it:

Usage sample

sort

sort()Since version 7.10.0

Getter for the current sort settings.

Returns:

anychart.enums.Sort - The current sort settings.

Try it:

Usage sample

sort(value)Since version 7.10.0

Setter for the sort settings.
Ascending, Descending and No sorting is supported.

Params:

Name	Type	Default	Description
value	anychart.enums.Sort \| string	"desc"	Sort type.

Returns:

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

Try it:

Usage sample

startSelectMarquee

startSelectMarquee(repeat)Since version 7.14.0

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

Params:

Name	Type	Description
repeat	boolean	Whether to start select marquee drawing.

Returns:

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

Try it:

Usage sample

stroke

stroke()Since version 7.10.0

Getter for the current stroke.

Returns:

anychart.graphics.vector.Stroke | function - The current stroke.

See listing

var chart = anychart.treeMap(data);
var currentStroke = chart.stroke();

stroke(fillFunction)Since version 7.10.0

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

Params:

Name	Type	Default	Description
fillFunction	function	// return stroke from the default palette. function() { return anychart.color.darken(this.sourceColor); };	Stroke-function, which should look like:`function() { // this.value - data value // this.sourceColor - stroke of the current point // this.colorScale - the current color scale settings // } return strokeValue; //anychart.graphics.vector.Stroke };`.

Returns:

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

Try it:

Usage sample

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

Setter for the stroke. Learn more about stroke settings.

Params:

Name	Type	Default	Description
color	anychart.graphics.vector.Stroke \| anychart.graphics.vector.ColoredFill \| string \| null		Stroke settings.
thickness	number	1	Line thickness.
dashpattern	string		Controls the pattern of dashes and gaps used to stroke paths.
lineJoin	anychart.graphics.vector.StrokeLineJoin		Line join style.
lineCap	anychart.graphics.vector.StrokeLineCap		Line cap style.

Returns:

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

Try it:

Usage sample

title

title()

Getter for chart title.

Returns:

anychart.core.ui.Title - The current chart title.

Try it:

Usage sample

title(value)

Setter for the chart title.

Detailed description

Sets chart title settings depending on parameter type:

null/boolean - disable or enable chart title.
string - sets chart title text value.
object - sets chart title settings.

Params:

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

Returns:

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

Try it:

toJson

toJson(stringify, includeTheme)

Return chart configuration as JSON object or string.

Params:

Name	Type	Default	Description
stringify	boolean	false	Returns JSON as string.
includeTheme	boolean	false	If the current theme properties should be included into the result.

Returns:

Object | string - Chart configuration.

Try it:

toSvg

toSvg(paperSize, landscape)Since version 7.5.1

Returns SVG string with paper size and landscape.

Detailed description

Returns SVG string if type of content is SVG otherwise returns empty string.

Params:

Name	Type	Description
paperSize	string \| Object	Paper Size or object of options.
landscape	boolean	Landscape.

Returns:

string - SVG content or empty string.

Try it:

Usage sample

toSvg(width, height)Since version 7.5.1

Returns SVG string with with determined the width and height.

Detailed description

Returns SVG string if type of content is SVG otherwise returns empty string.

Params:

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

Returns:

string - SVG content or empty string.

Try it:

Usage sample

toXml

toXml(asXmlNode, includeTheme)

Return chart configuration as XML string or XMLNode.

Params:

Name	Type	Default	Description
asXmlNode	boolean	false	Return XML as XMLNode.
includeTheme	boolean	false	If the current theme properties should be included into the result.

Returns:

string | Node - Chart configuration.

Try it:

tooltip()Since version 7.7.0

tooltip(value)Since version 7.7.0

Setter for chart tooltip.

Detailed description

Params:

Name	Type	Description
value	Object \| boolean \| null

Returns:

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

Try it:

top

top()

Getter for element top bound setting.

Returns:

number | string | undefined - Current element's top bound setting.

top(value)

Sets element top bound setting.

Params:

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

Returns:

anychart.charts.TreeMap - Returns self 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		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.