Top

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

Extends: anychart.core.polar.series.Base

Define Marker series type.
Note: Better for use anychart.charts.Polar#marker method.

Methods Overview

Specific settings
id()Series id.
legendItem()Legend item settings.
selectionMode()Selection mode.
size()Marker size settings.
transformXY()Transforms values to pixel coordinates.
type()Marker type settings.
Coloring
color()Color settings.
fill()Fill settings.
hatchFill()Hatch fill settings.
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()Series 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()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.
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 the series color.

Returns:

string - Series color.

Try it:

Setter for the series color.

Params:

Name Type Description
value string Color as a string.

Returns:

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

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.

fill

Getter for the series fill color.

Returns:

anychart.graphics.vector.Fill - Fill color.
See listing
var fill = series.fill();
Setter for fill settings using an array or a string. Learn more about coloring.

Params:

Name Type Default Description
value anychart.graphics.vector.Fill
null
Color as an object or a string.

Returns:

anychart.core.polar.series.Marker - Self instance for method chaining.
Setter for fill settings using function.

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 fill() getter. // this.iterator - series point iterator. return fillValue; // type anychart.graphics.vector.Fill }.

Returns:

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

Try it:

Fill color with opacity. Fill as a string or an object.

Params:

Name Type Description
color string Color as a string.
opacity number Color opacity.

Returns:

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

Try it:

Linear gradient fill. 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.polar.series.Marker - Self instance for method chaining.

Try it:

Radial gradient fill. 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.polar.series.Marker - Self instance for method chaining.

Try it:

Params:

Name Type Description
imageSettings anychart.graphics.vector.Fill Object with settings.

Returns:

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

Try it:

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

Returns:

* - Statistics value.

Try it:

hatchFill

Getter for hatch fill settings.
See listing
var hatchFill = series.hatchFill();
Setter for hatch fill settings. Learn more about hatch fill settings.

Params:

Name Type Default Description
patternFillOrType anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | string
false
PatternFill or HatchFill instance or type of hatch fill.
color string
Color.
thickness number
Thickness.
size number
Pattern size.

Returns:

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

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.

Returns:

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

Try it:

Hovers point by index.

Params:

Name Type Description
index number Point index.

Returns:

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

Try it:

Hovers points by indexes.

Params:

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

Returns:

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

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.

labels

Getter for the current series data labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Setter for the series data labels.

Params:

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

Returns:

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

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

Gets the current legend item setting for series.

Returns:

anychart.core.utils.LegendItemSettings - Legend item settings.

Try it:

Sets the legend item setting for series.

Params:

Name Type Description
value Object Legend item settings object.

Returns:

anychart.core.SeriesBase - Legend item settings or self for 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 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

Gets series meta data.

Params:

Name Type Description
key * Metadata key.

Returns:

* - Metadata object, key value or itself for method chaining.

Try it:

Sets series meta data using object.

Params:

Name Type Description
object * Object to replace metadata.
value * Meta data value.

Returns:

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

Try it:

Sets series meta data using key.

Params:

Name Type Description
key * Metadata key.
value * Meta data value.

Returns:

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

Try it:

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 the current series name.

Returns:

string undefined - The current series name value.

Try it:

Setter for the series name.

Params:

Name Type Description
value string Value to set.

Returns:

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

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 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:

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 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:

size

Getter for the marker size

Returns:

number - Marker size.

Try it:

Setter for the marker size.

Params:

Name Type Default Description
value number
6
Value to set.

Returns:

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

Try it:

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:

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.polar.series.Marker - Self instance for method chaining.

Try it:

Setter for stroke settings. Learn more about stroke settings.

Params:

Name Type Default Description
strokeOrFill anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null
Fill settings or 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.polar.series.Marker - Self instance for method chaining.

Try it:

tooltip

Gets the current series data tooltip.

Returns:

anychart.core.ui.Tooltip - Tooltip instance.

Try it:

Sets series data tooltip.

Params:

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

Returns:

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

type

Getter for marker type settings.

Returns:

string anychart.enums.MarkerType function - Markers type settings.

Try it:

Setter for marker type settings.

Params:

Name Type Default Description
value string | anychart.enums.MarkerType | function
"circle"
Type or custom drawer. Function for a custom marker should look like this: function(path, x, y, size){ // path - anychart.graphics.vector.Path // x, y - marker position // size - marker size ... //do something return path; }.

Returns:

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

unhover

Removes hover from the series point or series.

Returns:

anychart.core.polar.series.Marker - 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 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 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
"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
"linear"
Value to set.

Returns:

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