class anychart.core.map.series.Marker Improve this Doc
Extends: anychart.core.map.series.Base
Marker series.
Methods Overview
Specific settings | |
a11y() | Accessibility settings. |
clip() | Clip settings. |
id() | Series id. |
legendItem() | Legend item settings. |
overlapMode() | Overlap mode for series labels |
selectionMode() | Selection mode. |
transformXY() | Transforms geo coordinates to pixel values. |
type() | Marker type settings. |
Axes and Scales | |
colorScale() | Color scale 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. |
geoIdField() | Geo id field settings. |
getExcludedPoints() | Returns an array of excluded points. |
getStat() | Gets 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. |
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. |
unselect() | Deselects all selected points. |
Point Elements | |
getPoint() | Gets wrapped point by index. |
labels() | Labels 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. |
size() | Marker size settings. |
top() | Top bound settings. |
width() | Width settings. |
zIndex() | Z-index of the element. |
Methods Description
a11y
Returns:
anychart.core.utils.SeriesA11y - Accessibility settings object.var series = chart.line([3, 5, 2, 14, 3]); var a11y = series.a11y();
Sets accessibility setting depending on parameter type:
- boolean - disable or enable accessibility.
- object - sets accessibility setting.
Params:
Name | Type | Description |
---|---|---|
value | boolean | Object | Whether to enable accessibility. |
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.bottom
Returns:
number | string | undefined - Element's bottom bound setting.Params:
Name | Type | Default | Description |
---|---|---|---|
bottom | number | string | null | null | Bottom bound settings for the element. |
Returns:
anychart.core.map.series.Marker - Returns self for method chaining.Try it:
bounds
Returns:
anychart.core.utils.Bounds - Bounds of the element.Params:
Name | Type | Description |
---|---|---|
bounds | anychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.Bounds | Bounds of element. |
Returns:
anychart.core.map.series.Marker - 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.map.series.Marker - Self instance for method chaining.Try it:
clip
Returns:
boolean | anychart.math.Rect - Clip settings.Params:
Name | Type | Default | Description |
---|---|---|---|
settings | boolean | anychart.math.Rect | False, if series is created manually. | Enable/disable series clip. |
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.color
Learn more about coloring.
Params:
Name | Type | Description |
---|---|---|
color | string | Color as a string. |
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.Try it:
colorScale
Returns:
anychart.scales.OrdinalColor | anychart.scales.LinearColor - Default chart color scale value.var map = anychart.map(); var series = map.marker(dataSet); var colorScale = series.colorScale();
Params:
Name | Type | Description |
---|---|---|
colorScale | anychart.scales.LinearColor | anychart.scales.OrdinalColor | Color scale to set. |
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.data
Params:
Name | Type | Description |
---|---|---|
data | anychart.data.View | anychart.data.Set | Array | string | Value to set. |
csvSettings | anychart.enums.TextParsingMode | string | 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.map.series.Marker - Self instance for method chaining.enabled
Returns:
boolean - Element state.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
enabled | boolean | true | Enabled state to set. |
Returns:
anychart.core.map.series.Marker - 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.fill
Params:
Name | Type | Description |
---|---|---|
color | anychart.graphics.vector.Fill | string | Array | Color as an array, an object or a string. |
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.Params:
Name | Type | Default | Description |
---|---|---|---|
fillFunction | function():anychart.graphics.vector.Fill | function() { return this.sourceColor }; | Fill-function, which should look like this:function() { // this: { // index: number - the index of the current point // sourceColor: anychart.graphics.vector.Fill - fill of the current point // } return fillSettings; //anychart.graphics.vector.Fill }; |
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
color | string | Color as a string. |
opacity | number | Color opacity. |
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.Try it:
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.map.series.Marker - Self instance for method chaining.Try it:
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.map.series.Marker - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.Try it:
geoIdField
Params:
Name | Type | Description |
---|---|---|
id | string | Id from geo data. |
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.Try it:
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 | anychart.enums.Statistics | string | Key. |
Returns:
* - Statistics value.Try it:
hatchFill
Returns:
anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | boolean - Hatch fill settings.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
type | anychart.graphics.vector.HatchFill.HatchFillType | string | false | Type of the hatch fill. |
color | string | Color. | |
thickness | number | Thickness. | |
size | number | Pattern size. |
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
hatchFillFunction | function | HatchFill function. |
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
patternFill | anychart.graphics.vector.PatternFill | Pattern fill to set. |
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
settings | anychart.graphics.vector.HatchFill | Hatch fill instance. |
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
enabled | boolean | false | Whether to enable hatch fill or no. |
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.Try it:
height
Returns:
number | string | undefined - Element's height setting.Params:
Name | Type | Default | Description |
---|---|---|---|
height | number | string | null | null | Height settings for the element. |
Returns:
anychart.core.map.series.Marker - Returns self for method chaining.Try it:
hover
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
index | number | Point index. |
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
indexes | Array.<number> | Array of indexes. |
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.Try it:
hovered
Returns:
anychart.core.StateSettings - Hovered state settingsTry it:
Params:
Name | Type | Description |
---|---|---|
settings | Object | State settings to set. |
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.Try it:
id
Params:
Name | Type | Description |
---|---|---|
id | string | number | Id of the series. Default id is equal to internal index. |
Returns:
anychart.core.map.series.Marker - 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 |
---|---|---|---|
settings | Object | boolean | null | true | Series data labels settings. |
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.left
Returns:
number | string | undefined - Element's left bound setting.Params:
Name | Type | Default | Description |
---|---|---|---|
left | number | string | null | null | Left bound setting for the element. |
Returns:
anychart.core.map.series.Marker - Returns self for method chaining.Try it:
legendItem
Returns:
anychart.core.utils.LegendItemSettings - Legend item settings.Try it:
Params:
Name | Type | Description |
---|---|---|
settings | Object | Legend item settings to set. |
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.Try it:
maxHeight
Returns:
number | string | null - Element's maximum height.Params:
Name | Type | Default | Description |
---|---|---|---|
height | number | string | null | null | Maximum height to set. |
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.Try it:
maxWidth
Returns:
number | string | null - Element's maximum width.Params:
Name | Type | Default | Description |
---|---|---|---|
width | number | string | null | null | Maximum width to set. |
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.Try it:
meta
Params:
Name | Type | Description |
---|---|---|
key | * | Metadata key. |
Returns:
* - Metadata object, key value or itself for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
object | * | Object to replace metadata. |
value | * | Meta data value. |
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
key | * | Metadata key. |
value | * | Meta data value. |
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.Try it:
minHeight
Returns:
number | string | null - Element's minimum height.Params:
Name | Type | Default | Description |
---|---|---|---|
height | number | string | null | null | Minimum height to set. |
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.Try it:
minWidth
Returns:
number | string | null - Element's minimum width.Params:
Name | Type | Default | Description |
---|---|---|---|
width | number | string | null | null | Minimum width to set. |
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.Try it:
name
Returns:
string | undefined - Series name value.Try it:
Params:
Name | Type | Description |
---|---|---|
name | string | Series name to set. |
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.Try it:
normal
Returns:
anychart.core.StateSettings - Normal state settings.Try it:
Params:
Name | Type | Description |
---|---|---|
settings | Object | State settings to set. |
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.Try it:
overlapMode
Returns:
anychart.enums.LabelsOverlapMode | string - Overlap mode flag.Try it:
Params:
Name | Type | Description |
---|---|---|
mode | anychart.enums.LabelsOverlapMode | string | boolean | Overlap mode to set. |
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.Try it:
right
Returns:
number | string | undefined - Element's right bound setting.Params:
Name | Type | Default | Description |
---|---|---|---|
right | number | string | null | null | Right bound setting for the element. |
Returns:
anychart.core.map.series.Marker - Returns self for method chaining.Try it:
select
Params:
Name | Type | Description |
---|---|---|
index | number | Index of the point to select. |
Returns:
anychart.core.map.series.Marker - 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.map.series.Marker - Self instance for method chaining.Try it:
selected
Returns:
anychart.core.StateSettings - Selected state settingsTry it:
Params:
Name | Type | Description |
---|---|---|
settings | Object | State settings to set. |
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.Try it:
selectionMode
Returns:
anychart.enums.SelectionMode | string | null - Selection mode.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | anychart.enums.SelectionMode | string | null | 'multiSelect' | Selection mode. |
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.Try it:
size
Params:
Name | Type | Default | Description |
---|---|---|---|
size | number | 4 | Marker size to set. |
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.Try it:
stroke
Params:
Name | Type | Default | Description |
---|---|---|---|
strokeFunction | function():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.map.series.Marker - Self instance for method chaining.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
color | anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null | Stroke settings. | |
thickness | number | 1 | Line thickness. |
dashpattern | string | Controls the pattern of dashes and gaps used to stroke paths. | |
lineJoin | string | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
lineCap | string | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
settings | Object | Stroke settings from anychart.graphics.vector.Stroke. |
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.Try it:
tooltip
- null/boolean - disable or enable tooltip.
- object - sets tooltip settings.
Params:
Name | Type | Default | Description |
---|---|---|---|
settings | Object | boolean | null | true | Tooltip settings to set. |
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.top
Returns:
number | string | undefined - Element's top bound setting.Params:
Name | Type | Default | Description |
---|---|---|---|
top | number | string | null | null | Top bound setting for the element. |
Returns:
anychart.core.map.series.Marker - Returns self for method chaining.Try it:
transformXY
Params:
Name | Type | Description |
---|---|---|
xCoord | number | X coordinate. |
yCoord | number | Y coordinate. |
Returns:
Object.<string, number> - Object with pixel values.Try it:
type
Returns:
anychart.enums.MarkerType | string | function - Marker type.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
type | anychart.enums.MarkerType | string | function | 'circle' | Marker 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.map.series.Marker - Self instance for method chaining.Try it:
unhover
Params:
Name | Type | Description |
---|---|---|
indexOrIndexes | number | Array.<number> | Point index or array of indexes. |
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.Try it:
unselect
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
index | number | Index of the point to select. |
Returns:
anychart.core.map.series.Marker - 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.map.series.Marker - Self instance for method chaining.Try it:
width
Returns:
number | string | undefined - Element's width setting.Params:
Name | Type | Default | Description |
---|---|---|---|
width | number | string | null | null | Width settings for the element. |
Returns:
anychart.core.map.series.Marker - Returns self for method chaining.Try it:
zIndex
Params:
Name | Type | Default | Description |
---|---|---|---|
zIndex | number | 0 | Value to set. |
Returns:
anychart.core.map.series.Marker - Self instance for method chaining.Try it: