AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.charts.TreeMap Improve this Doc

Methods Overview

Specific settings
a11y()Accessibility settings.
getType()Returns chart type.
globalToLocal()Converts the global coordinates to local coordinates.
hintDepth()The number of hint-levels
localToGlobal()Converts the local coordinates to global coordinates.
maxDepth()Maximum depth of levels headlines
selectionMode()Selection mode
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.
Chart Controls
colorRange()Color range settings.
contextMenu()Context menu settings.
credits()Credits settings
label()Label settings.
legend()Legend settings.
title()Title settings.
Chart coloring
hintOpacity()Hint opacity settings
Coloring
background()Background settings.
fill()Fill settings.
hatchFill()Hatch fill settings.
stroke()Stroke settings.
Data
data()Data settings.
getSelectedPoints()Getter for the selected points.
noData()NoData settings.
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
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.
saveAsJpg()Saves the chart as JPEG image.
saveAsPdf()Saves the chart as PDF image.
saveAsPng()Saves the chart as PNG image.
saveAsSvg()Saves the chart as SVG image.
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
drillTo()Drills down to target.
drillUp()Drills one level up from current level.
getDrilldownPath()Returns crumbs from the root to the current level.
hovered()Hovered state settings.
normal()Normal state settings.
selected()Selected state settings.
tooltip()Tooltip settings.
Point Elements
headers()Header labels settings.
headersDisplayMode()Header labels display mode.
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.
maxHeadersHeight()Maximum headers height
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.
container()Chart container
draw()Chart drawing
fullScreen()Fullscreen mode.
id()Chart id.
isFullScreenAvailable()Whether the fullscreen mode available in the browser or not.

Methods Description

a11y

Getter for the accessibility settings.

Returns:

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

Params:

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

Returns:

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

autoRedraw

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

Returns:

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

Params:

NameTypeDefaultDescription
enabledboolean
true
Value to set.

Returns:

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

background

Getter for the chart background.

Returns:

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

Params:

NameTypeDescription
settingsstring | Object | null | booleanBackground settings to set.

Returns:

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

bottom

Getter for the chart's bottom bound setting.

Returns:

number | string | undefined - Chart's bottom bound settings.
See listing
var bottom = chart.bottom();
Setter for the chart's top bound setting.

Params:

NameTypeDescription
bottomnumber | string | nullBottom bound for the chart.

Returns:

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

bounds

Getter for the chart bounds settings.

Returns:

anychart.core.utils.Bounds - Bounds of the element.
See listing
var bounds = chart.bounds();
Setter for the chart bounds using one parameter.

Params:

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

Returns:

anychart.charts.TreeMap - Self instance for method chaining.
Setter for the chart bounds settings.

Params:

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

Returns:

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

colorRange

Getter for the color range.

Returns:

anychart.core.ui.ColorRange - Color range.
Setter for the color range.

Params:

NameTypeDescription
settingsObjectColor range settings to set.

Returns:

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

colorScale

Getter for the color scale.
See listing.
var colorScale = chart.colorScale();
Setter for the color scale. Learn more about color scale

Params:

NameTypeDescription
settingsanychart.scales.OrdinalColor | anychart.scales.LinearColor | Object | anychart.enums.ScaleTypes | stringColor scale to set.

Returns:

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

container

Getter for the chart container.
Setter for the chart container.

Params:

NameTypeDescription
elementanychart.graphics.vector.Layer | anychart.graphics.vector.Stage | string | ElementThe value to set.

Returns:

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

contextMenu

Getter for the context menu.

Returns:

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

Params:

NameTypeDescription
settingsObject | boolean | nullContext menu settings

Returns:

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

credits

Getter for chart credits.

Returns:

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

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
true
Credits settings

Returns:

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

data

Getter for the data.

Returns:

anychart.data.Tree | anychart.data.TreeView - Return the data tree.
Setter for the data.

Params:

NameTypeDescription
dataanychart.data.Tree | anychart.data.TreeView | Array.<Object>Data tree or raw data.
fillMethodanychart.enums.TreeFillingMethod | stringFill method.

Returns:

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

draw

Starts the rendering of the chart into the container.

Params:

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

Returns:

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

drillTo

Drills down to target.
Learn more about drilldown

Params:

NameTypeDescription
targetanychart.data.Tree.DataItem | Array | stringTarget to drill down to.

drillUp

Drills one level up from current level.
Learn more about drilldown

exports

Getter for the export charts.

Returns:

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

Params:

NameTypeDescription
settingsObjectExport settings.

Returns:

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

fill

Getter for the fill color.

Returns:

anychart.graphics.vector.Fill | function - The fill color.
See listing
var chart = anychart.treeMap(data);
var fill = chart.fill();
Setter for fill settings using an array, an object or a string. Learn more about coloring.

Params:

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

Returns:

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

Params:

NameTypeDefaultDescription
fillFunctionfunction():anychart.graphics.vector.Fill
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.
Fill color with opacity. Fill as a string or an object.

Params:

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

Returns:

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

Params:

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

Returns:

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

Params:

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

Returns:

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

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

fullScreen

Getter for the fullscreen mode.

Returns:

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

Params:

NameTypeDefaultDescription
enabledboolean
false
Enable/Disable fullscreen mode.

Returns:

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

getDrilldownPath

Returns crumbs from the root to the current level.
Learn more about drilldown

Returns:

Array - Returns the current path.

getJpgBase64String

Returns JPG as base64 string.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
widthnumberImage width.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.
forceTransparentWhitebooleanForce transparent to white or not.

getPdfBase64String

Returns PDF as base64 string.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
paperSizeOrWidthnumber | stringAny paper format like 'a0', 'tabloid', 'b4', etc.
landscapeOrWidthnumber | booleanDefine, is landscape.
xnumberOffset X.
ynumberOffset Y.

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.

getPngBase64String

Returns PNG as base64 string.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
widthnumberImage width.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.

getSelectedPoints

Getter for the selected points.

Returns:

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

getSvgBase64String

Returns SVG as base64 string.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
paperSizeOrWidthstring | numberPaper Size or width.
landscapeOrHeightboolean | stringLandscape or height.

getType

Returns chart type.

Returns:

string - Chart type.

globalToLocal

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

Params:

NameTypeDescription
xCoordnumberGlobal X coordinate.
yCoordnumberGlobal Y coordinate.

Returns:

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

hatchFill

Getter for hatch fill settings.
See listing
var chart = anychart.treeMap(data);
var hatchFill = chart.hatchFill();
Setter for the hatch fill settings.

Params:

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

Returns:

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

Params:

NameTypeDescription
hatchFillFunctionfunctionHatchFill function.

Returns:

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

Params:

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

Returns:

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

Params:

NameTypeDescription
settingsanychart.graphics.vector.HatchFillHatch fill instance.

Returns:

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

Params:

NameTypeDefaultDescription
enabledboolean
false
Whether to enable hatch fill or no.

Returns:

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

headers

Getter for the point header labels.

Returns:

anychart.core.ui.LabelsFactory - The point header labels.
Setter for the point header labels.
Learn more about headers

Params:

NameTypeDescription
settingsObject | boolean | nullPoint headers settings.

Returns:

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

headersDisplayMode

Getter for the headers display mode.

Returns:

anychart.enums.LabelsDisplayMode | string - Headers display mode.
Setter for the headers display mode.
Learn more about display mode

Params:

NameTypeDescription
modeanychart.enums.LabelsDisplayMode | stringMode to set.

Returns:

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

height

Getter for the chart's height setting.

Returns:

number | string | undefined - Chart's height setting.
See listing
var height = chart.height();
Setter for the chart's height setting.

Params:

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

Returns:

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

hintDepth

Getter for the additional segmentation of treeMap points.

Returns:

number - Hint depth value.
Setter for the additional segmentation of treeMap points.

Params:

NameTypeDefaultDescription
hintDepthnumber
0
Additional depth of visibility.

Returns:

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

hintOpacity

Getter for the hint opacity.

Returns:

number - Hint opacity.
Setter for the hint opacity.

Params:

NameTypeDefaultDescription
hintOpacitynumber
0.4
Opacity value from 0 to 1

Returns:

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

hovered

Getter for hovered state settings.

Returns:

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

Params:

NameTypeDescription
settingsObjectState settings to set.

Returns:

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

id

Getter for chart id.

Returns:

string - Return chart id.
Setter for chart id.

Params:

NameTypeDescription
idstringChart id.

Returns:

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

isFullScreenAvailable

Whether the fullscreen mode available in the browser or not.

Returns:

boolean - isFullScreenAvailable state.

label

Getter for the chart label.

Params:

NameTypeDefaultDescription
indexstring | number
0
Index of instance.

Returns:

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

Params:

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

Returns:

anychart.charts.TreeMap - Self instance for method chaining.
Setter for chart label using index.

Params:

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

Returns:

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

labels

Getter for the point labels.

Returns:

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

Params:

NameTypeDescription
settingsObject | boolean | nullPoint labels settings.

Returns:

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

labelsDisplayMode

Getter for the labels display mode.

Returns:

anychart.enums.LabelsDisplayMode | string - Labels display mode.
See listing
var labelsDisplayMode = chart.labelsDisplayMode();
Setter for the labels display mode.

Params:

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

Returns:

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

left

Getter for the chart's left bound setting.

Returns:

number | string | undefined - Chart's left bound setting.
See listing
var left = chart.left();
Setter for the chart's left bound setting.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Left bound setting for the chart.

Returns:

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

legend

Getter for the chart legend.

Returns:

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

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
false
Legend settings.

Returns:

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

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
Callback method. Function that looks like:
function(event){
   // event.actualTarget - actual event target
   // event.currentTarget - current event target
   // event.iterator - event iterator
   // event.originalEvent - original event
   // event.point - event point
   // event.pointIndex - event point index
}
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

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

Returns:

Object - Unique key for the listener.

localToGlobal

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

Params:

NameTypeDescription
xCoordnumberLocal X coordinate.
yCoordnumberLocal Y coordinate.

Returns:

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

margin

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

Params:

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

Params:

NameTypeDefaultDescription
value1string | number
0
Top or top-bottom space.
value2string | number
0
Right or right-left space.
value3string | number
0
Bottom space.
value4string | number
0
Left space.

Returns:

anychart.charts.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);

markers

Getter for point markers.

Returns:

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

Params:

NameTypeDescription
settingsObject | boolean | null | stringPoint markers settings.

Returns:

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

maxDepth

Getter for the maximum drawing depth.

Returns:

number - Returns the maximal drawing depth.
Setter for the maximum drawing depth.

Params:

NameTypeDefaultDescription
maxDepthnumber
1
Max depth to draw.

Returns:

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

maxHeadersHeight

Getter for the maximum headers height.

Returns:

number | string - Maximum headers height.
Setter for the maximum headers height.
Learn more about headers

Params:

NameTypeDefaultDescription
heightnumber | string
25
Max headers height value. A height can be set as absolute numbers or as a percentage.

Returns:

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

maxHeight

Getter for the chart's maximum height.

Returns:

number | string | null - Chart's maximum height.
See listing
var maxHeight = chart.maxHeight();
Setter for the chart's maximum height.

Params:

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

Returns:

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

maxWidth

Getter for the chart's maximum width.

Returns:

number | string | null - Chart's maximum width.
See listing
var maxWidth = chart.maxWidth();
Setter for the chart's maximum width.

Params:

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

Returns:

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

minHeight

Getter for the chart's minimum height.

Returns:

number | string | null - Chart's minimum height.
See listing
var minHeight = chart.minHeight();
Setter for the chart's minimum height.

Params:

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

Returns:

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

minWidth

Getter for the chart's minimum width.

Returns:

number | string | null - Chart's minimum width.
See listing
var minWidth = chart.minWidth();
Setter for the chart's minimum width.

Params:

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

Returns:

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

noData

Getter for noData settings.

Returns:

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

Params:

NameTypeDescription
settingsObjectNoData settings.

Returns:

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

normal

Getter for normal state settings.

Returns:

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

Params:

NameTypeDescription
settingsObjectState settings to set.

Returns:

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

padding

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

Params:

NameTypeDefaultDescription
paddingArray.<(number|string)> | Object
{top: 0, right: 0, bottom: 0, left: 0}
Value to set.

Returns:

anychart.charts.TreeMap - Self instance for method chaining.
See listing.
chart.padding([5, 15]);
or
chart.padding({left: 10, top: 20, bottom: 30, right: "40%"}});
Setter for the chart paddings in pixels using several numbers.

Params:

NameTypeDefaultDescription
value1string | number
0
Top or top-bottom space.
value2string | number
0
Right or right-left space.
value3string | number
0
Bottom space.
value4string | number
0
Left space.

Returns:

anychart.charts.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);

print

Prints chart.

Params:

NameTypeDefaultDescription
paperSizeanychart.graphics.vector.PaperSize
Paper size.
landscapeboolean
false
Flag of landscape.

removeAllListeners

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

Params:

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

Returns:

number - Number of listeners removed.
Getter for the chart's right bound setting.

Returns:

number | string | undefined - Chart's right bound setting.
See listing
var right = chart.right();
Setter for the chart's right bound setting.

Params:

NameTypeDescription
rightnumber | string | nullRight bound for the chart.

Returns:

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

saveAsJpg

Saves the chart as JPEG image.

Params:

NameTypeDescription
widthnumberImage width.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.
forceTransparentWhitebooleanDefine, should we force transparent to white background.
filenamestringFile name to save.

saveAsPdf

Saves the chart as PDF image.

Params:

NameTypeDescription
paperSizestringAny paper format like 'a0', 'tabloid', 'b4', etc.
landscapebooleanDefine, is landscape.
xnumberOffset X.
ynumberOffset Y.
filenamestringFile name to save.

saveAsPng

Saves the chart as PNG image.

Params:

NameTypeDescription
widthnumberImage width.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.
filenamestringFile name to save.

saveAsSvg

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

Params:

NameTypeDescription
paperSizestringPaper Size.
landscapebooleanLandscape.
filenamestringFile name to save.
Saves the stage as SVG image using width and height.

Params:

NameTypeDescription
widthnumberImage width.
heightnumberImage height.

selected

Getter for selected state settings.

Returns:

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

Params:

NameTypeDescription
settingsObjectState settings to set.

Returns:

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

selectionMode

Getter for the selection mode.

Returns:

anychart.enums.SelectionMode | string | null - Selection mode.
See listing
var selectionMode = chart.selectionMode();
Setter for the selection mode.

Params:

NameTypeDescription
valueanychart.enums.SelectionMode | string | nullSelection mode.

Returns:

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

shareAsJpg

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

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
asBase64booleanShare as base64 file.
widthnumberImage width.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.
forceTransparentWhitebooleanForce transparent to white or not.
filenamestringFile name to save.

shareAsPdf

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

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
asBase64booleanShare as base64 file.
paperSizeOrWidthnumber | stringAny paper format like 'a0', 'tabloid', 'b4', etc.
landscapeOrWidthnumber | booleanDefine, is landscape.
xnumberOffset X.
ynumberOffset Y.
filenamestringFile name to save.

shareAsPng

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

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
asBase64booleanShare as base64 file.
widthnumberImage width.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.
filenamestringFile name to save.

shareAsSvg

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

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
asBase64booleanShare as base64 file.
paperSizeOrWidthstring | numberPaper Size or width.
landscapeOrHeightboolean | stringLandscape or height.
filenamestringFile name to save.

shareWithFacebook

Opens Facebook sharing dialog.

Params:

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

shareWithLinkedIn

Opens LinkedIn sharing dialog.

Params:

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

shareWithPinterest

Opens Pinterest sharing dialog.

Params:

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

shareWithTwitter

Opens Twitter sharing dialog.

sort

Getter for the sort settings.

Returns:

anychart.enums.Sort | string - Sort settings.
Setter for the sort settings.
Ascending, Descending and No sorting is supported. Learn more about sorting

Params:

NameTypeDefaultDescription
typeanychart.enums.Sort | string
'desc'
Sort type.

Returns:

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

stroke

Getter for the stroke.
See listing
var chart = anychart.treeMap(data);
var stroke = chart.stroke();
Setter for the stroke using function. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
strokeFunctionfunction():anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFill
// 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.
Setter for the stroke. Learn more about stroke settings.

Params:

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

Returns:

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

Params:

NameTypeDescription
settingsObjectObject with stroke settings from anychart.graphics.vector.Stroke

Returns:

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

title

Getter for the chart title.

Returns:

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

Params:

NameTypeDefaultDescription
settingsnull | boolean | Object | string
false
Chart title text or title instance for copy settings from.

Returns:

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

toA11yTable

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

Params:

NameTypeDescription
titlestringTitle to set.
asStringbooleanDefines 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.

toCsv

Returns CSV string with the chart data.

Params:

NameTypeDescription
chartDataExportModeanychart.enums.ChartDataExportMode | stringData export mode.
csvSettingsObject.<string, (string|boolean|undefined|function(name:*, value:*)|Object)>CSV settings.
CSV settings object:
rowsSeparator - string or undefined (default is '\n')
columnsSeparator - string or undefined (default is ',')
ignoreFirstRow - boolean or undefined (default is 'false')
formats -
1) a function with two arguments such as the field name and value, that returns the formatted value
or
2) the object with the key as the field name, and the value as a format function.
(default is 'undefined').

Returns:

string - CSV string.

toHtmlTable

Creates and returns a chart as HTML table.

Params:

NameTypeDescription
titlestringTitle to set.
asStringbooleanDefines 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.

toJson

Returns chart configuration as JSON object or string.

Params:

NameTypeDefaultDescription
stringifyboolean
false
Returns JSON as string.

Returns:

Object | string - Chart configuration.

toSvg

Returns SVG string using paper size and landscape.

Params:

NameTypeDescription
paperSizestringPaper Size.
landscapebooleanLandscape.

Returns:

string - SVG content or empty string.
Returns SVG string using width and height.

Params:

NameTypeDescription
widthnumberImage width.
heightnumberImage height.

Returns:

string - SVG content or empty string.

toXml

Returns chart configuration as XML string or XMLNode.

Params:

NameTypeDefaultDescription
asXmlNodeboolean
false
Return XML as XMLNode.

Returns:

string | Node - Chart configuration.

tooltip

Getter for chart tooltip.

Returns:

anychart.core.ui.Tooltip - Tooltip instance.
Setter for chart tooltip.

Params:

NameTypeDescription
settingsObject | boolean | nullValue to set.

Returns:

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

top

Getter for the chart's top bound setting.

Returns:

number | string | undefined - Chart's top bound settings.
See listing
var top = chart.top();
Setter for the chart's top bound setting.

Params:

NameTypeDescription
topnumber | string | nullTop bound for the chart.

Returns:

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

unlisten

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

Params:

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

Returns:

boolean - Whether any listener was removed.

unlistenByKey

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

Params:

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

Returns:

boolean - Whether any listener was removed.

width

Getter for the chart's width setting.

Returns:

number | string | undefined - Chart's width setting.
See listing
var width = chart.width();
Setter for the chart's width setting.

Params:

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

Returns:

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

zIndex

Getter for the Z-index of the chart.

Returns:

number - Chart Z-index.
See listing
var zIndex = chart.zIndex();
Setter for the Z-index of the chart.

Params:

NameTypeDefaultDescription
zIndexnumber
0
Z-index to set.

Returns:

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