Top

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
You can also obtain getIterator, getResetIterator iterators here

Methods Overview

Specific settings
id()Series id.
maxPointWidth()Maximum point width settings.
pointWidth()Point width settings.
selectionMode()Selection mode.
transformXY()Transforms values 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).
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.
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

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
value number | string | null
null
Bottom bound settings for the element.

Returns:

anychart.core.VisualBaseWithBounds - 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
value anychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.Bounds Bounds of element.

Returns:

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

Try it:

Setter for element bounds settings.

Params:

Name Type Default Description
x number | string
null
X-coordinate.
y number | string
null
Y-coordinate.
width number | string
null
Width.
height number | string
null
Height.

Returns:

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

Try it:

enabled

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.

Try it:

Setter for the element enabled state.

Params:

Name Type Default Description
value boolean
true
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.
Example.
if (!element.enabled())
   element.enabled(true);

Try it:

excludePoint

Excludes points at the specified index.

Params:

Name Type Description
indexes number | Array.<number> Points indexes.

Returns:

boolean - Returns 'true' if the points were excluded.

getExcludedPoints

Returns an array of excluded points.

Returns:

Array.<anychart.core.Point> - Array of the points.

getPixelBounds

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

Returns:

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

getPoint

Gets wrapped point by index.

Params:

Name Type Description
index number Point index.

Returns:

anychart.core.SeriesPoint - Wrapped point.

Try it:

getStat

Getter for the statistics value by key.

Params:

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

Returns:

* - Statistics value.

Try it:

height

Getter for element height settings.

Returns:

number string undefined - Element's height setting.
Setter for element height setting.

Params:

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

Returns:

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

Try it:

hovered

Getter for hovered state settings.

Returns:

anychart.core.StateSettings - Hovered state settings

Try it:

Setter for hovered state settings.

Params:

Name Type Description
value Object State settings to set.

Returns:

anychart.core.polar.series.Base - Self instance for method chaining.

Try it:

id

Getter for the series id.

Returns:

string number - Series id.

Try it:

Setter for the series id.

Params:

Name Type Description
value string | number Id of the series. Default id is equal to internal index.

Returns:

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

Try it:

includeAllPoints

Includes all excluded points.

Returns:

boolean - Returns 'true' if all points were included.

includePoint

Includes excluded points with the specified indexes.

Params:

Name Type Description
indexes number | Array.<number> Points indexes.

Returns:

boolean - Returns true if the points were included.

keepOnlyPoints

Keep only the specified points.

Params:

Name Type Description
indexes number | Array.<number> Point index or indexes.

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
value number | string | null
null
Left bound setting for the element.

Returns:

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

Try it:

listen

Adds an event listener to an implementing object.

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

Adds an event listener to an implementing object.

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

Getter for the maximum height.

Returns:

number string null - Element's maximum height.
Setter for the maximum height.

Params:

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

Returns:

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

Try it:

maxPointWidth

Getter for the maximum point width.

Returns:

string number - The maximum point width pixel value.
See listing
var maxPointWidth = series.maxPointWidth();
Setter for the maximum point width.

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

Getter for the maximum width.

Returns:

number string null - Element's maximum width.
Setter for the maximum width.

Params:

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

Returns:

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

Try it:

minHeight

Getter for the minimum height.

Returns:

number string null - Element's minimum height.
Setter for the minimum height.

Params:

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

Returns:

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

Try it:

minWidth

Getter for the minimum width.

Returns:

number string null - Element's minimum width.
Setter for the minimum width.

Params:

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

Returns:

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

Try it:

normal

Getter for normal state settings.

Returns:

anychart.core.StateSettings - Normal state settings.

Try it:

Setter for normal state settings.

Params:

Name Type Description
value Object State settings to set.

Returns:

anychart.core.polar.series.Base - Self instance for method chaining.

Try it:

pointWidth

Getter for the point width settings.

Returns:

string number - The point width pixel value.
See listing
var pointWidth = series.pointWidth();
Setter for the point width settings.

Params:

Name Type Description
value number | string Point width pixel value.

Returns:

anychart.core.polar.series.Base - Self instance for method chaining.

Try it:

print

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:

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
value number | string | null
null
Right bound setting for the element.

Returns:

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

Try it:

select

Selects point by index.

Params:

Name Type Description
index number Index of the point to select.

Returns:

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

Try it:

Selects point by indexes.

Params:

Name Type Description
indexes number | Array.<number> Array of indexes of the point to select.

Returns:

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

Try it:

selected

Getter for selected state settings.

Returns:

anychart.core.StateSettings - Selected state settings

Try it:

Setter for selected state settings.

Params:

Name Type Description
value Object State settings to set.

Returns:

anychart.core.polar.series.Base - Self instance for method chaining.

Try it:

selectionMode

Gets the state of the series for selection mode.

Returns:

anychart.enums.SelectionMode string null - Selection mode.

Try it:

Allows to select points of the series. To select multiple points, press "ctrl" and click on them.

Params:

Name Type Default Description
value anychart.enums.SelectionMode | string | null
"multiSelect"
Selection mode.

Returns:

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

Try it:

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
value number | string | null
null
Top bound setting for the element.

Returns:

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

Try it:

transformXY

Transforms values to pixel coordinates. Note: Works only after anychart.charts.Polar#draw is called.

Params:

Name Type Description
xValue * Value by x.
yValue * Value by y.

Returns:

Object.<string, number> - Object of pixel values.

Try it:

unhover

Removes hover from the series.

Params:

Name Type Description
indexOrIndexes number | Array.<number> Point index or array of indexes.

Returns:

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

unselect

Deselects all selected points.

Returns:

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

Try it:

Deselects selected point by index.

Params:

Name Type Description
index number Index of the point to select.

Returns:

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

Try it:

Deselects selected points by indexes.

Params:

Name Type Description
indexes Array.<number> An array of indexes of the point to select.

Returns:

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

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
value number | string | null
null
Width settings for the element.

Returns:

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

Try it:

xScale

Getter for the series X scale.

Returns:

anychart.scales.Linear - Series X Scale.

Try it:

Setter for the series X scale.

Params:

Name Type Default Description
value anychart.scales.Base | Object | anychart.enums.ScaleTypes | string
anychart.scales.Linear
Value to set.

Returns:

anychart.core.polar.series.Base - Self instance for method chaining.

Try it:

yScale

Getter for the series Y scale.

Returns:

anychart.scales.Base - Current series Y Scale.

Try it:

Setter for the series Y scale.

Params:

Name Type Default Description
value anychart.scales.Base | Object | anychart.enums.ScaleTypes | string
anychart.scales.Linear
Value to set.

Returns:

anychart.core.polar.series.Base - Self instance for method chaining.

Try it:

zIndex

Getter for the Z-index of the element.

Returns:

number - Z-index.

Try it:

Setter for the Z-index of the element.

Params:

Name Type Default Description
value number
0
Value to set.

Returns:

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

Try it: