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

class anychart.charts.HeatMap Improve this Doc

Extends: anychart.core.SeparateChart

AnyChart HeatMap class.

Methods Overview

Axes and Scales
colorScale()Color scale settings.
grid()Grid settings.
xAxis()X-axis settings.
xScale()X scale settings.
yAxis()Y-axis settings.
yScale()Y scale settings.
Chart Coloring
animation()Animation settings
background()Background settings.
Chart Controls
credits()Credits settings.
label()Label settings.
legend()Legend settings.
title()Title settings.
xScroller()X scroller settings.
yScroller()Y scroller settings.
Coloring
fill()Fill settings.
hatchFill()Hatch fill settings.
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.
Events
listen()Adds an event listener.
listenOnce()Adds a single time event listener.
removeAllListeners()Remove all listeners.
unlisten()Remove of the listener.
unlistenByKey()Remove of the listener by the key.
Export
print()Prints all elements.
Interactivity
enabled()Element state (enabled or disabled).
hover()Sets the hover state on a point by index.
interactivity()Interactivity settings.
select()Imitates selection of the point by its index.
tooltip()Tooltip settings.
Point Elements
hoverLabels()Labels settings in hover mode.
hoverMarkers()Markers settings in hover mode.
labels()Labels settings.
labelsDisplayMode()Labels display mode
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.
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.

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

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:

colorScale

Getter for the current color scale.

Returns:

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

Params:

Name Type Description
value anychart.scales.OrdinalColor Value to set.

Returns:

anychart.charts.HeatMap - 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.ui.title();
 element.container( fwElement.container() );

Try it:

credits

Getter for current chart credits settings.

Returns:

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

Try it:

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

Params:

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

Returns:

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

data

Gets current chart data.

Returns:

anychart.data.View - Current data view.

Try it:

Sets data for the current chart.

Params:

Name Type Description
value anychart.data.View | anychart.data.Set | Array | string Value to set.
csvSettings Object.<string, (string|boolean)> If CSV string is passed by first param, you can pass CSV parser settings here as a hash map.

Returns:

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

draw

Starts the rendering of the chart into the container.

Returns:

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

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 current fill color.

Returns:

anychart.graphics.vector.Fill function - Current fill color.
See listing
var chart = anychart.heatMap(data);
chart.fill();
Sets fill settings using an object 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.HeatMap - 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.index - series index. // this.sourceColor - color returned by fill() getter. // this.iterator - series point iterator. return fillValue; // type anychart.graphics.vector.Fill }.

Returns:

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

Try it:

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

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.

grid

Getter for the current chart grid.

Params:

Name Type Description
index number Chart grid index. If not set - creates a new instance and adds it to the end of array.

Returns:

anychart.core.grids.Linear - Grid instance by index.

Try it:

Setter for the chart grid.

Params:

Name Type Default Description
value Object | boolean | null
false
Grid settings to set.

Returns:

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

Params:

Name Type Description
index number Chart grid index.
value Object | boolean | null Grid settings to set.

Returns:

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

hatchFill

Getter for current hatch fill settings.
See listing
var chart = anychart.heatMap(data);
chart.hatchFill();
Setter for 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.HeatMap - 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:

hover

Sets the hover state on a point by index. Note: Works only after anychart.charts.HeatMap#draw is called.

Params:

Name Type Description
indexOrIndexes number | Array.<number> Point index or array of indexes.

Returns:

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

Try it:

hoverFill

Getter for current fill color in hover mode.

Returns:

anychart.graphics.vector.Fill function - Current fill color.
See listing
var chart = anychart.heatMap(data);
chart.hoverFill();
Sets fill settings in hover mode using an object 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.HeatMap - 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.HeatMap - 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.HeatMap - 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.HeatMap - 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.HeatMap - 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.HeatMap - Self instance for method chaining.

Try it:

hoverHatchFill

Getter for current hatch fill settings in hover mode.
See listing
var chart = anychart.heatMap(data);
chart.hoverHatchFill();
Setter for 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
false
PatternFill or HatchFill instance or type of hatch fill.
color string
Color.
thickness number
Thickness.
size number
Pattern size.

Returns:

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

Try it:

hoverLabels

Getter for the current chart data labels in hover mode.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Setter for chart data labels in hover mode.

Params:

Name Type Description
value Object | boolean | null Chart data labels settings.

Returns:

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

hoverMarkers

Getter for data markers in hover mode.

Returns:

anychart.core.ui.MarkersFactory - Markers instance.

Try it:

Setter for data markers in hover mode.

Params:

Name Type Default Description
value Object | boolean | null | string
false
Data markers settings.

Returns:

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

hoverStroke

Getter for the stroke in hover mode.

Returns:

anychart.graphics.vector.Stroke function - Current stroke in the normal state.
See listing
var chart = anychart.heatMap(data);
chart.hoverStroke();
Setter for the stroke in hover mode using function. Learn more about stroke settings.

Params:

Name Type Default Description
value anychart.graphics.vector.Stroke | function
// return stroke from the default palette.
function() {
  return anychart.color.darken(this.sourceColor);
};
or Stroke, or stroke-function, which should look like:function() { // this: { // index : number - the index of the current point // sourceColor : anychart.graphics.vector.Stroke - stroke of the current point // } return myStroke; //anychart.graphics.vector.Stroke };.

Returns:

anychart.charts.HeatMap - 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.HeatMap - 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 chart data labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Setter for chart data labels.

Params:

Name Type Description
value Object | boolean | null Chart data labels settings.

Returns:

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

labelsDisplayMode

Getter for the current labels display mode.

Returns:

string anychart.enums.LabelsDisplayMode - The current mode.

Try it:

Setter for the labels display mode.

Params:

Name Type Default Description
value string | anychart.enums.LabelsDisplayMode
"drop"
Mode to set.

Returns:

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

Try it:

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

Returns:

Object - Unique key for the listener.

Try it:

margin

Getter for the current chart margin.

Returns:

anychart.core.utils.Margin - The current chart 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.space(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 data markers.

Returns:

anychart.core.ui.MarkersFactory - Markers instance.

Try it:

Setter for data markers.

Params:

Name Type Default Description
value Object | boolean | null | string
false
Data markers settings.

Returns:

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

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

Getter for the current chart padding.

Returns:

anychart.core.utils.Padding - Current chart 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:

select

Imitates selection of the point by its index. Note: Works only after anychart.charts.HeatMap#draw is called.

Params:

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

Returns:

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

Try it:

selectFill

Getter for current fill color in selected mode.

Returns:

anychart.graphics.vector.Fill function - Current fill color.
See listing
var chart = anychart.heatMap(data);
chart.selectFill();
Sets fill settings in selected mode using an object 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.HeatMap - 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.HeatMap - 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.HeatMap - 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.HeatMap - 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.HeatMap - 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.HeatMap - Self instance for method chaining.

Try it:

selectHatchFill

Getter for current hatch fill settings in selected mode.
See listing
var chart = anychart.heatMap(data);
chart.selectHatchFill();
Setter for 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.HeatMap - Self instance for method chaining.

Try it:

selectLabels

Getter for the current chart data labels in selected mode.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Setter for chart data labels in selected mode.

Params:

Name Type Description
value Object | boolean | null Chart data labels settings.

Returns:

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

selectMarkers

Getter for data markers in selected mode.

Returns:

anychart.core.ui.MarkersFactory - Markers instance.

Try it:

Setter for data markers in selected mode.

Params:

Name Type Default Description
value Object | boolean | null | string
false
Data markers settings.

Returns:

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

selectStroke

Getter for the stroke in selected mode.

Returns:

anychart.graphics.vector.Stroke function - Current stroke in the normal state.
See listing
var chart = anychart.heatMap(data);
chart.selectStroke();
Setter for the stroke in selected mode using function. Learn more about stroke settings.

Params:

Name Type Default Description
value anychart.graphics.vector.Stroke | function
// return stroke from the default palette.
function() {
  return anychart.color.darken(this.sourceColor);
};
or Stroke, or stroke-function, which should look like:function() { // this: { // index : number - the index of the current point // sourceColor : anychart.graphics.vector.Stroke - stroke of the current point // } return myStroke; //anychart.graphics.vector.Stroke };.

Returns:

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

Try it:

stroke

Getter for the stroke.

Returns:

anychart.graphics.vector.Stroke function - Current stroke.
See listing
var chart = anychart.heatMap(data);
chart.stroke();
Setter for the stroke using function. Learn more about stroke settings.

Params:

Name Type Default Description
value anychart.graphics.vector.Stroke | function
// return stroke from the default palette.
function() {
  return anychart.color.darken(this.sourceColor);
};
or Stroke, or stroke-function, which should look like:function() { // this: { // index : number - the index of the current point // sourceColor : anychart.graphics.vector.Stroke - stroke of the current point // } return myStroke; //anychart.graphics.vector.Stroke };.

Returns:

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

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 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 scope 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:

xAxis

Getter for the current chart X-axis.

Params:

Name Type Description
index number Chart axis index.

Returns:

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

Try it:

Setter for chart X-axis.

Params:

Name Type Default Description
value Object | boolean | null
true
Chart axis settings to set.

Returns:

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

Params:

Name Type Description
index number Chart axis index.
value Object | boolean | null Chart axis settings to set.

Returns:

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

xScale

Getter for default chart X scale.

Returns:

anychart.scales.Ordinal - Default chart scale value.
See listing
var chart = anychart.heatMap(data);
chart.xScale();
Setter for default chart X scale.

Params:

Name Type Description
value anychart.enums.ScaleTypes | anychart.scales.Ordinal X scale to set.

Returns:

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

Try it:

xScroller

Getter for the current X scroller.

Returns:

anychart.core.ui.ChartScroller - Scroller instance.

Try it:

Setter for the X scroller.

Params:

Name Type Description
value Object | boolean | null X scroller settings.

Returns:

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

yAxis

Getter for the current chart Y-axis.

Params:

Name Type Description
index number Chart axis index.

Returns:

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

Try it:

Setter for chart Y-axis.

Params:

Name Type Description
value Object | boolean | null Chart axis settings to set.

Returns:

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

Params:

Name Type Description
index number Chart axis index.
value Object | boolean | null Chart axis settings to set.

Returns:

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

yScale

Getter for default chart Y scale.

Returns:

anychart.scales.Ordinal - Default chart scale value.
See listing
var chart = anychart.heatMap(data);
chart.yScale();
Setter for default chart Y scale.

Params:

Name Type Description
value anychart.enums.ScaleTypes | anychart.scales.Ordinal Y Scale to set.

Returns:

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

Try it:

yScroller

Getter for the current Y scroller.

Returns:

anychart.core.ui.ChartScroller - Scroller instance.

Try it:

Setter for the Y scroller.

Params:

Name Type Description
value Object | boolean | null Y scroller settings.

Returns:

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

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: