AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.charts.Surface Improve this Doc

Methods Overview

Specific settings
a11y()Accessibility settings.
getType()Returns chart type.
toA11yTable()Creates and returns the chart represented as an invisible HTML table.
toHtmlTable()Creates and returns a chart as HTML table.
Axes and Scales
xAxis()X-axis settings.
xGrid()Grid settings by X-scale.
xScale()X-scale settings.
yAxis()Y-axis settings.
yGrid()Grid settings by Y-scale.
yScale()Y-scale settings.
zAxis()Z-axis settings.
zGrid()Grid settings by Z-scale.
zScale()Z-scale settings.
Chart Coloring
background()Background settings.
box()Box line settings.
colorScale()Color scale settings.
stroke()Mesh stroke settings.
Chart Controls
colorRange()Color range settings.
contextMenu()Context menu settings.
credits()Credits settings
legend()Legend settings.
title()Title settings.
Data
data()Data settings.
getSelectedPoints()Getter for the selected points.
noData()NoData settings.
Events
listen()Adds an event listener.
listenOnce()Adds a single time event listener
removeAllListeners()Removes all listeners.
unlisten()Removes the listener
unlistenByKey()Removes the listener by the key.
Export
exports()Exports settings
getJpgBase64String()Returns JPG as base64 string.
getPdfBase64String()Returns PDF as base64 string.
getPngBase64String()Returns PNG as base64 string.
getSvgBase64String()Returns SVG as base64 string.
print()Prints chart.
saveAsCsv()Saves chart data as a CSV file.
saveAsJpg()Saves the chart as JPEG image.
saveAsJson()Saves chart config as JSON document.
saveAsPdf()Saves the chart as PDF image.
saveAsPng()Saves the chart as PNG image.
saveAsSvg()Saves the chart as SVG image.
saveAsXlsx()Saves chart data as an Excel document.
saveAsXml()Saves chart config as XML document.
shareAsJpg()Shares a chart as a JPG file and returns a link to the shared image.
shareAsPdf()Shares a chart as a PDF file and returns a link to the shared image.
shareAsPng()Shares a chart as a PNG file and returns a link to the shared image.
shareAsSvg()Shares a chart as a SVG file and returns a link to the shared image.
shareWithFacebook()Opens Facebook sharing dialog.
shareWithLinkedIn()Opens LinkedIn sharing dialog.
shareWithPinterest()Opens Pinterest sharing dialog.
shareWithTwitter()Opens Twitter sharing dialog.
toCsv()Returns CSV string with the chart data.
toSvg()Returns SVG string.
Interactivity
enabled()Element state (enabled or disabled).
Size and Position
bottom()Bottom bound settings.
bounds()Bounds settings.
getPixelBounds()Returns pixel bounds of the chart.
height()Height setting.
left()Left bound setting.
margin()Margin settings.
maxHeight()Maximum height setting.
maxWidth()Maximum width setting.
minHeight()Minimum height setting.
minWidth()Minimum width setting.
padding()Padding settings.
right()Right bound settings.
rotationY()Rotational angle by Y-axis.
rotationZ()Rotational angle by Z-axis.
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.
markers()Getter for the surface markers.

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

box

Getter for the box line coloring.

Returns:

anychart.graphics.vector.Stroke - Returns box line settings.
See listing
var box = chart.box();
Setter for box line coloring settings. Learn more about box

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
Box line 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.Surface - Self instance for method chaining.
Setter for box line settings using an object. Learn more about box

Params:

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

Returns:

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

colorRange

Getter for the color range.

Returns:

anychart.core.ui.ColorRange - Return chart color range.
Setter for the color range. Learn more about color range

Params:

NameTypeDescription
settingsObjectColor range settings to set.

Returns:

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

colorScale

Getter for the color scale.

Returns:

anychart.scales.LinearColor - Color scale instance.
See listing
var colorScale = chart.colorScale();
Setter for the color scale. Learn more about color scale

Params:

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

Returns:

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

data

Getter for the data.

Returns:

anychart.data.View - The data view.
See listing
var data = chart.data();
Setter for the data. Learn more about data

Params:

NameTypeDescription
dataanychart.data.Set | Array.<Array.<number>> | stringData to set {(anychart.enums.TextParsingMode|string|anychart.data.TextParsingSettings)=} opt_csvSettings If CSV string is passed by first param, you can pass CSV parser settings here as a hash map.

Returns:

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

enabled

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.
Setter for the element enabled state.

Params:

NameTypeDefaultDescription
enabledboolean
true
Enabled state to set.

Returns:

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

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

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.

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

isFullScreenAvailable

Whether the fullscreen mode available in the browser or not.

Returns:

boolean - isFullScreenAvailable state.

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

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

Setter for the surface markers.

Params:

NameTypeDescription
configanychart.core.surface.markers.Config

Returns:

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

rotationY

Getter for the rotational angle by the Y-axis.

Returns:

number - Returns the rotational angle by the Y-axis
See listing
var rotationY = chart.rotationY();
Setter for the rotational angle by Y-axis. Learn more about rotation

Params:

NameTypeDefaultDescription
anglenumber
35
Rotational angle to set.

Returns:

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

rotationZ

Getter for the rotational angle by the Z-axis.

Returns:

number - Returns the rotational angle by the Z-axis
See listing
var rotationZ = chart.rotationZ();
Setter for the rotational angle by Z-axis. Learn more about rotation

Params:

NameTypeDefaultDescription
anglenumber
17
Rotational angle to set.

Returns:

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

saveAsCsv

Saves chart data as a CSV file.

Params:

NameTypeDescription
chartDataExportModeanychart.enums.ChartDataExportMode | stringData export mode.
csvSettingsObject.<string, (string|boolean|undefined|function(name:*, value:*))>
CSV settings object:
  • rowsSeparator - string or undefined (default is '\n')
  • columnsSeparator - string or undefined (default is ',')
  • ignoreFirstRow - boolean or undefined (default is 'false')
  • formats - Values formatter
  • headers - Headers formatter

Formatters must be represented as one of:
  1. A function with two arguments such as the field name and value, that returns the formatted value.
  2. The object with the key as the field name, and the value as a format function.
filenamestringFile name to save.

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.

saveAsJson

Saves chart config as JSON document.

Params:

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

saveAsXlsx

Saves chart data as an Excel document.

Params:

NameTypeDescription
chartDataExportModeanychart.enums.ChartDataExportMode | stringData export mode.
filenamestringFile name to save.
exportOptionsObject.<string, (function(name:*, value:*))>
Export options:
  • headers - Headers formatter

Formatter must be represented as one of:
  1. A function with two arguments such as the field name and value, that returns the formatted value.
  2. The object with the key as the field name, and the value as a format function.

saveAsXml

Saves chart config as XML document.

Params:

NameTypeDescription
filenamestringFile name to save.

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.

stroke

Getter for the mesh stroke.

Returns:

anychart.graphics.vector.Stroke - Stroke settings.
See listing
var chart = anychart.surface(data);
var stroke = chart.stroke();
Setter for the mesh stroke. Learn more about mesh stroke

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.Surface - Self instance for method chaining.
Setter for mesh stroke settings using an object. Learn more about mesh stroke

Params:

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

Returns:

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

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

xAxis

Getter for the X-axis.

Returns:

anychart.core.axes.Surface - Returns axis instance.
Setter for the X-axis.

Params:

NameTypeDescription
settingsObject | boolean | nullX-axis to set.

Returns:

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

xGrid

Getter for the chart grid by X-scale.

Returns:

anychart.core.grids.Surface - Grid instance.
Setter for the chart grid by X-scale.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
true
Chart grid settings to set.

Returns:

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

xScale

Getter for the X-scale.

Returns:

anychart.scales.Base - Chart X-scale settings.
See listing
var xScale = chart.xScale();
Setter for the X-scale

Params:

NameTypeDefaultDescription
settingsanychart.scales.Base | Object | anychart.enums.ScaleTypes | string
[anychart.scales.Linear]
Scale settings to set.

Returns:

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

yAxis

Getter for the Y-axis.

Returns:

anychart.core.axes.Surface - Returns axis instance.
Setter for the Y-axis.

Params:

NameTypeDescription
settingsObject | boolean | nullY-axis to set.

Returns:

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

yGrid

Getter for the chart grid by Y-scale.

Returns:

anychart.core.grids.Surface - Grid instance.
Setter for the chart grid by Y-scale.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
true
Chart grid settings to set.

Returns:

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

yScale

Getter for the Y-scale.

Returns:

anychart.scales.Base - Chart Y-scale settings.
See listing
var yScale = chart.yScale();
Setter for the Y-scale

Params:

NameTypeDefaultDescription
settingsanychart.scales.Base | Object | anychart.enums.ScaleTypes | string
[anychart.scales.Linear]
Scale settings to set.

Returns:

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

zAxis

Getter for the Z-axis.

Returns:

anychart.core.axes.Surface - Returns axis instance.
Setter for the Z-axis.

Params:

NameTypeDescription
settingsObject | boolean | nullZ-axis to set.

Returns:

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

zGrid

Getter for the chart grid by Z-scale.

Returns:

anychart.core.grids.Surface - Grid instance.
Setter for the chart grid by Z-scale.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
true
Chart grid settings to set.

Returns:

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

zScale

Getter for the Z-scale.

Returns:

anychart.scales.Base - Chart Z-scale settings.
See listing
var zScale = chart.zScale();
Setter for the Z-scale

Params:

NameTypeDefaultDescription
settingsanychart.scales.Base | Object | anychart.enums.ScaleTypes | string
[anychart.scales.Linear]
Scale settings to set.

Returns:

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