Top
You are looking at an outdated 7.12.0 version of this document. Switch to the 7.13.1 version to see the up to date information.

class anychart.core.radar.series.Base Improve this Doc

Extends: anychart.core.SeriesBase

Base class for all radar 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.
legendItem()Legend item settings.
selectionMode()Selection mode.
transformXY()Transforms values to pixel coordinates.
Coloring
color()Color settings.
Data
data()Data settings.
getStat()Getter for the statistics value by key.
meta()Meta data settings.
name()Series name 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
print()Prints all elements.
Interactivity
enabled()Element state (enabled or disabled).
hover()Hovers points or series.
select()Select settings.
tooltip()Tooltip settings.
unhover()Unhover settings.
unselect()Deselects all selected points.
Point Elements
getPoint()Gets wrapped point by index.
hoverLabels()Labels settings in hover mode.
labels()Labels settings.
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

Getter for element bottom bound setting.

Returns:

number string undefined - Current element's bottom bound setting.
Sets element bottom bound setting.

Params:

Name Type Default Description
value number | string | null
null
Bottom bound setting for the element.

Returns:

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

Try it:

bounds

Getter for the element bounds settings.

Returns:

anychart.core.utils.Bounds - Current bounds of the element.
Sets 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 the 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:

color

Getter for current series color.

Returns:

anychart.graphics.vector.Fill - Current color.

Try it:

Sets color settings using an object or a string. Learn more about coloring.

Params:

Name Type Default Description
value anychart.graphics.vector.Fill
'#1D8BD1'
Color as an object or a string.

Returns:

anychart.core.radar.series.Base - Self instance for method chaining.
Color with opacity.
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.core.radar.series.Base - Self instance for method chaining.

Try it:

Linear gradient. 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.core.radar.series.Base - Self instance for method chaining.

Try it:

Radial gradient. 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.core.radar.series.Base - Self instance for method chaining.

Try it:

data

Getter for series mapping.

Returns:

anychart.data.View - Returns current mapping.

Try it:

Setter for series mapping.

Params:

Name Type Description
value anychart.data.View | anychart.data.Set | Array | string Value to set.
csvSettings Object.<string, (string|boolean)> If CSV string is passed by first param, you can pass CSV parser settings here as a hash map.

Returns:

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

enabled

Getter for the current element state (enabled or disabled).

Returns:

boolean - The current 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:

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 string | anychart.enums.Statistics Key.

Returns:

* - Statistics value.

Try it:

height

Getter for element height setting.

Returns:

number string undefined - Current element's height setting.
Sets element height setting.

Params:

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

Returns:

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

Try it:

hover

Hovers points or series.

Returns:

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

Try it:

Hovers a point or a series by index.

Params:

Name Type Description
index number Point index.

Returns:

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

Try it:

Hovers points or series by indexes.

Params:

Name Type Description
indexes Array.<number> Array of indexes.

Returns:

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

Try it:

hoverLabels

Gettter for the current series hover data labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Setter for the series hover data labels.

Params:

Name Type Default Description
value Object | boolean | null
false
Series data labels settings.

Returns:

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

id

Getter for the current series id.

Returns:

string number - The current 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:

labels

Getter for current series data labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Setter for series data labels.

Params:

Name Type Default Description
value Object | boolean | null
false
Series data labels settings.

Returns:

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

Try it:

left

Getter for element left bound setting.

Returns:

number string undefined - Current element's left bound setting.
Sets element left bound setting.

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:

legendItem

Getter for legend item settings of series.

Returns:

anychart.core.utils.LegendItemSettings - Legend item settings.
Setter for legend item settings of series.

Params:

Name Type Description
value Object Legend item settings object.

Returns:

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

Try it:

listen

Adds an event listener to an implementing object.

Params:

Name Type 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 Whether to fire in capture phase (defaults to false).
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 Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope Object Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

maxHeight

Getter for maximum height.

Returns:

number string null - Current element's maximum height.
Setter for 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:

maxWidth

Getter for maximum width.

Returns:

number string null - Current element's maximum width.
Setter for 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:

meta

Getter for series meta data.

Params:

Name Type Description
key * Metadata key.

Returns:

* - Metadata object by key.

Try it:

Setter for series meta data.

Params:

Name Type Description
object * Object to replace metadata.

Returns:

anychart.core.radar.series.Base - Self instance for method chaining.
Sample for series meta data.
chart.line([1,2,3]).meta({
    'location': 'QA',
    'source': 'https://some-url.dmn',
    'imageSRC': 'https://some-url.dmn/getImage.php?bySomeParam=Value'
});
Add/Replace meta data for series by key.

Params:

Name Type Description
key string Metadata key.
value * Metadata value.

Returns:

anychart.core.radar.series.Base - Self instance for method chaining.
Sample: meta data for series by key.
var series = chart.line([1,2,3]);
series.meta('location', 'QA');
series.meta('source', 'https://some-url.dmn');
series.meta('imageSRC', 'https://some-url.dmn/getImage.php?bySomeParam=Value');

minHeight

Getter for minimum height.

Returns:

number string null - Current element's minimum height.
Setter for 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 minimum width.

Returns:

number string null - Current element's minimum width.
Setter for 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:

name

Getter for series name.

Returns:

string undefined - Series name value.

Try it:

Setter for series name.
Basically, name of series is used in Legend displaying, but it can be used in tooltips as well.

Params:

Name Type Default Description
value string
undefined
Value to set.

Returns:

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

Try it:

print

Prints all elements on related stage.

Params:

Name Type Default Description
paperSize anychart.graphics.vector.PaperSize
Paper size.
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 setting.

Returns:

number string undefined - Current element's right bound setting.
Sets 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:

selectLabels

Gets the current series select data labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Sets the series select data labels.

Params:

Name Type Description
value Object | boolean | null Series data labels settings.

Returns:

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

selectionMode

Gets the current state of the series for selection mode.

Returns:

anychart.enums.SelectionMode 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:

tooltip

Getter for current series data tooltip.

Returns:

anychart.core.ui.Tooltip - Tooltip instance.

Try it:

Setter for series data tooltip.

Params:

Name Type Default Description
value Object | boolean | null
true
Tooltip settings.

Returns:

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

top

Getter for element top bound setting.

Returns:

number string undefined - Current element's top bound setting.
Sets element top bound setting.

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.

Params:

Name Type Description
xVal * Value by x.
yVal * Value by y.
xSubRangeRatio number Ratio value.

Returns:

Object.<string, number> - Pixel values.

Try it:

unhover

Removes hover from the series.

Returns:

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

Try it:

Removes hover from the series by index.

Params:

Name Type Description
index number Point index.

Returns:

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

Try it:

Removes hover from the series by indexes.

Params:

Name Type Description
indexes Array.<number> Array of indexes.

Returns:

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

Try it:

unlisten

Removes a listener added using listen() or listenOnce() methods.

Params:

Name Type Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
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 setting.

Returns:

number string undefined - Current element's width setting.
Sets element width setting.

Params:

Name Type Default Description
value number | string | null
null
Width setting for the element.

Returns:

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

Try it:

xScale

Getter for current series X scale.

Returns:

anychart.scales.Base - Current series X Scale.

Try it:

Setter for series X scale.

Params:

Name Type Default Description
value anychart.scales.Base
"ordinal"
Value to set.

Returns:

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

Try it:

yScale

Getter for current series Y scale.

Returns:

anychart.scales.Base - Current series Y Scale.

Try it:

Setter for series Y scale.

Params:

Name Type Default Description
value anychart.scales.Base
"linear"
Value to set.

Returns:

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

Try it:

zIndex

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.

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: