AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.core.polar.series.Polyline Improve this Doc

Extends: anychart.core.polar.series.ContinuousBase

Define Line series type.

Methods Overview

Specific settings
a11y()Accessibility settings.
closed()Close settings.
connectMissingPoints()Missing points settings.
id()Series id.
legendItem()Legend item settings.
selectionMode()Selection mode.
transformXY()Transforms values to pixel coordinates.
Coloring
color()Color settings.
colorScale()Color scale settings.
stroke()Stroke settings.
Data
data()Data settings.
getStat()Gets the statistics value by key.
meta()Series meta data settings.
name()Series name settings.
Interactivity
enabled()Element state (enabled or disabled).
hover()Hover settings.
hovered()Hovered state settings.
normal()Normal state settings.
select()Select settings.
selected()Selected state 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.
labels()Labels settings.
markers()Markers settings.
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

Getter for the accessibility setting.

Returns:

anychart.core.utils.SeriesA11y - Accessibility settings object.
See listing.
var series = chart.line([3, 5, 2, 14, 3]);
var a11y = series.a11y();
Setter for the accessibility setting.

Params:

NameTypeDescription
valueboolean | ObjectWhether to enable accessibility.

Returns:

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

bottom

Getter for element bottom bound settings.

Returns:

number | string | undefined - Element's bottom bound setting.
Setter for element bottom bound settings.

Params:

NameTypeDefaultDescription
bottomnumber | string | null
null
Bottom bound settings for the element.

Returns:

anychart.core.polar.series.Polyline - Returns self for method chaining.

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:

NameTypeDescription
boundsanychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.BoundsBounds of element.

Returns:

anychart.core.polar.series.Polyline - Self instance for method chaining.
Setter for element bounds settings.

Params:

NameTypeDefaultDescription
xnumber | string
null
X-coordinate.
ynumber | string
null
Y-coordinate.
widthnumber | string
null
Width.
heightnumber | string
null
Height.

Returns:

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

closed

Getter for series close settings.

Returns:

boolean - Series close settings.
Setter for series close settings.

Params:

NameTypeDefaultDescription
enabledboolean
true
Value to set.

Returns:

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

color

Getter for the series color.

Returns:

string - Series color.
Setter for the series color.

Params:

NameTypeDescription
colorstringColor as a string.

Returns:

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

colorScale

Getter for the color scale.
See listing
var series = chart.line();
var colorScale = series.colorScale();
Setter for the color scale.

Params:

NameTypeDescription
settingsanychart.scales.LinearColor | anychart.scales.OrdinalColor | Object | anychart.enums.ScaleTypes | stringScale to set.

Returns:

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

connectMissingPoints

Getter for connectMissingPoints series settings.

Returns:

boolean - Boolean flag.
Setter for connectMissingPoints series settings.

Params:

NameTypeDefaultDescription
enabledboolean
false
If set to true, the series will not be interrupted on missing points.
Defaults to false. Markers will not be drawn for missing points in both cases.

Returns:

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

data

Getter for series mapping.

Returns:

anychart.data.View - Returns series mapping.
Setter for series mapping.

Params:

NameTypeDescription
dataanychart.data.View | anychart.data.Set | Array | stringData to set.
csvSettingsanychart.enums.TextParsingMode | string | anychart.data.TextParsingSettingsIf CSV string is passed by first param, you can pass CSV parser settings here as a hash map.

Returns:

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

enabled

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.
Setter for the element enabled state.

Params:

NameTypeDefaultDescription
enabledboolean
true
Enabled state to set.

Returns:

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

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:

NameTypeDescription
indexnumberPoint index.

Returns:

anychart.core.SeriesPoint - Wrapped point.

getStat

Gets the statistics value by key.

Params:

NameTypeDescription
keyanychart.enums.Statistics | stringKey.

Returns:

* - Statistics value.

height

Getter for element height settings.

Returns:

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

Params:

NameTypeDefaultDescription
heightnumber | string | null
null
Height settings for the element.

Returns:

anychart.core.polar.series.Polyline - Returns self for method chaining.

hover

Hovers points.

Returns:

anychart.core.polar.series.Polyline - Self instance for method chaining.
Hovers point by index.

Params:

NameTypeDescription
indexnumberPoint index.

Returns:

anychart.core.polar.series.Polyline - Self instance for method chaining.
Hovers points by indexes.

Params:

NameTypeDescription
indexesArray.<number>Array of indexes.

Returns:

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

hovered

Getter for hovered state settings.

Returns:

anychart.core.StateSettings - Hovered state settings
Setter for hovered state settings.

Params:

NameTypeDescription
settingsObjectState settings to set.

Returns:

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

id

Getter for the series id.

Returns:

string | number - Series id.
Setter for the series id.

Params:

NameTypeDescription
idstring | numberId of the series. Default id is equal to internal index.

Returns:

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

labels

Getter for the series data labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.
Setter for the series data labels.

Params:

NameTypeDescription
settingsObject | boolean | nullSeries data labels settings.

Returns:

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

left

Getter for element left bound settings.

Returns:

number | string | undefined - Element's left bound setting.
Setter for element left bound settings.

Params:

NameTypeDefaultDescription
leftnumber | string | null
null
Left bound setting for the element.

Returns:

anychart.core.polar.series.Polyline - Returns self for method chaining.

legendItem

Getter for legend item settings for series.

Returns:

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

Params:

NameTypeDescription
settingsObjectLegend item settings object.

Returns:

anychart.core.polar.series.Polyline - Legend item settings or self for chaining.

markers

Getter for series data markers.

Returns:

anychart.core.ui.MarkersFactory - Markers instance.
Setter for series data markers.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null | string
false
Series data markers settings.

Returns:

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

maxHeight

Getter for the maximum height.

Returns:

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

Params:

NameTypeDefaultDescription
heightnumber | string | null
null
Maximum height to set.

Returns:

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

maxLabels

Getter for maximum labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.
Setter for maximum labels.

Params:

NameTypeDescription
settingsObject | boolean | nullMaximum labels settings.

Returns:

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

maxWidth

Getter for the maximum width.

Returns:

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

Params:

NameTypeDefaultDescription
widthnumber | string | null
null
Maximum width to set.

Returns:

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

meta

Getter for series meta data.

Params:

NameTypeDescription
key*Metadata key.

Returns:

* - Metadata object, key value or itself for method chaining.
Setter for series meta data using object.

Params:

NameTypeDescription
object*Object to replace metadata.
value*Meta data value.

Returns:

anychart.core.polar.series.Polyline - Self instance for method chaining.
Setter for series meta data using key.

Params:

NameTypeDescription
key*Metadata key.
value*Meta data value.

Returns:

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

minHeight

Getter for the minimum height.

Returns:

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

Params:

NameTypeDefaultDescription
heightnumber | string | null
null
Minimum height to set.

Returns:

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

minLabels

Getter for minimum labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.
Setter for minimum labels.

Params:

NameTypeDescription
settingsObject | boolean | nullMinimum labels settings.

Returns:

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

minWidth

Getter for the minimum width.

Returns:

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

Params:

NameTypeDefaultDescription
widthnumber | string | null
null
Minimum width to set.

Returns:

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

name

Getter for the series name.

Returns:

string | undefined - Series name value.
Setter for the series name.

Params:

NameTypeDescription
namestringSeries name to set.

Returns:

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

normal

Getter for normal state settings.

Returns:

anychart.core.StateSettings - Normal state settings.
Setter for normal state settings.

Params:

NameTypeDescription
settingsObjectState settings to set.

Returns:

anychart.core.polar.series.Polyline - Self instance for method chaining.
Getter for element right bound settings.

Returns:

number | string | undefined - Element's right bound setting.
Setter for element right bound setting.

Params:

NameTypeDefaultDescription
rightnumber | string | null
null
Right bound setting for the element.

Returns:

anychart.core.polar.series.Polyline - Returns self for method chaining.

select

Selects point by index.

Params:

NameTypeDescription
indexnumberIndex of the point to select.

Returns:

anychart.core.polar.series.Polyline - Self instance for method chaining.
Selects point by indexes.

Params:

NameTypeDescription
indexesnumber | Array.<number>Array of indexes of the point to select.

Returns:

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

selected

Getter for selected state settings.

Returns:

anychart.core.StateSettings - Selected state settings
Setter for selected state settings.

Params:

NameTypeDescription
settingsObjectState settings to set.

Returns:

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

selectionMode

Gets the state of the series for selection mode.

Returns:

anychart.enums.SelectionMode | string | null - Selection mode.
Allows to select points of the series. To select multiple points, press 'ctrl' and click on them.

Params:

NameTypeDefaultDescription
valueanychart.enums.SelectionMode | string | null
'multiSelect'
Selection mode.

Returns:

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

stroke

Getter for stroke settings.

Returns:

anychart.graphics.vector.Stroke - Stroke settings.
See listing
var stroke = series.stroke();
Setter for series stroke by function.

Params:

NameTypeDefaultDescription
strokeFunctionfunction():anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFill
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.polar.series.Polyline - Self instance for method chaining.
Setter for stroke settings. Learn more about stroke settings.

Params:

NameTypeDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | nullStroke settings.
thicknessnumberLine thickness.
dashpatternstringControls the pattern of dashes and gaps used to stroke paths.
lineJoinstring | anychart.graphics.vector.StrokeLineJoinLine join style.
lineCapstring | anychart.graphics.vector.StrokeLineCapLine cap style.

Returns:

anychart.core.polar.series.Polyline - Self instance for method chaining.
Setter for stroke using an object.

Params:

NameTypeDescription
settingsObjectStroke settings from anychart.graphics.vector.Stroke.

Returns:

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

tooltip

Getter for the series data tooltip.

Returns:

anychart.core.ui.Tooltip - Tooltip instance.
Setter for the series data tooltip.

Params:

NameTypeDescription
settingsObject | boolean | nullTooltip settings.

Returns:

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

top

Getter for element top bound settings.

Returns:

number | string | undefined - Element's top bound setting.
Setter for element top bound settings.

Params:

NameTypeDefaultDescription
topnumber | string | null
null
Top bound setting for the element.

Returns:

anychart.core.polar.series.Polyline - Returns self for method chaining.

transformXY

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

Params:

NameTypeDescription
xValue*Value by x.
yValue*Value by y.

Returns:

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

unhover

Removes hover from the series point or series.

Returns:

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

unselect

Deselects all selected points.

Returns:

anychart.core.polar.series.Polyline - Self instance for method chaining.
Deselects selected point by index.

Params:

NameTypeDescription
indexnumberIndex of the point to select.

Returns:

anychart.core.polar.series.Polyline - Self instance for method chaining.
Deselects selected points by indexes.

Params:

NameTypeDescription
indexesArray.<number>An array of indexes of the point to select.

Returns:

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

width

Getter for element width settings.

Returns:

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

Params:

NameTypeDefaultDescription
widthnumber | string | null
null
Width settings for the element.

Returns:

anychart.core.polar.series.Polyline - Returns self for method chaining.

xScale

Getter for the series X scale.

Returns:

anychart.scales.Linear - Series X Scale.
Setter for the series X scale.

Params:

NameTypeDefaultDescription
settingsanychart.scales.Base | Object | anychart.enums.ScaleTypes | string
anychart.scales.Linear
Scale settings to set.

Returns:

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

yScale

Getter for the series Y scale.

Returns:

anychart.scales.Base - Series Y Scale settings.
Setter for the series Y scale.

Params:

NameTypeDefaultDescription
settingsanychart.scales.Base | Object | anychart.enums.ScaleTypes | string
anychart.scales.Linear
Scale settings to set.

Returns:

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

zIndex

Getter for the Z-index of the element.

Returns:

number - Z-index.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
zIndexnumber
0
Value to set.

Returns:

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