class anychart.core.polar.series.Base Improve this Doc
Extends: anychart.core.SeriesBase
Base class for all polar series.
Base class defines common methods, such as those for:
- Binding series to a scale: xScale, yScale
- Base color settings: color
Methods Overview
Specific settings | |
a11y() | Accessibility settings. |
id() | Series id. |
maxPointWidth() | Maximum point width settings. |
pointWidth() | Point width settings. |
selectionMode() | Selection mode. |
transformXY() | Transforms values to pixel coordinates. |
Coloring | |
colorScale() | Color scale settings. |
Data | |
excludePoint() | Excludes points at the specified index. |
getExcludedPoints() | Returns an array of excluded points. |
getStat() | Gets the statistics value by key. |
includeAllPoints() | Includes all excluded points. |
includePoint() | Includes excluded points with the specified indexes. |
keepOnlyPoints() | Keep only the specified points. |
Interactivity | |
enabled() | Element state (enabled or disabled). |
hovered() | Hovered state settings. |
normal() | Normal state settings. |
select() | Select settings. |
selected() | Selected state settings. |
unhover() | Removes hover from the series. |
unselect() | Deselects all selected points. |
Point Elements | |
getPoint() | Gets wrapped point by index. |
maxLabels() | Maximum labels settings. |
minLabels() | Minimum labels settings. |
Scales | |
xScale() | X-scale settings. |
yScale() | Y-scale settings. |
Size and Position | |
bottom() | Bottom bound settings. |
bounds() | Bounds settings. |
getPixelBounds() | Returns pixel bounds. |
height() | Height settings. |
left() | Left bound settings. |
maxHeight() | Maximum height. |
maxWidth() | Maximum width. |
minHeight() | Minimum height. |
minWidth() | Minimum width. |
right() | Right bound settings. |
top() | Top bound settings. |
width() | Width settings. |
zIndex() | Z-index of the element. |
Methods Description
a11y
Returns:
anychart.core.utils.SeriesA11y - Accessibility settings object.var series = chart.line([3, 5, 2, 14, 3]); var a11y = series.a11y();
Sets accessibility setting depending on parameter type:
- boolean - disable or enable accessibility.
- object - sets accessibility setting.
Params:
Name | Type | Description |
---|---|---|
value | boolean | Object | Whether to enable accessibility. |
Returns:
anychart.core.polar.series.Base - Self instance for method chaining.bottom
Returns:
number | string | undefined - Element's bottom bound setting.Params:
Name | Type | Default | Description |
---|---|---|---|
bottom | number | string | null | null | Bottom bound settings for the element. |
Returns:
anychart.core.polar.series.Base - Returns self for method chaining.Try it:
bounds
Returns:
anychart.core.utils.Bounds - Bounds of the element.Params:
Name | Type | Description |
---|---|---|
bounds | anychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.Bounds | Bounds of element. |
Returns:
anychart.core.polar.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.polar.series.Base - Self instance for method chaining.Try it:
colorScale
var series = chart.line(); var colorScale = series.colorScale();
Params:
Name | Type | Description |
---|---|---|
settings | anychart.scales.LinearColor | anychart.scales.OrdinalColor | Object | anychart.enums.ScaleTypes | string | Scale to set. |
Returns:
anychart.core.polar.series.Base - Self instance for method chaining.Try it:
enabled
Returns:
boolean - Element state.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
enabled | boolean | true | Enabled state to set. |
Returns:
anychart.core.polar.series.Base - Self instance for method chaining.if (!element.enabled()) element.enabled(true);
Try it:
excludePoint
Params:
Name | Type | Description |
---|---|---|
indexes | number | Array.<number> | Points indexes. |
Returns:
boolean - Returns 'true' if the points were excluded.getExcludedPoints
Returns:
Array.<anychart.core.Point> - Array of the points.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 | anychart.enums.Statistics | string | Key. |
Returns:
* - Statistics value.Try it:
height
Returns:
number | string | undefined - Element's height setting.Params:
Name | Type | Default | Description |
---|---|---|---|
height | number | string | null | null | Height settings for the element. |
Returns:
anychart.core.polar.series.Base - Returns self for method chaining.Try it:
hovered
Returns:
anychart.core.StateSettings - Hovered state settingsTry it:
Params:
Name | Type | Description |
---|---|---|
settings | Object | State settings to set. |
Returns:
anychart.core.polar.series.Base - Self instance for method chaining.Try it:
id
Params:
Name | Type | Description |
---|---|---|
id | string | number | Id of the series. Default id is equal to internal index. |
Returns:
anychart.core.polar.series.Base - Self instance for method chaining.Try it:
includeAllPoints
Returns:
boolean - Returns 'true' if all points were included.includePoint
Params:
Name | Type | Description |
---|---|---|
indexes | number | Array.<number> | Points indexes. |
Returns:
boolean - Returns true if the points were included.keepOnlyPoints
Params:
Name | Type | Description |
---|---|---|
indexes | number | Array.<number> | Point index or indexes. |
left
Returns:
number | string | undefined - Element's left bound setting.Params:
Name | Type | Default | Description |
---|---|---|---|
left | number | string | null | null | Left bound setting for the element. |
Returns:
anychart.core.polar.series.Base - Returns self for method chaining.Try it:
maxHeight
Returns:
number | string | null - Element's maximum height.Params:
Name | Type | Default | Description |
---|---|---|---|
height | number | string | null | null | Maximum height to set. |
Returns:
anychart.core.polar.series.Base - Self instance for method chaining.Try it:
maxLabels
- 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.core.polar.series.Base - Self instance for method chaining.maxPointWidth
Returns:
string | number - The maximum point width pixel value.var maxPointWidth = series.maxPointWidth();
Params:
Name | Type | Description |
---|---|---|
value | number | string | Point width pixel value. |
Returns:
anychart.core.polar.series.Base - Self instance for method chaining.Try it:
maxWidth
Returns:
number | string | null - Element's maximum width.Params:
Name | Type | Default | Description |
---|---|---|---|
width | number | string | null | null | Maximum width to set. |
Returns:
anychart.core.polar.series.Base - Self instance for method chaining.Try it:
minHeight
Returns:
number | string | null - Element's minimum height.Params:
Name | Type | Default | Description |
---|---|---|---|
height | number | string | null | null | Minimum height to set. |
Returns:
anychart.core.polar.series.Base - Self instance for method chaining.Try it:
minLabels
- 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.core.polar.series.Base - Self instance for method chaining.minWidth
Returns:
number | string | null - Element's minimum width.Params:
Name | Type | Default | Description |
---|---|---|---|
width | number | string | null | null | Minimum width to set. |
Returns:
anychart.core.polar.series.Base - Self instance for method chaining.Try it:
normal
Returns:
anychart.core.StateSettings - Normal state settings.Try it:
Params:
Name | Type | Description |
---|---|---|
settings | Object | State settings to set. |
Returns:
anychart.core.polar.series.Base - Self instance for method chaining.Try it:
pointWidth
Returns:
string | number - The point width pixel value.var pointWidth = series.pointWidth();
Params:
Name | Type | Description |
---|---|---|
value | number | string | Point width pixel value. |
Returns:
anychart.core.polar.series.Base - Self instance for method chaining.Try it:
right
Returns:
number | string | undefined - Element's right bound setting.Params:
Name | Type | Default | Description |
---|---|---|---|
right | number | string | null | null | Right bound setting for the element. |
Returns:
anychart.core.polar.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.polar.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.polar.series.Base - Self instance for method chaining.Try it:
selected
Returns:
anychart.core.StateSettings - Selected state settingsTry it:
Params:
Name | Type | Description |
---|---|---|
settings | Object | State settings to set. |
Returns:
anychart.core.polar.series.Base - Self instance for method chaining.Try it:
selectionMode
Returns:
anychart.enums.SelectionMode | string | null - Selection mode.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | anychart.enums.SelectionMode | string | null | 'multiSelect' | Selection mode. |
Returns:
anychart.core.polar.series.Base - Self instance for method chaining.Try it:
top
Returns:
number | string | undefined - Element's top bound setting.Params:
Name | Type | Default | Description |
---|---|---|---|
top | number | string | null | null | Top bound setting for the element. |
Returns:
anychart.core.polar.series.Base - Returns self for method chaining.Try it:
transformXY
Params:
Name | Type | Description |
---|---|---|
xValue | * | Value by x. |
yValue | * | Value by y. |
Returns:
Object.<string, number> - Object of pixel values.Try it:
unhover
Params:
Name | Type | Description |
---|---|---|
indexOrIndexes | number | Array.<number> | Point index or array of indexes. |
Returns:
anychart.core.polar.series.Base - Self instance for method chaining.Try it:
unselect
Returns:
anychart.core.polar.series.Base - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
index | number | Index of the point to select. |
Returns:
anychart.core.polar.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.polar.series.Base - Self instance for method chaining.Try it:
width
Returns:
number | string | undefined - Element's width setting.Params:
Name | Type | Default | Description |
---|---|---|---|
width | number | string | null | null | Width settings for the element. |
Returns:
anychart.core.polar.series.Base - Returns self for method chaining.Try it:
xScale
Params:
Name | Type | Default | Description |
---|---|---|---|
settings | anychart.scales.Base | Object | anychart.enums.ScaleTypes | string | anychart.scales.Linear | Scale settings to set. |
Returns:
anychart.core.polar.series.Base - Self instance for method chaining.Try it:
yScale
Params:
Name | Type | Default | Description |
---|---|---|---|
settings | anychart.scales.Base | Object | anychart.enums.ScaleTypes | string | anychart.scales.Linear | Scale settings to set. |
Returns:
anychart.core.polar.series.Base - Self instance for method chaining.Try it:
zIndex
Params:
Name | Type | Default | Description |
---|---|---|---|
zIndex | number | 0 | Value to set. |
Returns:
anychart.core.polar.series.Base - Self instance for method chaining.Try it: