class anychart.core.scatter.series.Base Improve this Doc
Extends: anychart.core.SeriesBase
Base class for all scatter series.
Methods Overview
Specific settings | |
clip() | Clip settings. |
id() | Series id. |
selectionMode() | Selection mode. |
transformX() | Transforms X value to pixel coordinates. |
transformY() | Transforms Y value to pixel coordinates. |
Data | |
excludePoint() | Excludes points at the specified index. |
getExcludedPoints() | Returns an array of excluded points. |
getStat() | Getter for the statistics value by key. |
includeAllPoints() | Includes all excluded points. |
includePoint() | Includes excluded points with the specified indexes. |
keepOnlyPoints() | Keep only the specified points. |
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 | |
print() | Prints all elements. |
Interactivity | |
enabled() | Element state (enabled or disabled). |
select() | Select settings. |
unhover() | Removes hover from the series. |
unselect() | Deselects all selected points. |
Point Elements | |
error() | Error settings. |
getPoint() | Gets wrapped point by index. |
selectLabels() | Labels settings in selected mode. |
Scales | |
xScale() | X-scale settings. |
yScale() | Y-scale settings. |
Size and Position | |
bottom() | Bottom bound setting. |
bounds() | Bounds settings. |
getPixelBounds() | Returns pixel bounds. |
height() | Height setting. |
left() | Left bound setting. |
maxHeight() | Maximum height. |
maxWidth() | Maximum width. |
minHeight() | Minimum height. |
minWidth() | Minimum width. |
right() | Right bound setting. |
top() | Top bound setting. |
width() | Width setting. |
zIndex() | Z-index of the element. |
Methods Description
bottom
Returns:
number | string | undefined - Current element's bottom bound setting.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Bottom bound setting for the element. |
Returns:
anychart.core.scatter.series.Base - Returns self for method chaining.Try it:
bounds
Returns:
anychart.core.utils.Bounds - Current bounds of the element.Params:
Name | Type | Description |
---|---|---|
value | anychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.Bounds | Bounds of element. |
Returns:
anychart.core.scatter.series.Base - Self instance for method chaining.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
x | number | string | null | X-coordinate. |
y | number | string | null | Y-coordinate. |
width | number | string | null | Width. |
height | number | string | null | Height. |
Returns:
anychart.core.scatter.series.Base - Self instance for method chaining.Try it:
clip
Params:
Name | Type | Default | Description |
---|---|---|---|
value | boolean | anychart.math.Rect | False, if series is created manually. | Enable/disable series clip. |
Returns:
anychart.core.scatter.series.Base - Self instance for method chaining.Try it:
enabled
Returns:
boolean - The current element state.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | boolean | true | Value to set. |
Returns:
anychart.core.scatter.series.Base - Self instance for method chaining.if (!element.enabled()) element.enabled(true);
Try it:
error
- null - disable series error.
- boolean - enable mode both or none for series error.
- string - sets value for series error.
- object - sets series error settings.
Params:
Name | Type | Description |
---|---|---|
value | Object | null | boolean | string | number | Error settings. An error value can be set as absolute numbers or as a percentage. |
Returns:
anychart.core.scatter.series.Base - Self instance for method chaining.excludePoint
Params:
Name | Type | Description |
---|---|---|
indexes | number | Array.<number> | Points indexes. |
Returns:
boolean - Returns 'true' if the points were excluded.Try it:
getExcludedPoints
Returns:
Array.<anychart.core.Point> - Array of the points.Try it:
getPixelBounds
Returns:
anychart.math.Rect - Pixel bounds of the element.getPoint
Params:
Name | Type | Description |
---|---|---|
index | number | Point index. |
Returns:
anychart.core.SeriesPoint - Wrapped point.Try it:
getStat
Params:
Name | Type | Description |
---|---|---|
key | string | anychart.enums.Statistics | Key. |
Returns:
* - Statistics value.Try it:
height
Returns:
number | string | undefined - Current element's height setting.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Height setting for the element. |
Returns:
anychart.core.scatter.series.Base - Returns self for method chaining.Try it:
id
Returns:
string | number - The current series id.Try it:
Params:
Name | Type | Description |
---|---|---|
value | string | number | Id of the series. Default id is equal to internal index. |
Returns:
anychart.core.scatter.series.Base - Self instance for method chaining.Try it:
includeAllPoints
Returns:
boolean - Returns 'true' if all points were included.Try it:
includePoint
Params:
Name | Type | Description |
---|---|---|
indexes | number | Array.<number> | Points indexes. |
Returns:
boolean - Returns true if the points were included.Try it:
keepOnlyPoints
Params:
Name | Type | Description |
---|---|---|
indexes | number | Array.<number> | Point index or indexes. |
Try it:
left
Returns:
number | string | undefined - Current element's left bound setting.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Left bound setting for the element. |
Returns:
anychart.core.scatter.series.Base - Returns self for method chaining.Try it:
listen
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 | 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
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 | 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:
maxHeight
Returns:
number | string | null - Current element's maximum height.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Value to set. |
Returns:
anychart.core.scatter.series.Base - Self instance for method chaining.Try it:
maxWidth
Returns:
number | string | null - Current element's maximum width.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Value to set. |
Returns:
anychart.core.scatter.series.Base - Self instance for method chaining.Try it:
minHeight
Returns:
number | string | null - Current element's minimum height.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Value to set. |
Returns:
anychart.core.scatter.series.Base - Self instance for method chaining.Try it:
minWidth
Returns:
number | string | null - Current element's minimum width.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Value to set. |
Returns:
anychart.core.scatter.series.Base - Self instance for method chaining.Try it:
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
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
Returns:
number | string | undefined - Current element's right bound setting.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Right bound setting for the element. |
Returns:
anychart.core.scatter.series.Base - Returns self for method chaining.Try it:
select
Params:
Name | Type | Description |
---|---|---|
index | number | Index of the point to select. |
Returns:
anychart.core.scatter.series.Base - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
indexes | number | Array.<number> | Array of indexes of the point to select. |
Returns:
anychart.core.scatter.series.Base - Self instance for method chaining.Try it:
selectLabels
Returns:
anychart.core.ui.LabelsFactory - Labels instance.Try it:
- null/boolean - disable or enable labels in selected state.
- object - sets selected labels settings.
Params:
Name | Type | Description |
---|---|---|
value | Object | boolean | null | Series data labels settings. |
Returns:
anychart.core.scatter.series.Base - Self instance for method chaining.selectionMode
Returns:
anychart.enums.SelectionMode | null - Selection mode.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | anychart.enums.SelectionMode | string | null | "multiSelect" | Selection mode. |
Returns:
anychart.core.scatter.series.Base - Self instance for method chaining.Try it:
top
Returns:
number | string | undefined - Current element's top bound setting.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Top bound setting for the element. |
Returns:
anychart.core.scatter.series.Base - Returns self for method chaining.Try it:
transformX
Params:
Name | Type | Description |
---|---|---|
xValue | * | X value. |
Returns:
number - Pixel value.Try it:
transformY
Params:
Name | Type | Description |
---|---|---|
yValue | * | Y value. |
Returns:
number - Pixel value.Try it:
unhover
Params:
Name | Type | Description |
---|---|---|
indexOrIndexes | number | Array.<number> | Point index or array of indexes. |
Returns:
anychart.core.scatter.series.Base - Self instance for method chaining.Try it:
unlisten
Params:
Name | Type | Default | Description |
---|---|---|---|
type | string | The event type id. | |
listener | function | Callback method. | |
useCapture | boolean | false | Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing |
listenerScope | Object | Object in whose scope to call the listener. |
Returns:
boolean - Whether any listener was removed.Try it:
unlistenByKey
Params:
Name | Type | Description |
---|---|---|
key | Object | The key returned by listen() or listenOnce(). |
Returns:
boolean - Whether any listener was removed.Try it:
unselect
Returns:
anychart.core.scatter.series.Base - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
index | number | Index of the point to select. |
Returns:
anychart.core.scatter.series.Base - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
indexes | Array.<number> | An array of indexes of the point to select. |
Returns:
anychart.core.scatter.series.Base - Self instance for method chaining.Try it:
width
Returns:
number | string | undefined - Current element's width setting.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Width setting for the element. |
Returns:
anychart.core.scatter.series.Base - Returns self for method chaining.Try it:
xScale
Returns:
anychart.scales.ScatterBase - Series X-scale.var xScale = series.xScale();
Params:
Name | Type | Default | Description |
---|---|---|---|
value | anychart.scales.Base | null | Value to set. |
Returns:
anychart.core.scatter.series.Base - Self instance for method chaining.Try it:
yScale
Returns:
anychart.scales.ScatterBase - Series Y-scale.var yScale = series.yScale();
Params:
Name | Type | Default | Description |
---|---|---|---|
value | anychart.scales.ScatterBase | null | Value to set. |
Returns:
anychart.core.scatter.series.Base - Self instance for method chaining.Try it:
zIndex
Returns:
number - The current zIndex.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | 0 | Value to set. |
Returns:
anychart.core.scatter.series.Base - Self instance for method chaining.Try it: