class anychart.charts.Stock Improve this Doc

Stock chart class.
Note: Use anychart#stock method to get an instance of this class.

Methods Overview

Specific settings
annotations()	Gets annotations.
getPlotsCount()	Returns plots count.
globalToLocal()	Converts the global coordinates to local coordinates.
localToGlobal()	Converts the local coordinates to global coordinates.
plot()	Plots settings.
scroller()	Scroller settings.
Axes and Scales
xScale()	X-scale settings.
Chart Coloring
animation()	Animation settings
background()	Background settings.
Chart Controls
contextMenu()	Context menu settings.
credits()	Credits settings
label()	Label settings.
title()	Title settings.
Coloring
selectMarqueeFill()	Select marquee fill settings.
selectMarqueeStroke()	Stroke settings.
zoomMarqueeFill()	Zoom marquee fill settings.
zoomMarqueeStroke()	Stroke settings.
Data
getSelectedPoints()	Getter for the selected points.
getSelectedRange()	Gets selected range.
getStat()	Getter for a statistical value by the key.
grouping()	Grouping settings.
scrollerGrouping()	Scroller grouping 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
print()	Prints all elements.
saveAsCsv()	Saves chart data as a CSV file.
saveAsJson()	Saves chart config as JSON document.
saveAsXlsx()	Saves chart data as an Excel document.
saveAsXml()	Saves chart config as XML document.
toCsv()	Returns CSV string with the chart data.
Interactivity
crosshair()	Crosshair settings
interactivity()	Interactivity settings.
preserveSelectedRangeOnDataUpdate()	Selected Range Change Behaviour
startSelectMarquee()	Starts select marquee drawing.
startZoomMarquee()	Starts zoom marquee.
tooltip()	Tooltip settings.
Point Elements
eventMarkers()	Event markers settings
Size and Position
bottom()	Bottom bound settings.
bounds()	Bounds settings.
getPixelBounds()	Returns pixel bounds.
height()	Height settings.
left()	Left bound settings.
margin()	Margin settings.
maxHeight()	Maximum height.
maxWidth()	Maximum width.
minHeight()	Minimum height.
minWidth()	Minimum width.
padding()	Padding settings.
right()	Right bound settings.
top()	Top bound settings.
width()	Width settings.
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
autoRedraw()	Redraw chart after changes or not.
cancelMarquee()	Stops current marquee action if any.
container()	Getter for the element's container.
draw()	Drawing of the chart.
inMarquee()	Gets marquee process running value.
saveAsJpg()	Saves the current chart as JPEG image.
saveAsPdf()	Saves the current chart as PDF image.
saveAsPng()	Saves the current chart as PNG image.
saveAsSvg()	Saves the current chart as SVG image.
selectRange()	Setter for the select range using date.
toSvg()	Returns SVG string.

Methods Description

animation

animation()

Getter for animation settings.

Returns:

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

Try it:

Usage sample

animation(value)

Setter for animation settings by one value.

Detailed description

Sets animation settings depending on parameter type:

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

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

Params:

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

Returns:

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

Try it:

animation(enabled, duration)

Setter for animation settings using several parameters.

Detailed description

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

Params:

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

Returns:

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

Try it:

Usage sample

annotations

annotations() Since version 7.11.0

Return stock annotations.

Returns:

anychart.core.annotations.ChartController - The annotations controller.

Try it:

Usage sample

autoRedraw

autoRedraw() Since version 8.1.0

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

autoRedraw(value) Since version 8.1.0

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

Params:

Name	Type	Default	Description
value	boolean	true	Value to set.

Returns:

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

Try it:

Usage sample

background

background()

Getter for the chart background.

Returns:

anychart.core.ui.Background - Chart background.

Try it:

Usage sample

background(value)

Setter for the chart background.

Params:

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

Returns:

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

Try it:

Usage sample

bottom

bottom()

Getter for element bottom bound settings.

Returns:

number string undefined - Element's bottom bound setting.

bottom(value)

Setter for element bottom bound settings.

Params:

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

Returns:

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

Try it:

Usage sample

bounds

bounds()

Getter for element bounds settings.

Returns:

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

bounds(value)

Setter for 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:

Usage sample

bounds(x, y, width, height)

Setter for 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:

Usage sample

cancelMarquee

cancelMarquee() Since version 7.14.0

Stops current marquee action if any.

Returns:

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

container

container()

Getter for the element's container.

Returns:

anychart.graphics.vector.Layer anychart.graphics.vector.Stage - Element's container.

container(value)

Setter for the element's container.

Detailed description

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

Params:

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

Returns:

anychart.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:

Usage sample

contextMenu

contextMenu() Since version 7.10.0

Getter for the context menu.

Returns:

anychart.ui.ContextMenu - Context menu.

Try it:

Usage sample

contextMenu(value) Since version 7.10.0

Setter for the context menu.

Detailed description

Sets context menu settings depending on parameter type:

null/boolean - disable or enable context menu.
object - sets context menu settings.

Params:

Name	Type	Description
value	Object \| boolean \| null	Context menu settings

Returns:

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

Try it:

credits

credits()

Getter for the credits.

Returns:

anychart.core.ui.ChartCredits - Chart credits.

Try it:

Usage sample

credits(value)

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

Detailed description

Note: You can't customize credits without your licence key. To buy licence key go to Buy page.
Sets chart credits settings depending on parameter type:

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

Params:

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

Returns:

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

Try it:

crosshair

crosshair() Since version 8.0.0

Getter for crosshair settings.

Returns:

anychart.core.ui.Crosshair - Crosshair settings.

Try it:

Usage sample

crosshair(value) Since version 8.0.0

Setter for crosshair settings.
The plot crosshair settings have a higher priority than the chart crosshair settings.

Detailed description

Sets chart crosshair settings depending on parameter type:

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

Params:

Name	Type	Description
value	Object \| boolean \| null	Crosshair settings.

Returns:

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

Try it:

draw

draw(async)

Starts the rendering of the chart into the container.

Params:

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

Returns:

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

Try it:

eventMarkers

eventMarkers() Since version 8.1.0

Getter for the event markers controller.

Returns:

anychart.core.stock.eventMarkers.Controller - Chart controller instance.

Try it:

Usage sample

eventMarkers(value) Since version 8.1.0

Setter for the event markers controller.

Params:

Name	Type	Default	Description
value	Object \| boolean \| null	true	Value to set.

Returns:

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

Try it:

Usage sample

exports

exports() Since version 8.0.0

Getter for the export charts.

Returns:

anychart.core.utils.Exports - Exports settings.

See listing

var exports = chart.exports();

exports(value) Since version 8.0.0

Setter for the export charts.

Detailed description

To work with exports you need to reference the exports module from AnyChart CDN (http://cdn.anychart.com/js/latest/anychart-exports.min.js for latest or http://cdn.anychart.com/js/{{branch-name}}/anychart-exports.min.js for the versioned file)

Params:

Name	Type	Description
value	Object	Export settings.

Returns:

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

Try it:

Usage sample

getPixelBounds

getPixelBounds()

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

Returns:

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

getPlotsCount

getPlotsCount() Since version 7.12.1

Returns plots count.

Returns:

number - Number of plots.

Try it:

Usage sample

getSelectedPoints

getSelectedPoints() Since version 7.10.0

Getter for the selected points.

Returns:

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

Try it:

Usage sample

getSelectedRange

getSelectedRange() Since version 7.12.0

Gets selected range.

Returns:

Object - The object of the selected range. Object with fields: firstSelected, lastSelected, firstVisible, lastVisible.

Try it:

Usage sample

getStat

getStat(key) Since version 7.10.0

Getter for a statistical value by the key.

Params:

Name	Type	Description
key	anychart.enums.Statistics \| string	Key.

Returns:

* - Statistics value.

Try it:

Usage sample

globalToLocal

globalToLocal(xCoord, yCoord) Since version 7.9.1

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

Detailed description

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

Params:

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

Returns:

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

Try it:

Usage sample

grouping

grouping() Since version 7.10.1

Getter for the current data grouping settings.

Returns:

anychart.core.stock.Grouping - The current grouping settings.

Try it:

Usage sample

grouping(value) Since version 7.10.1

Setter for the data grouping settings.

Detailed description

Sets data grouping settings depending on parameter type:

null/boolean - disable or enable data grouping.
object - sets data grouping settings.
array - sets data grouping settings.

Params:

Name	Type	Description
value	boolean \| Array.<(string\|anychart.core.stock.Grouping.Level)> \| Object	Grouping value.

Returns:

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

Try it:

height

height()

Getter for element height settings.

Returns:

number string undefined - Element's height setting.

height(value)

Setter for element height setting.

Params:

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

Returns:

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

Try it:

Usage sample

inMarquee

inMarquee() Since version 7.14.0

Gets marquee process running value.

Returns:

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

interactivity

interactivity() Since version 7.14.0

Getter for interactivity settings.

Returns:

anychart.core.utils.StockInteractivity - Interactivity settings.

Try it:

Usage sample

interactivity(value) Since version 7.14.0

Setter for interactivity settings.

Params:

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

Returns:

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

Try it:

Usage sample

label

label(index)

Getter for the chart label.

Params:

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

Returns:

anychart.core.ui.Label - Label instance.

Try it:

Usage sample

label(value)

Setter for the chart label.

Detailed description

Sets chart label settings depending on parameter type:

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

Params:

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

Returns:

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

Try it:

label(index, value)

Setter for the chart label.

Detailed description

Sets chart label settings by index depending on parameter type:

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

Params:

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

Returns:

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

Try it:

left

left()

Getter for element left bound settings.

Returns:

number string undefined - Element's left bound setting.

left(value)

Setter for element left bound settings.

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:

Usage sample

listen

listen(type, listener, useCapture, listenerScope)

Adds an event listener to an implementing object.

Detailed description

The listener can be added to an object once, and if it is added one more time, its key will be returned.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function(Object e)		Callback method. Function that looks like `function(event){ // event.actualTarget - actual event target // event.currentTarget - current event target // event.iterator - event iterator // event.originalEvent - original event // event.point - event point // event.pointIndex - event point index }`.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

Usage sample

listenOnce

listenOnce(type, listener, useCapture, listenerScope)

Adds an event listener to an implementing object.

Detailed description

After the event is called, its handler will be deleted.
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function(Object e)		Callback method.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

Usage sample

localToGlobal

localToGlobal(xCoord, yCoord) Since version 7.9.1

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

Detailed description

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

Params:

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

Returns:

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

Try it:

Usage sample

margin

margin()

Getter for the chart margin.

Detailed description

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

Returns:

anychart.core.utils.Margin - Chart margin.

Try it:

Usage sample

margin(value)

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

Params:

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

Returns:

anychart.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:

Usage sample

margin(value1, value2, value3, value4)

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

Params:

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

Returns:

anychart.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:

Usage sample

maxHeight

maxHeight()

Getter for the maximum height.

Returns:

number string null - Element's maximum height.

maxHeight(value)

Setter for the 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:

Usage sample

maxWidth

maxWidth()

Getter for the maximum width.

Returns:

number string null - Element's maximum width.

maxWidth(value)

Setter for the 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:

Usage sample

minHeight

minHeight()

Getter for the minimum height.

Returns:

number string null - Element's minimum height.

minHeight(value)

Setter for the minimum height.

Detailed description

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

Params:

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

Returns:

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

Try it:

Usage sample

minWidth

minWidth()

Getter for the minimum width.

Returns:

number string null - Element's minimum width.

minWidth(value)

Setter for the minimum width.

Detailed description

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

Params:

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

Returns:

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

Try it:

Usage sample

padding

padding()

Getter for the chart padding.

Detailed description

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

Returns:

anychart.core.utils.Padding - Chart padding.

Try it:

Usage sample

padding(value)

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

Params:

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

Returns:

anychart.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:

Usage sample

padding(value1, value2, value3, value4)

Setter for the chart paddings in pixels using several numbers.

Params:

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

Returns:

anychart.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:

Usage sample

plot

plot(index) Since version 7.7.0

Getter for the current plots.

Params:

Name	Type	Description
index	number	Index of plot.

Returns:

anychart.core.stock.Plot - Plot instance.

Try it:

Usage sample

plot(value) Since version 7.7.0

Setter for the plots.

Detailed description

Sets chart plot settings depending on parameter type:

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

Params:

Name	Type	Description
value	Object \| boolean \| null	Value to set

Returns:

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

Try it:

plot(index, value) Since version 7.7.0

Setter for the plots by index.

Detailed description

Sets chart plot by index settings depending on parameter type:

null/boolean - disable or enable chart plot by index.
object - sets chart plot settings by index.

Params:

Name	Type	Default	Description
index	number		Index of plot.
value	Object \| boolean \| null	false	Plot settings to set.

Returns:

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

Try it:

preserveSelectedRangeOnDataUpdate

preserveSelectedRangeOnDataUpdate() Since version 8.0.0

Getter for the Selected Range Change Behaviour.

Returns:

boolean - Selected Range Change Behaviour.

See listing

var state = chart.preserveSelectedRangeOnDataUpdate();

preserveSelectedRangeOnDataUpdate(value) Since version 8.0.0

Setter for the Selected Range Change Behaviour.

Detailed description

When the data change the selected range (true) is preserved or the scroller position (false) is preserved.

Params:

Name	Type	Default	Description
value	boolean	false	Enable/disable selected range change behaviour.

Returns:

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

Try it:

Usage sample

print

print(paperSizeOrOptions, landscape)

Prints all elements on related stage.

Params:

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

Try it:

Usage sample

removeAllListeners

removeAllListeners(type)

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

Params:

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

Returns:

number - Number of listeners removed.

Try it:

Usage sample

right

right()

Getter for element right bound settings.

Returns:

number string undefined - Element's right bound setting.

right(value)

Setter for 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:

Usage sample

saveAsCsv

saveAsCsv(chartDataExportMode, csvSettings, filename) Since version 7.10.0

Saves chart data as a CSV file.

Params:

Name	Type	Description
chartDataExportMode	anychart.enums.ChartDataExportMode \| string	Data export mode.
csvSettings	Object.<string, (string\|boolean\|undefined)>	CSV settings.
filename	string	File name to save.

Try it:

Usage sample

saveAsJpg

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

Saves the current chart as JPEG image.

Params:

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

Try it:

Usage sample

saveAsJson

saveAsJson(filename) Since version 7.10.0

Saves chart config as JSON document.

Params:

Name	Type	Description
filename	string	File name to save.

Try it:

Usage sample

saveAsPdf

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

Saves the current chart as PDF image.

Params:

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

Try it:

Usage sample

saveAsPng

saveAsPng(width, height, quality, filename)

Saves the current chart as PNG image.

Params:

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

Try it:

Usage sample

saveAsSvg

saveAsSvg(paperSize, landscape, filename)

Saves the current chart as SVG image.

Params:

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

Try it:

Usage sample

saveAsSvg(width, height)

Saves the stage as SVG image using width and height.

Params:

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

Try it:

Usage sample

saveAsXlsx

saveAsXlsx(chartDataExportMode, filename) Since version 7.10.0

Saves chart data as an Excel document.

Params:

Name	Type	Description
chartDataExportMode	anychart.enums.ChartDataExportMode \| string	Data export mode.
filename	string	File name to save.

Try it:

Usage sample

saveAsXml

saveAsXml(filename) Since version 7.10.0

Saves chart config as XML document.

Params:

Name	Type	Description
filename	string	File name to save.

Try it:

Usage sample

scroller

scroller() Since version 7.7.0

Getter for the current scroller.

Returns:

anychart.core.stock.Scroller - Scroller instance.

Try it:

Usage sample

scroller(value) Since version 7.7.0

Setter for the scroller.

Detailed description

Sets chart scroller settings depending on parameter type:

null/boolean - disable or enable chart scroller.
object - sets chart scroller settings by index.

Params:

Name	Type	Default	Description
value	Object \| boolean \| null	true	Scroller settings

Returns:

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

Try it:

scrollerGrouping

scrollerGrouping() Since version 7.10.1

Getter for the current scroller data grouping settings.

Returns:

anychart.core.stock.Grouping - The current scroller data grouping settings.

Try it:

Usage sample

scrollerGrouping(value) Since version 7.10.1

Setter for the scroller data grouping settings.

Detailed description

Sets scroller data grouping settings depending on parameter type:

null/boolean - disable or enable data grouping.
object - sets data grouping settings.
array - sets data grouping settings.

Params:

Name	Type	Description
value	boolean \| Array.<(string\|anychart.core.stock.Grouping.Level)> \| Object	Grouping value.

Returns:

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

Try it:

selectMarqueeFill

selectMarqueeFill() Since version 7.14.0

Getter for the select marquee fill.

Returns:

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

See listing

var selectMarqueeFill = chart.selectMarqueeFill();

selectMarqueeFill(value) Since version 7.14.0

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

Params:

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

Returns:

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

Try it:

selectMarqueeFill(color, opacity) Since version 7.14.0

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

Detailed description

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

Params:

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

Returns:

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

Try it:

Usage sample

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

Linear gradient fill. Learn more about coloring.

Params:

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

Returns:

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

Try it:

Usage sample

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

Radial gradient fill. Learn more about coloring.

Params:

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

Returns:

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

Try it:

Usage sample

selectMarqueeFill(imageSettings) Since version 7.14.0

Image fill. Learn more about coloring.

Params:

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

Returns:

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

Try it:

Usage sample

selectMarqueeStroke

selectMarqueeStroke() Since version 7.14.0

Getter for the select marquee stroke.

Returns:

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

See listing.

var selectMarqueeStroke = chart.selectMarqueeStroke();

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

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

Params:

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

Returns:

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

Try it:

Usage sample

selectRange

selectRange(start, end) Since version 7.7.0

Setter for the select range using date.
Selects passed range and initiates data redraw.

Params:

Name	Type	Description
start	number \| string \| Date	Start value to set.
end	number \| string \| Date	End value to set.

Returns:

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

Try it:

Usage sample

selectRange(start, end, dispatchEvent) Since version 7.7.0

Setter for the select range using start date and dispatch event.
Selects passed range and initiates data redraw.

Params:

Name	Type	Description
start	number \| string \| Date	Start value to set.
end	number \| string \| Date	End value to set.
dispatchEvent	boolean	Whether to enable dispatch event.

Returns:

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

Try it:

Usage sample

selectRange(type, count, dispatchEvent) Since version 7.7.0

Setter for the select range using range type.

Detailed description

Selects passed range and initiates data redraw.
Note: Unit value and range type value works only after anychart.charts.Stock#draw is called.

Params:

Name	Type	Description
type	anychart.enums.StockRangeType \| string	Range type to set.
count	number	Count of points to set.
dispatchEvent	boolean	Whether to enable dispatch event.

Returns:

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

Try it:

Usage sample

selectRange(unit, count, anchor, dispatchEvent) Since version 7.7.0

Setter for the select range using unit.

Detailed description

Selects passed range and initiates data redraw.
Note: Unit value and range type value works only after anychart.charts.Stock#draw is called.

Params:

Name	Type	Description
unit	anychart.enums.Interval \| string	Interval to set.
count	number	Count of years.
anchor	anychart.enums.StockRangeAnchor \| string	Range anchor to set.
dispatchEvent	boolean	Whether to enable dispatch event.

Returns:

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

Try it:

Usage sample

startSelectMarquee

startSelectMarquee(repeat) Since version 7.14.0

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

Params:

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

Returns:

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

Try it:

Usage sample

startZoomMarquee

startZoomMarquee(repeat, asRect) Since version 7.14.1

Starts zoom marquee.

Params:

Name	Type	Description
repeat	boolean	Stay in marquee select mode after or not.
asRect	boolean	If true - a rectangle is drawn by X and Y coordinates, otherwise, draws an area of the plot height.

Returns:

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

Try it:

Usage sample

title

title()

Getter for the chart title.

Returns:

anychart.core.ui.Title - Chart title.

Try it:

Usage sample

title(value)

Setter for the chart title.

Detailed description

Sets chart title settings depending on parameter type:

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

Params:

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

Returns:

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

Try it:

toCsv

toCsv(chartDataExportMode, csvSettings) Since version 7.10.0

Returns CSV string with the chart data.

Params:

Name	Type	Description
chartDataExportMode	anychart.enums.ChartDataExportMode \| string	Data export mode.
csvSettings	Object.<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 - a function with two arguments such as the field name and value, that returns the formatted value, the object with the key as the field name, and the value as a format function. Default is 'undefined'.

Returns:

string - CSV string.

Try it:

toJson

toJson(stringify)

Return chart configuration as JSON object or string.

Params:

Name	Type	Default	Description
stringify	boolean	false	Returns JSON as string.

Returns:

Object string - Chart configuration.

Try it:

toSvg

toSvg(paperSize, landscape) Since version 7.5.1

Returns SVG string with paper size and landscape.

Detailed description

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

Params:

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

Returns:

string - SVG content or empty string.

Try it:

Usage sample

toSvg(width, height) Since version 7.5.1

Returns SVG string with with determined the width and height.

Detailed description

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

Params:

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

Returns:

string - SVG content or empty string.

Try it:

Usage sample

toXml

toXml(asXmlNode)

Return chart configuration as XML string or XMLNode.

Params:

Name	Type	Default	Description
asXmlNode	boolean	false	Return XML as XMLNode.

Returns:

string Node - Chart configuration.

Try it:

tooltip() Since version 7.7.0

tooltip(tooltipSettings) Since version 7.7.0

Setter for the chart tooltip.

Detailed description

Params:

Name	Type	Description
tooltipSettings	Object \| boolean \| null	Tooltip settings to set.

Returns:

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

Try it:

top

top()

Getter for element top bound settings.

Returns:

number string undefined - Element's top bound setting.

top(value)

Setter for element top bound settings.

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:

Usage sample

unlisten

unlisten(type, listener, useCapture, listenerScope)

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

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function		Callback method.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

Try it:

Usage sample

unlistenByKey

unlistenByKey(key)

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:

Usage sample

width

width()

Getter for element width settings.

Returns:

number string undefined - Element's width setting.

width(value)

Setter for element width setting.

Params:

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

Returns:

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

Try it:

Usage sample

xScale

xScale() Since version 7.7.0

Getter for the current stock chart X-scale.

Returns:

anychart.scales.StockScatterDateTime - Default chart scale value.

Try it:

Usage sample

xScale(value) Since version 7.7.0

Setter for stock chart X-scale.

Params:

Name	Type	Default	Description
value	anychart.enums.ScaleTypes \| string \| Object	anychart.scales.StockOrdinalDateTime	X-scale to set.

Returns:

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

Try it:

Usage sample

zIndex

zIndex()

Getter for the Z-index of the element.

Returns:

number - Z-index.

Try it:

Usage sample

zIndex(value)

Setter for the Z-index of the element.

Detailed description

The bigger the index - the higher the element position is.

Params:

Name	Type	Default	Description
value	number	0	Value to set.

Returns:

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

Try it:

Usage sample

zoomMarqueeFill

zoomMarqueeFill() Since version 7.14.0

Getter for the zoom marquee fill.

Returns:

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

See listing

var zoomMarqueeFill = chart.zoomMarqueeFill();

zoomMarqueeFill(value) Since version 7.14.0

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

Params:

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

Returns:

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

Try it:

zoomMarqueeFill(color, opacity) Since version 7.14.0

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

Detailed description

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

Params:

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

Returns:

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

Try it:

Usage sample

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

Linear gradient fill. Learn more about coloring.

Params:

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

Returns:

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

Try it:

Usage sample

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

Radial gradient fill. Learn more about coloring.

Params:

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

Returns:

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

Try it:

Usage sample

zoomMarqueeFill(imageSettings) Since version 7.14.0

Image fill. Learn more about coloring.

Params:

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

Returns:

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

Try it:

Usage sample

zoomMarqueeStroke

zoomMarqueeStroke() Since version 7.14.0

Getter for the zoom marquee stroke.

Returns:

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

See listing.

var zoomMarqueeStroke = chart.zoomMarqueeStroke();

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

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

Params:

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

Returns:

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

Try it:

Usage sample