Top
You are looking at an outdated 7.12.0 version of this document. Switch to the 7.13.1 version to see the up to date information.

class anychart.charts.TreeMap Improve this Doc

Extends: anychart.core.SeparateChart

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.
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.
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
container()Getter for the element's container.
draw()Drawing of the chart.
saveAsJpg()Saves the current chart as JPEG image.
saveAsPdf()Saves the current chart as PDF image.
saveAsPng()Saves the current chart as PNG image.
saveAsSvg()Saves the current chart as SVG image.
toSvg()Returns SVG string.

Methods Description

animation

Getter for the current animation setting.

Returns:

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

Try it:

Setter for the animation setting by one value.

Params:

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

Returns:

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

Params:

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

Returns:

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

Try it:

background

Getter for the current chart background.

Returns:

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

Try it:

Setter for the chart background.

Params:

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

Returns:

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

Try it:

bottom

Getter for element bottom bound setting.

Returns:

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

Params:

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

Returns:

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

Try it:

bounds

Getter for the element bounds settings.

Returns:

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

Try it:

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

Try it:

colorRange

Getter for the current color range.

Returns:

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

Try it:

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:

colorScale

Getter for the current color scale.

Returns:

anychart.scales.OrdinalColor anychart.scales.LinearColor - The current color scale.
See listing.
var currentColorScale = chart.colorScale();
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

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

Params:

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

Returns:

anychart.core.Chart - Self instance for method chaining.
Example
// string
 element.container('containerIdentifier');
// DOM-element
 var domElement = document.getElementById('containerIdentifier');
 element.container(domElement);
// Framework-element
 var fwElement = anychart.standalones.title();
 element.container( fwElement.container() );

Try it:

credits

Getter for the current credits.

Returns:

anychart.core.ui.ChartCredits - Chart credits.

Try it:

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

Params:

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

Returns:

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

data

Getter for the current data.

Returns:

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

Try it:

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.

draw

Starts the rendering of the chart into the container.

Params:

Name Type Description
async boolean Whether do draw asynchronously. If set to true, the chart will be drawn asynchronously

Returns:

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

drillTo

Drills down to target.

Params:

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

Try it:

drillUp

Drills one level up from current level.

Try it:

enabled

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

Returns:

boolean - The current element state.

Try it:

Setter for the element enabled state.

Params:

Name Type Default Description
value boolean
true
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.
Example.
if (!element.enabled())
   element.enabled(true);

Try it:

fill

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();
Sets fill settings using an array or a string. Learn more about coloring.

Params:

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

Returns:

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

Params:

Name Type Default Description
fillFunction function
function() {
 return anychart.color.darken(this.sourceColor);
}
Function that looks like function(){ // this.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:

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

Params:

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

Returns:

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

Try it:

Linear gradient fill. Learn more about coloring.

Params:

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

Returns:

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

Try it:

Radial gradient fill. Learn more about coloring.

Params:

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

Returns:

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

Try it:

Image fill. Learn more about coloring.

Params:

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

Returns:

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

Try it:

getDrilldownPath

Returns crumbs from the root to the current level.

Returns:

Array - The current path.

Try it:

getPixelBounds

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

Returns:

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

globalToLocal

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

Params:

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

Returns:

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

Try it:

hatchFill

Getter for 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();
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:

headers

Getter for the current point header labels.

Returns:

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

Try it:

Setter for the point header labels.

Params:

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

Returns:

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

headersDisplayMode

Getter for the current headers display mode.

Returns:

string anychart.enums.LabelsDisplayMode - The current mode.

Try it:

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:

height

Getter for element height setting.

Returns:

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

Params:

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

Returns:

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

Try it:

hintDepth

Getter for the current additional segmentation of treeMap points.

Returns:

number - Hint depth value.

Try it:

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:

hintOpacity

Getter for the current hint opacity.

Returns:

number - The current hint opacity.

Try it:

Setter for current hint opacity.

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:

hoverFill

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

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

Params:

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

Returns:

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

Try it:

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:

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:

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:

hoverHatchFill

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

hoverHeaders

Getter for the current hover header labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Setter for the hover header labels.

Params:

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

Returns:

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

hoverLabels

Getter for the current point hover labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Setter for the point hover labels.

Params:

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

Returns:

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

hoverMarkers

Getter for the current point hover markers.

Returns:

anychart.core.ui.MarkersFactory - Markers instance.

Try it:

Setter for the point hover markers.

Params:

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

Returns:

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

hoverStroke

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

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

Params:

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

interactivity

Gets the current interactivity settings for chart.

Returns:

anychart.core.utils.Interactivity - The current interactivity settings.
Sets interactivity settings for chart.

Params:

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

Returns:

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

Try it:

label

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:

Setter for chart label.

Params:

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

Returns:

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

Params:

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

Returns:

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

labels

Getter for the current point labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Setter for the point labels.

Params:

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

Returns:

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

left

Getter for element left bound setting.

Returns:

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

Params:

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

Returns:

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

Try it:

legend

Getter for the current chart legend.

Returns:

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

Try it:

Setter for chart legend setting.

Params:

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

Returns:

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

listen

Adds an event listener to an implementing object.

Params:

Name Type 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 Whether to fire in capture phase (defaults to false).
listenerScope Object Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

listenOnce

Adds an event listener to an implementing object.

Params:

Name Type Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope Object Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

localToGlobal

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

Params:

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

Returns:

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

Try it:

margin

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

Params:

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

Returns:

anychart.core.Chart - Self instance for method chaining.
Example.
// all margins 15px
chart.margin(15);
// all margins 15px
chart.margin("15px");
// top and bottom 5px, right and left 15px
chart.margin(anychart.utils.margin(5, 15));

Try it:

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

Params:

Name Type Default Description
value1 string | number
0
Top or top-bottom space.
value2 string | number
0
Right or right-left space.
value3 string | number
0
Bottom space.
value4 string | number
0
Left space.

Returns:

anychart.core.Chart - Self instance for method chaining.
Example.
// 1) all 10px
chart.margin(10);
// 2) top and bottom 10px, left and right 15px
chart.margin(10, "15px");
// 3) top 10px, left and right 15px, bottom 5px
chart.margin(10, "15px", 5);
// 4) top 10px, right 15px, bottom 5px, left 12px
chart.margin(10, "15px", "5px", 12);

Try it:

markers

Getter for the current point markers.

Returns:

anychart.core.ui.MarkersFactory - Markers instance.

Try it:

Setter for the point markers.

Params:

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

Returns:

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

maxDepth

Getter for the current maximal drawing depth.

Returns:

number - The current maximal drawing depth.

Try it:

Setter for the maximal drawing depth.

Params:

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

Returns:

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

Try it:

maxHeadersHeight

Getter for the current maximum headers height.

Returns:

number string - The current maximum headers height.

Try it:

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:

maxHeight

Getter for maximum height.

Returns:

number string null - Current element's maximum height.
Setter for maximum height.

Params:

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

Returns:

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

Try it:

maxWidth

Getter for maximum width.

Returns:

number string null - Current element's maximum width.
Setter for maximum width.

Params:

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

Returns:

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

Try it:

minHeight

Getter for minimum height.

Returns:

number string null - Current element's minimum height.
Setter for minimum height.

Params:

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

Returns:

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

Try it:

minWidth

Getter for minimum width.

Returns:

number string null - Current element's minimum width.
Setter for minimum width.

Params:

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

Returns:

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

Try it:

padding

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

Params:

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

Returns:

anychart.core.Chart - Self instance for method chaining.
Example.
chart.padding([5, 15]);
or
chart.padding({left: 10, top: 20, bottom: 30, right: "40%"}});

Try it:

Setter for the chart paddings in pixels using several numbers.

Params:

Name Type Default Description
value1 string | number
0
Top or top-bottom space.
value2 string | number
0
Right or right-left space.
value3 string | number
0
Bottom space.
value4 string | number
0
Left space.

Returns:

anychart.core.Chart - Self instance for method chaining.
Example.
// 1) all 10px
chart.padding(10);
// 2) top and bottom 10px, left and right 15px
chart.padding(10, "15px");
// 3) top 10px, left and right 15px, bottom 5px
chart.padding(10, "15px", 5);
// 4) top 10px, right 15%, bottom 5px, left 12px
chart.padding(10, "15%", "5px", 12);

Try it:

print

Prints all elements on related stage.

Params:

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

Try it:

removeAllListeners

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

Params:

Name Type Description
type string Type of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

Try it:

Getter for element right bound setting.

Returns:

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

Params:

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

Returns:

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

Try it:

saveAsJpg

Saves the current chart as JPEG image.

Params:

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

Try it:

saveAsPdf

Saves the current chart as PDF image.

Params:

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

Try it:

saveAsPng

Saves the current chart as PNG image.

Params:

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

Try it:

saveAsSvg

Saves the current chart as SVG image.

Params:

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

Try it:

Saves the stage as SVG image using width and height.

Params:

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

Try it:

selectFill

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

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

Params:

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

Returns:

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

Try it:

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:

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:

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:

selectHatchFill

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

selectLabels

Getter for the current point select labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Setter for the point select labels.

Params:

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

Returns:

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

selectMarkers

Getter for the current point select markers.

Returns:

anychart.core.ui.MarkersFactory - Markers instance.

Try it:

Setter for the point select markers.

Params:

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

Returns:

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

selectStroke

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

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

Params:

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

selectionMode

Getter for the current selection mode.

Returns:

anychart.enums.SelectionMode null - The current selection mode.
See listing
var currentMode = chart.selectionMode();
Setter for the selection mode.

Params:

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

Returns:

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

Try it:

sort

Getter for the current sort settings.

Returns:

anychart.enums.Sort - The current sort settings.

Try it:

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:

stroke

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

Setter for the stroke. Learn more about stroke settings.

Params:

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

title

Getter for chart title.

Returns:

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

Try it:

Setter for the chart title.

Params:

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

Returns:

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

toJson

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.

toSvg

Returns SVG string with paper size and landscape.

Params:

Name Type Description
paperSize string Paper Size.
landscape boolean Landscape.

Returns:

string - SVG content or empty string.

Try it:

Returns SVG string with with determined the width and height.

Params:

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

Returns:

string - SVG content or empty string.

Try it:

toXml

Return chart configuration as XML string or XMLNode.

Params:

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

Returns:

string Node - Chart configuration.

tooltip

Getter for current chart tooltip.

Returns:

anychart.core.ui.ChartTooltip anychart.core.ui.Tooltip - An instance of the class for method chaining.
Example
var tooltipSettings = chart.tooltip();
Setter for chart tooltip.

Params:

Name Type Description
value Object | boolean | null

Returns:

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

top

Getter for element top bound setting.

Returns:

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

Params:

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

Returns:

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

Try it:

unlisten

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

Params:

Name Type Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope Object Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

Try it:

unlistenByKey

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

Params:

Name Type Description
key Object The key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

Try it:

width

Getter for element width setting.

Returns:

number string undefined - Current element's width setting.
Sets element width setting.

Params:

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

Returns:

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

Try it:

zIndex

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.

Try it:

Setter for the Z-index of the element.

Params:

Name Type Default Description
value number
0
Value to set.

Returns:

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

Try it: