class anychart.core.radar.series.Line Improve this Doc
Extends: anychart.core.radar.series.ContinuousBase
Define Line series type.
Note: Better for use anychart.charts.Radar#line method.
Methods Overview
Specific settings | |
connectMissingPoints() | Connect missing points setting. |
id() | Series id. |
legendItem() | Legend item settings. |
selectionMode() | Selection mode. |
transformXY() | Transforms values to pixel coordinates. |
Coloring | |
color() | Color settings. |
hoverStroke() | Stroke settings in hover mode. |
selectStroke() | Stroke settings in selected mode. |
stroke() | Stroke settings. |
Data | |
data() | Data settings. |
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. |
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() | Removes hover from the series point or series. |
unselect() | Deselects all selected points. |
Point Elements | |
getPoint() | Gets wrapped point by index. |
hoverLabels() | Labels settings in hover mode. |
hoverMarkers() | Markers settings in hover mode. |
labels() | Labels settings. |
markers() | Markers settings. |
selectLabels() | Labels settings in selected mode. |
selectMarkers() | Markers 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.radar.series.Line - 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.radar.series.Line - 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.radar.series.Line - Self instance for method chaining.Try it:
color
Params:
Name | Type | Description |
---|---|---|
value | string | Color as a string. |
Returns:
anychart.core.radar.series.Line - Self instance for method chaining.Try it:
connectMissingPoints
Returns:
boolean - ConnectMissingPoints mode.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | boolean | false | If set to true, the series will not be interrupted on missing points. Markers will not be drawn for missing points in both cases. |
Returns:
anychart.core.radar.series.Line - Self instance for method chaining.Try it:
data
Params:
Name | Type | Description |
---|---|---|
value | anychart.data.View | anychart.data.Set | Array | string | Value to set. |
csvSettings | anychart.enums.TextParsingMode | anychart.data.TextParsingSettings | If CSV string is passed by first param, you can pass CSV parser settings here as a hash map. |
Returns:
anychart.core.radar.series.Line - Self instance for method chaining.enabled
Returns:
boolean - The current element state.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | boolean | true | Value to set. |
Returns:
anychart.core.radar.series.Line - 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 | 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.radar.series.Line - Returns self for method chaining.Try it:
hover
Note: Works only after anychart.charts.Radar#draw is called.
Returns:
anychart.core.radar.series.Line - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
index | number | Point index. |
Returns:
anychart.core.radar.series.Line - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
indexes | Array.<number> | Array of indexes. |
Returns:
anychart.core.radar.series.Line - Self instance for method chaining.Try it:
hoverLabels
Returns:
anychart.core.ui.LabelsFactory - Labels instance.Try it:
- null/boolean - disable or enable labels.
- object - sets labels settings.
Params:
Name | Type | Default | Description |
---|---|---|---|
value | Object | boolean | null | false | Series data labels settings. |
Returns:
anychart.core.radar.series.Line - Self instance for method chaining.hoverMarkers
Returns:
anychart.core.ui.MarkersFactory - Markers instance.Try it:
- null/boolean - disable or enable series markers.
- object - sets series markers settings.
- string - sets series markers type.
Params:
Name | Type | Default | Description |
---|---|---|---|
value | Object | boolean | null | string | false | Series data markers settings. |
Returns:
anychart.core.radar.series.Line - Self instance for method chaining.hoverStroke
Returns:
anychart.graphics.vector.Stroke - Hover stroke settings.Params:
Name | Type | Default | Description |
---|---|---|---|
strokeFunction | function | function() { return anychart.color.darken(this.sourceColor); } | Function that looks like function(){
// this.index - series index.
// this.sourceColor - color returned by stroke() getter.
// this.iterator - series point iterator.
return strokeValue; // type anychart.graphics.vector.Fill or anychart.graphics.vector.Stroke
} . |
Returns:
anychart.core.radar.series.Line - Self instance for method chaining.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
color | anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null | Stroke settings. | |
thickness | number | 1 | Line thickness. |
dashpattern | string | Controls the pattern of dashes and gaps used to stroke paths. | |
lineJoin | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
lineCap | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.core.radar.series.Line - Self instance 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.radar.series.Line - 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. |
labels
- null/boolean - disable or enable labels.
- object - sets labels settings.
Params:
Name | Type | Default | Description |
---|---|---|---|
value | Object | boolean | null | false | Series data labels settings. |
Returns:
anychart.core.radar.series.Line - Self instance for method chaining.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.radar.series.Line - Returns self for method chaining.Try it:
legendItem
Returns:
anychart.core.utils.LegendItemSettings - Legend item settings.Params:
Name | Type | Description |
---|---|---|
value | Object | Legend item settings object. |
Returns:
anychart.core.radar.series.Line - Self instance 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:
markers
- null/boolean - disable or enable series markers.
- object - sets series markers settings.
- string - sets series markers type.
Params:
Name | Type | Default | Description |
---|---|---|---|
value | Object | boolean | null | string | false | Series data markers settings. |
Returns:
anychart.core.radar.series.Line - Self instance for method chaining.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.radar.series.Line - 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.radar.series.Line - Self instance for method chaining.Try it:
meta
Params:
Name | Type | Description |
---|---|---|
key | * | Metadata key. |
Returns:
* - Metadata object by key.Try it:
Params:
Name | Type | Description |
---|---|---|
object | * | Object to replace metadata. |
Returns:
anychart.core.radar.series.Line - Self instance for method chaining.chart.line([1,2,3]).meta({ 'location': 'QA', 'source': 'https://some-url.dmn', 'imageSRC': 'https://some-url.dmn/getImage.php?bySomeParam=Value' });
Params:
Name | Type | Description |
---|---|---|
key | string | Metadata key. |
value | * | Metadata value. |
Returns:
anychart.core.radar.series.Line - Self instance for method chaining.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
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.radar.series.Line - 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.radar.series.Line - Self instance for method chaining.Try it:
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.Line - 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.radar.series.Line - Returns self for method chaining.Try it:
select
Params:
Name | Type | Description |
---|---|---|
index | number | Index of the point to select. |
Returns:
anychart.core.radar.series.Line - 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.radar.series.Line - 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.radar.series.Line - Self instance for method chaining.selectMarkers
Returns:
anychart.core.ui.MarkersFactory - Markers instance.Try it:
- null/boolean - disable or enable series markers.
- object - sets series markers settings.
- string - sets series markers type.
Params:
Name | Type | Description |
---|---|---|
value | Object | boolean | null | string | Series data markers settings. |
Returns:
anychart.core.radar.series.Line - Self instance for method chaining.selectStroke
Returns:
anychart.graphics.vector.Stroke - Select stroke settings.Params:
Name | Type | Default | Description |
---|---|---|---|
strokeFunction | function | function() { return anychart.color.darken(this.sourceColor); } | Function that looks like function(){
// this.index - series index.
// this.sourceColor - color returned by stroke() getter.
// this.iterator - series point iterator.
return strokeValue; // type anychart.graphics.vector.Fill or anychart.graphics.vector.Stroke
} . |
Returns:
anychart.core.radar.series.Line - Self instance for method chaining.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
color | anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null | Stroke settings. | |
thickness | number | 1 | Line thickness. |
dashpattern | string | Controls the pattern of dashes and gaps used to stroke paths. | |
lineJoin | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
lineCap | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.core.radar.series.Line - Self instance for method chaining.Try it:
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.radar.series.Line - Self instance for method chaining.Try it:
stroke
Returns:
anychart.graphics.vector.Stroke - Stroke settings.Params:
Name | Type | Default | Description |
---|---|---|---|
fillFunction | function | function() { return anychart.color.darken(this.sourceColor); } | Function that looks like function(){
// this.index - series index.
// this.sourceColor - color returned by stroke() getter.
// this.iterator - series point iterator.
return strokeValue; // type anychart.graphics.vector.Fill or anychart.graphics.vector.Stroke
} . |
Returns:
anychart.core.radar.series.Line - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
color | anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null | Stroke settings. |
thickness | number | Line thickness. |
dashpattern | string | Controls the pattern of dashes and gaps used to stroke paths. |
lineJoin | anychart.graphics.vector.StrokeLineJoin | Line join style. |
lineCap | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.core.radar.series.Line - Self instance for method chaining.Try it:
tooltip
- null/boolean - disable or enable tooltip.
- object - sets tooltip settings.
Params:
Name | Type | Default | Description |
---|---|---|---|
value | Object | boolean | null | true | Tooltip settings. |
Returns:
anychart.core.radar.series.Line - Self instance for method chaining.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.radar.series.Line - Returns self for method chaining.Try it:
transformXY
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
Returns:
anychart.core.radar.series.Line - 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.radar.series.Line - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
index | number | Index of the point to select. |
Returns:
anychart.core.radar.series.Line - 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.radar.series.Line - 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.radar.series.Line - Returns self for method chaining.Try it:
xScale
Params:
Name | Type | Default | Description |
---|---|---|---|
value | anychart.scales.Base | "ordinal" | Value to set. |
Returns:
anychart.core.radar.series.Line - Self instance for method chaining.Try it:
yScale
Params:
Name | Type | Default | Description |
---|---|---|---|
value | anychart.scales.Base | "linear" | Value to set. |
Returns:
anychart.core.radar.series.Line - 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.radar.series.Line - Self instance for method chaining.Try it: