class anychart.charts.Scatter Improve this Doc
Extends: anychart.core.SeparateChart
Scatter chart class.
Learn more about Scatter Chart
Methods Overview
| Specific settings | |
| a11y() | Accessibility settings. |
| annotations() | Creates annotations. |
| crossing() | Crossing annotations. |
| getType() | Definition of the chart type. |
| globalToLocal() | Converts the global coordinates to local coordinates. |
| localToGlobal() | Converts the local coordinates to global coordinates. |
| quarters() | Quarter annotations. |
| toA11yTable() | Creates and returns the chart represented as an invisible HTML table. |
| toHtmlTable() | Creates and returns a chart as HTML table. |
| Axes and Scales | |
| baseline() | Set the baseline by the Y-Scale value. |
| getXScales() | Returns chart X scales. |
| getYScales() | Returns chart Y scales. |
| lineMarker() | Line marker settings. |
| rangeMarker() | Range marker settings. |
| textMarker() | Text marker settings. |
| xAxis() | X-axis settings. |
| xGrid() | Grid settings by X-scale. |
| xMinorGrid() | Minor grid settings by X-scale. |
| xScale() | X-scale settings. |
| yAxis() | Y-axis settings. |
| yGrid() | Grid settings by Y-scale. |
| yMinorGrid() | Minor grid settings by Y-scale. |
| yScale() | Y-scale settings. |
| Chart Coloring | |
| animation() | Animation settings |
| dataArea() | Data area settings. |
| hatchFillPalette() | Hatch fill palette settings. |
| markerPalette() | Markers palette settings. |
| palette() | Palette settings. |
| Chart Controls | |
| contextMenu() | Context menu settings. |
| credits() | Credits settings |
| label() | Label settings. |
| legend() | Legend settings. |
| title() | Title settings. |
| Coloring | |
| background() | Background settings. |
| selectRectangleMarqueeFill() | Select marquee fill settings. |
| selectRectangleMarqueeStroke() | Stroke settings. |
| Data | |
| getStat() | Getter for a statistical value by the key. |
| 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 | |
| crosshair() | Crosshair settings |
| hovered() | Hovered state settings. |
| interactivity() | Interactivity settings. |
| normal() | Normal state settings. |
| selected() | Selected state settings. |
| startSelectRectangleMarquee() | Starts select marquee drawing. |
| tooltip() | Tooltip settings. |
| Point Elements | |
| getSelectedPoints() | Getter for the selected points. |
| labels() | Labels settings. |
| Point Elements? | |
| maxLabels() | Maximum labels settings.? |
| minLabels() | Minimum labels settings.? |
| Series | |
| bubble() | Adds Bubble series. |
| getSeries() | Gets series by its id. |
| line() | Adds Line series. |
| marker() | Adds Marker series. |
| Size and Position | |
| bottom() | Bottom bound settings. |
| bounds() | Bounds settings. |
| getPixelBounds() | Returns pixel bounds of the chart. |
| getPlotBounds() | Gets data 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 setting. |
| top() | Top bound settings. |
| width() | Width setting. |
| zIndex() | Z-index of the chart. |
| Specific Series Settings | |
| addSeries() | Adds series to chart. |
| defaultSeriesType() | Default series type. |
| getSeriesAt() | Gets series by its index. |
| getSeriesCount() | Returns series count. |
| maxBubbleSize() | Maximum size for all bubbles |
| minBubbleSize() | Minimum size for all bubbles |
| removeAllSeries() | Removes all series from chart. |
| removeSeries() | Removes one of series from chart by its id. |
| removeSeriesAt() | Removes one of series from chart by its index. |
| 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. |
| cancelMarquee() | Stops marquee action if any. |
| container() | Chart container |
| draw() | Chart drawing |
| fullScreen() | Fullscreen mode. |
| id() | Chart id. |
| inMarquee() | Gets marquee process running value. |
| isFullScreenAvailable() | Whether the fullscreen mode available in the browser or not. |
| isVertical() | Getter for the vertical direction. |
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.
Detailed description
If you want to enable accessibility you need to turn it on using anychart.charts.Scatter#a11y method.
Sets accessibility setting depending on parameter type:
Sets accessibility setting depending on parameter type:
- boolean - disable or enable accessibility.
- object - sets accessibility settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | boolean | Object | Whether to enable accessibility or object with settings. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.addSeries
Adds series to chart.
Params:
| Name | Type | Description |
|---|---|---|
| var_args | anychart.data.View | anychart.data.Set | Array | Chart series data. |
Returns:
Array.<anychart.core.scatter.series.Base> - Array of created series.Try it:
animation
Getter for the animation settings.
Returns:
anychart.core.utils.Animation - Returns true if the animation is enabled.Try it:
Setter for the 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.Scatter - Self instance for method chaining.Setter for the animation settings using of 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.Scatter - Self instance for method chaining.Try it:
annotations
Getter for the annotations.
Returns:
anychart.core.annotations.PlotController - The plot annotations.Try it:
Setter for the annotations.
Params:
| Name | Type | Description |
|---|---|---|
| annotationsList | Array | Annotations list to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.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.Scatter - Self instance for method chaining.Try it:
background
Setter for the chart background settings.
Detailed description
Sets chart background settings depending on parameter type:
- null/boolean - disable or enable chart background.
- object - sets chart background settings.
- string - sets chart background color.
Params:
| Name | Type | Description |
|---|---|---|
| settings | string | Object | null | boolean | Background settings to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.baseline
Getter for the chart baseline.
Returns:
number - The baseline value by the Y-Scale. See listing
var chart = anychart.scatter(); var baseline = chart.baseline();
Setter for the chart baseline.
The baseline is the line relative to which the series with the negative or positive value is drawn and painted over.
The baseline is the line relative to which the series with the negative or positive value is drawn and painted over.
Params:
| Name | Type | Description |
|---|---|---|
| value | number | Y-Scale value for the baseline. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Try it:
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:
| Name | Type | Description |
|---|---|---|
| bottom | number | string | null | Bottom bound for the chart. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Try it:
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:
| Name | Type | Description |
|---|---|---|
| bounds | anychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.Bounds | Bounds of teh chart. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Try it:
Setter for the chart 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.Scatter - Self instance for method chaining.Try it:
bubble
Adds Bubble series.
Params:
| Name | Type | Description |
|---|---|---|
| data | anychart.data.View | anychart.data.Set | Array | string | Data for the series. |
| csvSettings | anychart.enums.TextParsingMode | string | anychart.data.TextParsingSettings | If CSV string is passed, you can pass CSV parser settings here as a hash map. |
Returns:
anychart.core.scatter.series.Bubble - An instance of the created series.Try it:
cancelMarquee
Stops marquee action if any.
Returns:
anychart.charts.Scatter - Self instance for method chaining.container
Getter for the chart container.
Setter for the chart container.
Params:
| Name | Type | Description |
|---|---|---|
| element | anychart.graphics.vector.Layer | anychart.graphics.vector.Stage | string | Element | The value to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.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.Scatter - Self instance for method chaining.credits
Setter for 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 |
|---|---|---|---|
| settings | Object | boolean | null | true | Credits settings |
Returns:
anychart.charts.Scatter - Self instance for method chaining.crosshair
Setter for 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 | Default | Description |
|---|---|---|---|
| settings | Object | boolean | null | false | Crosshair settings. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.crossing
Setter for crossing settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | Crossing settings object. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Try it:
dataArea
Setter for the data area settings.
The data area is drawn along the data bounds.
The data area is drawn along the data bounds.
Detailed description
Sets data area settings depending on parameter type:
- boolean - disable or enable data area.
- object - sets data area settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | boolean | Data area settings to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.defaultSeriesType
Setter for the scatter default series type.
Detailed description
Setting the default type using this method affects only series created using addSeries() method after the default is set.
All series created prior to that do not change the type.
Params:
| Name | Type | Description |
|---|---|---|
| type | string | Default series type. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Try it:
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.Scatter - 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
(https://cdn.anychart.com/releases/8.13.0/js/anychart-exports.min.js for latest or https://cdn.anychart.com/releases/8.13.0/js/anychart-exports.min.js for the versioned file)
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | Export settings. |
Returns:
anychart.charts.Scatter - 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.Scatter - Self instance for method chaining.Try it:
getJpgBase64String
Returns JPG as base64 string.
Params:
| Name | Type | Description |
|---|---|---|
| onSuccessOrOptions | function(response:string) | Object | Function that is called when sharing is complete or object with options. |
| onError | function(response:string) | Function that is called if sharing fails. |
| width | number | Image width. |
| height | number | Image height. |
| quality | number | Image quality in ratio 0-1. |
| forceTransparentWhite | boolean | Force transparent to white or not. |
Try it:
getPdfBase64String
Returns PDF as base64 string.
Params:
| Name | Type | Description |
|---|---|---|
| onSuccessOrOptions | function(response:string) | Object | Function that is called when sharing is complete or object with options. |
| onError | function(response:string) | Function that is called if sharing fails. |
| paperSizeOrWidth | number | string | Any paper format like 'a0', 'tabloid', 'b4', etc. |
| landscapeOrWidth | number | boolean | Define, is landscape. |
| x | number | Offset X. |
| y | number | Offset Y. |
Try it:
getPixelBounds
Returns pixel bounds of the chart.
Returns pixel bounds of the chart due to parent bounds and self bounds settings.
Returns pixel bounds of the chart due to parent bounds and self bounds settings.
Returns:
anychart.math.Rect - Pixel bounds of the chart.Try it:
getPlotBounds
Gets data bounds of the chart.
Note: Works only after anychart.charts.Scatter#draw is called.
Returns:
anychart.math.Rect - Data bounds of the chart.Try it:
getPngBase64String
Returns PNG as base64 string.
Params:
| Name | Type | Description |
|---|---|---|
| onSuccessOrOptions | function(response:string) | Object | Function that is called when sharing is complete or object with options. |
| onError | function(response:string) | Function that is called if sharing fails. |
| width | number | Image width. |
| height | number | Image height. |
| quality | number | Image quality in ratio 0-1. |
Try it:
getSelectedPoints
Getter for the selected points.
Returns:
Array.<anychart.core.Point> - An array of the selected points.Try it:
getSeries
Gets series by its id.
Params:
| Name | Type | Description |
|---|---|---|
| id | number | string | Id of the series. |
Returns:
anychart.core.scatter.series.Base - An instance of the created series.Try it:
getSeriesAt
Gets series by its index.
Params:
| Name | Type | Description |
|---|---|---|
| index | number | Index of the series. |
Returns:
anychart.core.scatter.series.Base - An instance of the created series.Try it:
getSeriesCount
getStat
Getter for a statistical value by the key.
Params:
| Name | Type | Description |
|---|---|---|
| key | anychart.enums.Statistics | string | Key. |
Returns:
* - Statistics value.Try it:
getSvgBase64String
Returns SVG as base64 string.
Params:
| Name | Type | Description |
|---|---|---|
| onSuccessOrOptions | function(response:string) | Object | Function that is called when sharing is complete or object with options. |
| onError | function(response:string) | Function that is called if sharing fails. |
| paperSizeOrWidth | string | number | Paper Size or width. |
| landscapeOrHeight | boolean | string | Landscape or height. |
Try it:
getType
getXScales
Returns chart X scales.
Returns:
Array - An array of all X scales (including axes, grids, and axis markers scales).Try it:
getYScales
Returns chart Y scales.
Returns:
Array - An array of all Y scales (including axes, grids, and axis markers scales).Try it:
globalToLocal
Converts the global coordinates to local coordinates.
Note: Works only after anychart.charts.Scatter#draw is called.
Detailed description
Converts global coordinates of the global document into local coordinates of the container or stage.
On image below, the red point is a starting coordinate point of the chart bounds. Local coordinates work only in area of the stage (container).
On image below, the red point is a starting coordinate point of the chart bounds. Local coordinates work only in 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:
hatchFillPalette
Getter for hatch fill palette settings.
Returns:
anychart.palettes.HatchFills - Hatch fill palette.Setter for hatch fill palette settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Array.<anychart.graphics.vector.HatchFill.HatchFillType> | Object | anychart.palettes.HatchFills | Chart hatch fill palette settings to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Try it:
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:
| Name | Type | Default | Description |
|---|---|---|---|
| height | number | string | null | null | Height settings for the chart. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Try it:
hovered
Getter for hovered state settings.
Returns:
anychart.core.StateSettings - Hovered state settingsTry it:
Setter for hovered state settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | State settings to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Try it:
id
Setter for chart id.
Params:
| Name | Type | Description |
|---|---|---|
| id | string | Chart id. |
Returns:
anychart.charts.Scatter - 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 the interactivity settings.
Returns:
anychart.core.utils.Interactivity - Interactivity settings.Try it:
Setter for the interactivity settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | anychart.enums.HoverMode | string | Settings object or boolean value like enabled state. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Try it:
isFullScreenAvailable
Whether the fullscreen mode available in the browser or not.
Returns:
boolean - isFullScreenAvailable state.Try it:
isVertical
Getter for the vertical direction.
Returns:
boolean - The flag of the series layout direction. See listing
var flag = chart.isVertical();
Setter for the vertical direction.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | false | Value to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.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 - An instance of class.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.Scatter - Self instance for method chaining.Setter for chart label using index.
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 | 0 | Label index. |
| settings | null | boolean | Object | string | false | Chart label settings. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.labels
Setter for series data labels.
Detailed description
Sets chart labels settings depending on parameter type:
- null/boolean - disable or enable chart labels.
- object - sets chart labels settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | boolean | null | Series data labels settings. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.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:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Left bound setting for the chart. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Try it:
legend
Setter for the chart legend settings.
Detailed description
Sets chart legend settings depending on parameter type:
- null/boolean - disable or enable chart legend.
- object - sets chart legend settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | boolean | null | false | Legend settings. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.line
Adds Line series.
Params:
| Name | Type | Description |
|---|---|---|
| data | anychart.data.View | anychart.data.Set | Array | string | Data for the series. |
| csvSettings | anychart.enums.TextParsingMode | string | anychart.data.TextParsingSettings | If CSV string is passed, you can pass CSV parser settings here as a hash map. |
Returns:
anychart.core.scatter.series.Line - An instance of the created series.Try it:
lineMarker
Getter for the chart line marker.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Chart line marker index. If not set - creates a new instance and adds it to the end of array. |
Returns:
anychart.core.axisMarkers.Line - Line marker instance by index.Try it:
Setter for the chart line marker.
Detailed description
Sets chart line marker settings depending on parameter type:
- null/boolean - disable or enable chart line marker.
- object - sets chart line marker settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | boolean | null | false | Chart line marker settings to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Setter for the chart line marker by index.
Detailed description
Sets chart line marker settings depending on parameter type:
- null/boolean - disable or enable chart line marker by index.
- object - sets chart line marker settings by index.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Chart line marker index. |
| settings | Object | boolean | null | Chart line marker settings to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.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.Scatter#draw is called.
Detailed description
Converts local coordinates of the container or stage into global coordinates of the global document.
On image below, the red point is a starting coordinate point of the chart bounds. Local coordinates work only in area of the stage (container).
On image below, the red point is a starting coordinate point of the chart bounds. Local coordinates work only in 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} | Value to set. |
Returns:
anychart.charts.Scatter - 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.Scatter - 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:
marker
Adds Marker series.
Params:
| Name | Type | Description |
|---|---|---|
| data | anychart.data.View | anychart.data.Set | Array | string | Data for the series. |
| csvSettings | anychart.enums.TextParsingMode | string | anychart.data.TextParsingSettings | If CSV string is passed, you can pass CSV parser settings here as a hash map. |
Returns:
anychart.core.scatter.series.Marker - An instance of the created series.Try it:
markerPalette
Getter for markers palette settings.
Returns:
anychart.palettes.Markers - Markers palette.Setter for markers palette settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.palettes.Markers | Object | Array.<(anychart.enums.MarkerType|string)> | Value to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Try it:
maxBubbleSize
Getter for the maximum size for all bubbles on the charts.
Returns:
number | string - The maximum size of all bubbles.Try it:
Setter for the maximum size for all bubbles on the charts.
Detailed description
This method works between several series.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| size | number | string | '20%' | Maximum size to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Try it:
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:
| Name | Type | Default | Description |
|---|---|---|---|
| maxHeight | number | string | null | null | Maximum height to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Try it:
maxLabels
Setter for maximum labels.
Detailed description
Sets chart labels settings depending on parameter type:
- null/boolean - disable or enable maximum labels.
- object - sets maximum labels settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | boolean | null | Maximum labels settings. |
Returns:
anychart.charts.Scatter - 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:
| Name | Type | Default | Description |
|---|---|---|---|
| maxWidth | number | string | null | null | Maximum width to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Try it:
minBubbleSize
Getter for the minimum size for all bubbles on the charts.
Returns:
number | string - The minimum size of all bubbles.Try it:
Setter for the minimum size for all bubbles on the charts.
Detailed description
This method works between several series.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | '5%' | Minimum size to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Try it:
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.
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 |
|---|---|---|---|
| minHeight | number | string | null | null | Minimum height to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Try it:
minLabels
Setter for minimum labels.
Detailed description
Sets chart labels settings depending on parameter type:
- null/boolean - disable or enable minimum labels.
- object - sets minimum labels settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | boolean | null | Minimum labels settings. |
Returns:
anychart.charts.Scatter - 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.
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 |
|---|---|---|---|
| minWidth | number | string | null | null | Minimum width to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Try it:
noData
Setter for noData settings.
Learn more about "No data" feature
Learn more about "No data" feature
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | NoData settings. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Try it:
normal
Getter for normal state settings.
Returns:
anychart.core.StateSettings - Normal state settings.Try it:
Setter for normal state settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | State settings to set. |
Returns:
anychart.charts.Scatter - 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} | Value to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining. See listing.
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.Scatter - 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:
palette
Getter for the series colors palette.
Setter for the series colors palette.
Note: You can use predefined palettes from anychart.palettes.
Params:
| Name | Type | Description |
|---|---|---|
| settings | anychart.palettes.RangeColors | anychart.palettes.DistinctColors | Object | Array.<string> | Palette to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Prints chart.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| paperSize | anychart.graphics.vector.PaperSize | Paper size. | |
| landscape | boolean | false | Flag of landscape. |
Try it:
quarters
Setter for quarter settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | Object with settings. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Try it:
rangeMarker
Getter for the chart range marker.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Chart range marker index. If not set - creates a new instance and adds it to the end of array. |
Returns:
anychart.core.axisMarkers.Range - Range marker instance by index.Try it:
Setter for the chart range marker.
Detailed description
Sets chart range marker settings depending on parameter type:
- null/boolean - disable or enable chart range marker.
- object - sets chart range marker settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | boolean | null | false | Chart range marker settings to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Setter for the chart range marker by index.
Detailed description
Sets chart range marker settings depending on parameter type:
- null/boolean - disable or enable chart range marker by index.
- object - sets chart range marker settings by index.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Chart range marker index. |
| settings | Object | boolean | null | Chart range marker settings to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.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:
removeAllSeries
Removes all series from chart.
Returns:
anychart.charts.Scatter - Self instance for method chaining.Try it:
removeSeries
Removes one of series from chart by its id.
Params:
| Name | Type | Description |
|---|---|---|
| id | number | string | Series id. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Try it:
removeSeriesAt
Removes one of series from chart by its index.
Params:
| Name | Type | Description |
|---|---|---|
| index | number | Series index. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Try it:
right
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:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Right bound setting for the chart. |
Returns:
anychart.charts.Scatter - Self instance 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 object:
Formatters must be represented as one of:
|
| filename | string | File name to save. |
Try it:
saveAsJpg
Saves the chart as JPEG image.
Params:
| Name | Type | Description |
|---|---|---|
| width | number | Image width. |
| height | number | Image height. |
| quality | number | Image quality in ratio 0-1. |
| forceTransparentWhite | boolean | Define, should we force transparent to white background. |
| 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 chart as PDF image.
Params:
| Name | Type | Description |
|---|---|---|
| paperSize | string | Any paper format like 'a0', 'tabloid', 'b4', etc. |
| landscape | boolean | Define, is landscape. |
| x | number | Offset X. |
| y | number | Offset Y. |
| filename | string | File name to save. |
Try it:
saveAsPng
Saves the chart as PNG image.
Params:
| Name | Type | Description |
|---|---|---|
| width | number | Image width. |
| height | number | Image height. |
| quality | number | Image quality in ratio 0-1. |
| filename | string | File name to save. |
Try it:
saveAsSvg
Saves the chart as SVG image using paper size and landscape.
Params:
| Name | Type | Description |
|---|---|---|
| paperSize | string | Paper Size. |
| landscape | boolean | Landscape. |
| filename | string | File name to save. |
Try it:
Saves the stage as SVG image using width and height.
Params:
| Name | Type | Description |
|---|---|---|
| width | number | Image width. |
| height | number | Image height. |
Try it:
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. |
| exportOptions | Object.<string, (function(name:*, value:*))> | Export options:
Formatter must be represented as one of:
|
Try it:
saveAsXml
Saves chart config as XML document.
Params:
| Name | Type | Description |
|---|---|---|
| filename | string | File name to save. |
Try it:
selectRectangleMarqueeFill
Getter for the select marquee fill.
Returns:
anychart.graphics.vector.Fill - Select marquee fill. See listing
var selectRectangleMarqueeFill = chart.selectRectangleMarqueeFill();
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.Scatter - 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.Scatter - 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.Scatter - 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.Scatter - 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.Scatter - Self instance for method chaining.Try it:
selectRectangleMarqueeStroke
Getter for the select marquee stroke.
Returns:
anychart.graphics.vector.Stroke - Select marquee stroke. See listing.
var selectRectangleMarqueeStroke = chart.selectRectangleMarqueeStroke();
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.Scatter - Self instance for method chaining.Try it:
selected
Getter for selected state settings.
Returns:
anychart.core.StateSettings - Selected state settingsTry it:
Setter for selected state settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | State settings to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Try it:
shareAsJpg
shareAsPdf
shareAsPng
shareAsSvg
shareWithFacebook
shareWithLinkedIn
shareWithPinterest
shareWithTwitter
startSelectRectangleMarquee
Starts select marquee drawing.
Note: Works only after anychart.charts.Scatter#draw is called.
Params:
| Name | Type | Description |
|---|---|---|
| repeat | boolean | Whether to start select marquee drawing. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Try it:
textMarker
Getter for the chart text marker.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Chart text marker index. If not set - creates a new instance and adds it to the end of array. |
Returns:
anychart.core.axisMarkers.Text - Text marker instance by index.Try it:
Setter for the chart text marker.
Detailed description
Sets chart text marker settings depending on parameter type:
- null/boolean - disable or enable chart text marker.
- object - sets chart text marker settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | boolean | null | false | Chart text marker settings to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Setter for the chart text marker by index.
Detailed description
Sets chart text marker settings depending on parameter type:
- null/boolean - disable or enable chart text marker by index.
- object - sets chart text marker settings by index.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Chart text marker index. |
| settings | Object | boolean | null | Chart text marker settings to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.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.Scatter - Self instance for method chaining.toA11yTable
Creates and returns the chart represented as an invisible HTML table.
Detailed description
This method generates an invisible HTML table for accessibility purposes. The table is only available for Screen Readers.
Params:
| Name | Type | Description |
|---|---|---|
| title | string | Title to set. |
| asString | boolean | Defines 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.Try it:
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:
toHtmlTable
Creates and returns a chart as HTML table.
Detailed description
This method generates an HTML table which contains chart data.
Params:
| Name | Type | Description |
|---|---|---|
| title | string | Title to set. |
| asString | boolean | Defines 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.Try it:
toJson
Returns 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 using 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 | Paper Size. |
| landscape | boolean | Landscape. |
Returns:
string - SVG content or empty string.Try it:
Returns SVG string using 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
Returns 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
Setter for tooltip settings.
Detailed description
Sets chart data tooltip settings depending on parameter type:
- null/boolean - disable or enable chart data tooltip.
- object - sets chart data tooltip settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | boolean | null | true | Tooltip settings. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.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:
| Name | Type | Description |
|---|---|---|
| top | number | string | null | Top bound for the chart. |
Returns:
anychart.charts.Scatter - Self instance 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) | 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 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:
| Name | Type | Default | Description |
|---|---|---|---|
| width | number | string | null | null | Width settings for the chart. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Try it:
xAxis
Getter for chart X-axis.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Chart axis index. If not set - creates a new instance and adds it to the end of array. |
Returns:
anychart.core.axes.Linear - Axis instance by index.Try it:
Setter for chart X-axis.
Detailed description
You can use multiple axes for a chart.
Sets chart X-axis settings depending on parameter type:
- null/boolean - disable or enable chart X-axis.
- object - sets chart X-axis settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | boolean | null | true | Chart axis settings to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Setter for chart X-axis by index.
Detailed description
Sets chart X-axis settings depending on parameter type:
- null/boolean - disable or enable chart X-axis by index.
- object - sets chart X-axis settings by index.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Chart axis index. |
| settings | Object | boolean | null | Chart axis settings to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.xGrid
Getter for chart grid by X-scale.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Chart grid index. If not set - creates a new instance and adds it to the end of grid array. |
Returns:
anychart.core.grids.Linear - Axis instance by index.Try it:
Setter for chart grid by X-scale.
Detailed description
Sets chart grid settings depending on parameter type:
- null/boolean - disable or enable chart grid.
- object - sets chart grid settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | boolean | null | false | Chart grid settings to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Setter for chart grid by index.
Detailed description
Sets chart grid settings depending on parameter type:
- null/boolean - disable or enable chart grid by index.
- object - sets chart grid settings by index.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Chart grid index. |
| settings | Object | boolean | null | Chart grid settings to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.xMinorGrid
Getter for chart minor grid by X-scale.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Chart minor grid index. If not set - creates a new instance and adds it to the end of array. |
Returns:
anychart.core.grids.Linear - Axis instance by index.Try it:
Setter for chart minor grid by X-scale.
Detailed description
Sets chart minor grid settings depending on parameter type:
- null/boolean - disable or enable chart minor grid.
- object - sets chart minor grid settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | boolean | null | false | Chart minor grid settings to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Setter for chart minor grid by index.
Detailed description
Sets chart minor grid settings depending on parameter type:
- null/boolean - disable or enable chart minor grid by index.
- object - sets chart minor grid settings by index.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Chart minor grid index. |
| settings | Object | boolean | null | Chart minor grid settings to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.xScale
Getter for default chart X scale.
Returns:
anychart.scales.ScatterBase - Default chart scale value.Try it:
Setter for default chart X scale.
Detailed description
Note: This scale will be passed to all scale dependent chart elements if they don't have their own scales.
Note: You can pass linear or logarithmic scales only.
Note: You can pass linear or logarithmic scales only.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | anychart.enums.ScatterScaleTypes | string | anychart.scales.ScatterBase | anychart.scales.Linear | X Scale to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Try it:
yAxis
Getter for chart Y-axis.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Chart axis index. If not set - creates a new instance and adds it to the end of array. |
Returns:
anychart.core.axes.Linear - Axis instance by index.Try it:
Setter for chart Y-axis.
Detailed description
You can use multiple axes for a chart.
Sets chart Y-axis settings depending on parameter type:
- null/boolean - disable or enable chart Y-axis.
- object - sets chart Y-axis settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | boolean | null | true | Chart axis settings to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Setter for chart Y-axis by index.
Detailed description
Sets chart Y-axis settings depending on parameter type:
- null/boolean - disable or enable chart Y-axis by index.
- object - sets chart Y-axis settings by index.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Chart axis index. |
| settings | Object | boolean | null | Chart axis settings to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.yGrid
Getter for chart grid by Y-scale.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Chart grid index. If not set - creates a new instance and adds it to the end of grid array. |
Returns:
anychart.core.grids.Linear - Axis instance by index.Try it:
Setter for chart grid by Y-scale.
Detailed description
Sets chart grid settings depending on parameter type:
- null/boolean - disable or enable chart grid.
- object - sets chart grid settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | boolean | null | false | Chart grid settings to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Setter for chart grid by index.
Detailed description
Sets chart grid settings depending on parameter type:
- null/boolean - disable or enable chart grid by index.
- object - sets chart grid settings by index.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Chart grid index. |
| settings | Object | boolean | null | Chart grid settings to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.yMinorGrid
Getter for chart minor grid by Y-scale.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Chart minor grid index. If not set - creates a new instance and adds it to the end of array. |
Returns:
anychart.core.grids.Linear - Axis instance by index.Try it:
Setter for chart minor grid by Y-scale.
Detailed description
Sets chart minor grid settings depending on parameter type:
- null/boolean - disable or enable chart minor grid.
- object - sets chart minor grid settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | boolean | null | false | Chart minor grid settings to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Setter for chart minor grid by index.
Detailed description
Sets chart minor grid settings depending on parameter type:
- null/boolean - disable or enable chart minor grid by index.
- object - sets chart minor grid settings by index.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Chart minor grid index. |
| settings | Object | boolean | null | Chart minor grid settings to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.yScale
Getter for default chart Y scale.
Returns:
anychart.scales.ScatterBase - Default chart scale value.Try it:
Setter for default chart Y scale.
Detailed description
Note: This scale will be passed to all scale dependent chart elements if they don't have their own scales.
Note: You can pass linear or logarithmic scales only.
Note: You can pass linear or logarithmic scales only.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | anychart.enums.ScatterScaleTypes | string | anychart.scales.ScatterBase | anychart.scales.Linear | Y Scale to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Try it:
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.
Detailed description
The bigger the index - the higher the element position is.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| zIndex | number | 0 | Z-index to set. |
Returns:
anychart.charts.Scatter - Self instance for method chaining.Try it: