class anychart.charts.Stock Improve this Doc
Extends: anychart.core.Chart
Stock chart class.
Note: Use anychart#stock method to get an instance of this class.
Methods Overview
| Specific settings | |
| a11y() | Accessibility setting. |
| annotations() | Gets annotations. |
| getPlotsCount() | Returns the number of plots. |
| 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. |
| 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. |
| 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. |
| fullScreen() | Fullscreen mode. |
| id() | Chart id. |
| inMarquee() | Gets marquee process running value. |
| isFullScreenAvailable() | Whether the fullscreen mode available in the browser or not. |
| 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
a11y
Getter for the accessibility setting.
Returns:
anychart.core.utils.ChartA11y - Accessibility settings object. See listing.
var stateOfAccsessibility = chart.a11y();
Setter for the accessibility setting.
Detailed description
If you want to enable accessibility you need to turn it on using anychart.core.Chart#a11y method.
Sets accessibility setting depending on parameter type:
Sets accessibility setting depending on parameter type:
- boolean - disable or enable accessibility.
- object - sets accessibility setting.
Params:
| Name | Type | Description |
|---|---|---|
| settings | boolean | Object | Whether to enable accessibility or object with settings. |
Returns:
anychart.charts.Stock - Self instance for method chaining.animation
Getter for animation settings.
Returns:
anychart.core.utils.Animation - Returns true if the animation is enabled.Try it:
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.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | boolean | Object | false | Whether to enable animation. |
Returns:
anychart.charts.Stock - Self instance for method chaining.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.charts.Stock - Self instance for method chaining.Try it:
annotations
Return stock annotations.
Returns:
anychart.core.annotations.ChartController - The annotations controller.Try it:
autoRedraw
Getter for the autoRedraw flag.
Flag whether to automatically call chart.draw() on any changes or not.
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.
Flag whether to automatically call chart.draw() on any changes or not.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | true | Value to set. |
Returns:
anychart.charts.Stock - Self instance for method chaining.Try it:
background
Setter for the chart background.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | {enabled: true, fill: "#fff", stroke: 'none', zIndex: 1} | Background object to set. |
Returns:
anychart.charts.Stock - Self instance for method chaining.Try it:
bottom
Getter for element bottom bound settings.
Returns:
number | string | undefined - Element's bottom bound setting.Setter for element bottom bound settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| bottom | number | string | null | null | Bottom bound settings for the element. |
Returns:
anychart.charts.Stock - Returns self for method chaining.Try it:
bounds
Getter for element bounds settings.
Returns:
anychart.core.utils.Bounds - Bounds of the element.Setter for bounds of the element using one parameter.
Params:
| Name | Type | Description |
|---|---|---|
| bounds | anychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.Bounds | Bounds of element. |
Returns:
anychart.charts.Stock - Self instance for method chaining.Try it:
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.charts.Stock - Self instance for method chaining.Try it:
cancelMarquee
Stops current marquee action if any.
Returns:
anychart.charts.Stock - Self instance for method chaining.container
Getter for the element's container.
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.
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 |
|---|---|---|
| element | anychart.graphics.vector.Layer | anychart.graphics.vector.Stage | string | Element | Container to set. |
Returns:
anychart.charts.Stock - 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:
contextMenu
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 |
|---|---|---|
| settings | Object | boolean | null | Context menu settings |
Returns:
anychart.charts.Stock - Self instance for method chaining.credits
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:
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.charts.Stock - An instance of the class for method chaining.crosshair
Setter for crosshair settings.
The plot crosshair settings have a higher priority than the chart 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 |
|---|---|---|
| settings | Object | boolean | null | Crosshair settings. |
Returns:
anychart.charts.Stock - Self instance for method chaining.draw
Starts the rendering of the chart into the container.
Params:
| Name | Type | Description |
|---|---|---|
| async | boolean | Whether do draw asynchronously. If set to true, the chart will be drawn asynchronously. |
Returns:
anychart.charts.Stock - Self instance for method chaining.eventMarkers
Getter for the event markers controller.
Returns:
anychart.core.stock.eventMarkers.Controller - Chart controller instance.Try it:
Setter for the event markers controller.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | boolean | null | true | Value to set. |
Returns:
anychart.charts.Stock - Self instance for method chaining.Try it:
exports
Getter for the export charts.
Returns:
anychart.core.utils.Exports - Exports settings. See listing
var exports = chart.exports();
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/8.4.0/anychart-exports.min.js for the versioned file)
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | Export settings. |
Returns:
anychart.charts.Stock - Self instance for method chaining.Try it:
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:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | false | Enable/Disable fullscreen mode. |
Returns:
anychart.charts.Stock - 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.getPlotsCount
Returns the number of plots.
Note: The getPlotsCount() method returns the number of existing plots.
The number of plots is not always equal to the biggest index of the plot. Please make sure you are aware of that when you dispose and create plots.
Note: The getPlotsCount() method returns the number of existing plots.
The number of plots is not always equal to the biggest index of the plot. Please make sure you are aware of that when you dispose and create plots.
Returns:
number - Number of plots. See listing
// Creates plots with indexes 0 and 4 accordingly. var plot1 = chart.plot(0); var plot2 = chart.plot(4); // Returns the number of plots is 2. var plotsCount = chart.getPlotsCount();
Try it:
getSelectedPoints
Getter for the selected points.
Returns:
Array.<anychart.core.Point> - An array of the selected points.Try it:
getSelectedRange
Gets selected range.
Returns:
anychart.charts.Stock.SelectedRange - The object of the selected range.Try it:
getStat
Getter for a statistical value by the key.
Params:
| Name | Type | Description |
|---|---|---|
| key | anychart.enums.Statistics | string | Key. |
Returns:
* - Statistics value.Try it:
globalToLocal
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).
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:
grouping
Getter for the data grouping settings.
Returns:
anychart.core.stock.Grouping - Grouping settings.Try it:
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 |
|---|---|---|
| settings | boolean | Array.<(string|anychart.core.stock.Grouping.Level)> | Object | Grouping value. |
Returns:
anychart.charts.Stock - Self instance for method chaining.height
Getter for element height settings.
Returns:
number | string | undefined - Element's height setting.Setter for element height setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| height | number | string | null | null | Height settings for the element. |
Returns:
anychart.charts.Stock - Returns self for method chaining.Try it:
id
Setter for chart id.
Params:
| Name | Type | Description |
|---|---|---|
| id | string | Chart id. |
Returns:
anychart.charts.Stock - Self instance for method chaining.Try it:
inMarquee
Gets marquee process running value.
Returns:
boolean - Returns true if there is a marquee process running.interactivity
Getter for interactivity settings.
Returns:
anychart.core.utils.StockInteractivity - Interactivity settings.Try it:
Setter for interactivity settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | anychart.enums.HoverMode | string | Settings object or boolean value like enabled state. |
Returns:
anychart.core.SeparateChart - Self instance for method chaining.Try it:
isFullScreenAvailable
Whether the fullscreen mode available in the browser or not.
Returns:
boolean - isFullScreenAvailable state.Try it:
label
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:
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 |
|---|---|---|---|
| settings | null | boolean | Object | string | false | Chart label instance to add by index 0. |
Returns:
anychart.charts.Stock - Self instance for method chaining.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. | |
| settings | null | boolean | Object | string | false | Chart label settings. |
Returns:
anychart.charts.Stock - Self instance for method chaining.left
Getter for element left bound settings.
Returns:
number | string | undefined - Element's left bound setting.Setter for element left bound settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| left | number | string | null | null | Left bound setting for the element. |
Returns:
anychart.charts.Stock - Returns self for method chaining.Try it:
listen
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.
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(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
} | |
| 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:
listenOnce
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).
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(e:Object) | 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:
localToGlobal
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).
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:
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:
Setter for the chart margin in pixels using a single complex object.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| margin | Array.<(number|string)> | Object | {top: 0, right: 0, bottom: 0, left: 0} | Margin to set. |
Returns:
anychart.charts.Stock - Self instance for method chaining. Example.
// all margins 15px
chart.margin(15);
// all margins 15px
chart.margin("15px");
// top and bottom 5px, right and left 15px
chart.margin(anychart.utils.margin(5, 15));Try it:
Setter for the chart margin in pixels using several simple values.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value1 | string | number | 0 | Top or top-bottom space. |
| value2 | string | number | 0 | Right or right-left space. |
| value3 | string | number | 0 | Bottom space. |
| value4 | string | number | 0 | Left space. |
Returns:
anychart.charts.Stock - 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:
maxHeight
Getter for the maximum height.
Returns:
number | string | null - Element's maximum height.Setter for the maximum height.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| height | number | string | null | null | Maximum height to set. |
Returns:
anychart.charts.Stock - Self instance for method chaining.Try it:
maxWidth
Getter for the maximum width.
Returns:
number | string | null - Element's maximum width.Setter for the maximum width.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| width | number | string | null | null | Maximum width to set. |
Returns:
anychart.charts.Stock - Self instance for method chaining.Try it:
minHeight
Getter for the minimum height.
Returns:
number | string | null - Element's minimum height.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 |
|---|---|---|---|
| height | number | string | null | null | Minimum height to set. |
Returns:
anychart.charts.Stock - Self instance for method chaining.Try it:
minWidth
Getter for the minimum width.
Returns:
number | string | null - Element's minimum width.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 |
|---|---|---|---|
| width | number | string | null | null | Minimum width to set. |
Returns:
anychart.charts.Stock - Self instance for method chaining.Try it:
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:
Setter for the chart paddings in pixels using a single value.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| padding | Array.<(number|string)> | Object | {top: 0, right: 0, bottom: 0, left: 0} | Padding to set. |
Returns:
anychart.charts.Stock - 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.charts.Stock - 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:
plot
Getter for the plots.
Params:
| Name | Type | Description |
|---|---|---|
| index | number | Index of plot. |
Returns:
anychart.core.stock.Plot - Plot instance.Try it:
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 |
|---|---|---|
| settings | Object | boolean | null | Value to set |
Returns:
anychart.charts.Stock - Self instance for method chaining.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. | |
| settings | Object | boolean | null | false | Plot settings to set. |
Returns:
anychart.charts.Stock - Self instance for method chaining.preserveSelectedRangeOnDataUpdate
Getter for the Selected Range Change Behaviour.
Returns:
boolean - Selected Range Change Behaviour. See listing
var state = chart.preserveSelectedRangeOnDataUpdate();
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 |
|---|---|---|---|
| enabled | boolean | false | Enable/disable selected range change behaviour. |
Returns:
anychart.charts.Stock - Self instance for method chaining.Try it:
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:
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:
right
Getter for element right bound settings.
Returns:
number | string | undefined - Element's right bound setting.Setter for element right bound setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| right | number | string | null | null | Right bound setting for the element. |
Returns:
anychart.charts.Stock - Returns self for method chaining.Try it:
saveAsCsv
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|function(name:*, value:*))> | 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'). |
| filename | string | File name to save. |
Try it:
saveAsJpg
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:
saveAsJson
Saves chart config as JSON document.
Params:
| Name | Type | Description |
|---|---|---|
| filename | string | File name to save. |
Try it:
saveAsPdf
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:
saveAsPng
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:
saveAsSvg
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:
Saves the stage as SVG image using width and height.
Params:
| Name | Type | Description |
|---|---|---|
| width | number | Image width. |
| height | number | Image height. |
Try it:
saveAsXlsx
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:
saveAsXml
Saves chart config as XML document.
Params:
| Name | Type | Description |
|---|---|---|
| filename | string | File name to save. |
Try it:
scroller
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 |
|---|---|---|---|
| settings | Object | boolean | null | true | Scroller settings |
Returns:
anychart.charts.Stock - Self instance for method chaining.scrollerGrouping
Getter for the scroller data grouping settings.
Returns:
anychart.core.stock.Grouping - The scroller data grouping settings.Try it:
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.selectMarqueeFill
Getter for the select marquee fill.
Returns:
anychart.graphics.vector.Fill - Select marquee fill. See listing
var selectMarqueeFill = chart.selectMarqueeFill();
Setter for fill settings using an array, an object or a string.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| color | anychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)> | Color as an object, an array or a string. |
Returns:
anychart.charts.Stock - Self instance for method chaining.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:
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:
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:
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:
selectMarqueeStroke
Getter for the select marquee stroke.
Returns:
anychart.graphics.vector.Stroke - Select marquee stroke. See listing.
var selectMarqueeStroke = chart.selectMarqueeStroke();
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.charts.Stock - Self instance for method chaining.Try it:
selectRange
Setter for the select range using date.
Selects passed range and initiates data redraw.
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:
Setter for the select range using start date and dispatch event.
Selects passed range and initiates data redraw.
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:
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.
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:
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.
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:
shareWithFacebook
shareWithLinkedIn
shareWithPinterest
shareWithTwitter
startSelectMarquee
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.charts.Stock - Self instance for method chaining.Try it:
startZoomMarquee
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:
title
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 |
|---|---|---|---|
| settings | null | boolean | Object | string | false | Chart title text or title instance for copy settings from. |
Returns:
anychart.charts.Stock - Self instance for method chaining.toCsv
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 - 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.Try it:
toJson
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.toSvg
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:
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:
toXml
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.tooltip
Getter for the chart tooltip.
Returns:
anychart.core.ui.Tooltip - Tooltip instance. Example
var tooltipSettings = chart.tooltip();
Setter for the chart tooltip.
Detailed description
Sets tooltip settings depending on parameter type:
- null/boolean - disable or enable tooltip.
- object - sets tooltip settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | boolean | null | Tooltip settings to set. |
Returns:
anychart.charts.Stock - Self instance for method chaining.top
Getter for element top bound settings.
Returns:
number | string | undefined - Element's top bound setting.Setter for element top bound settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| top | number | string | null | null | Top bound setting for the element. |
Returns:
anychart.charts.Stock - Returns self for method chaining.Try it:
unlisten
Removes a listener added using listen() or listenOnce() methods.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| type | string | The event type id. | |
| listener | function(e:Object):boolean|undefined | 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:
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 settings.
Returns:
number | string | undefined - Element's width setting.Setter for element width setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| width | number | string | null | null | Width settings for the element. |
Returns:
anychart.charts.Stock - Returns self for method chaining.Try it:
xScale
Getter for the stock chart X-scale.
Returns:
anychart.scales.StockScatterDateTime - Default chart scale value.Try it:
Setter for stock chart X-scale.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | anychart.enums.ScaleTypes | string | Object | anychart.scales.StockOrdinalDateTime | X-scale to set. |
Returns:
anychart.charts.Stock - Self instance for method chaining.Try it:
zIndex
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 |
|---|---|---|---|
| zIndex | number | 0 | Value to set. |
Returns:
anychart.charts.Stock - Self instance for method chaining.Try it:
zoomMarqueeFill
Getter for the zoom marquee fill.
Returns:
anychart.graphics.vector.Fill - Zoom marquee fill. See listing
var zoomMarqueeFill = chart.zoomMarqueeFill();
Setter for fill settings using an array, an object or a string.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| color | anychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)> | Color as an object, an array or a string. |
Returns:
anychart.charts.Stock - Self instance for method chaining.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:
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:
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:
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:
zoomMarqueeStroke
Getter for the zoom marquee stroke.
Returns:
anychart.graphics.vector.Stroke - Zoom marquee stroke. See listing.
var zoomMarqueeStroke = chart.zoomMarqueeStroke();
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.charts.Stock - Self instance for method chaining.Try it: