AnyChart
API Reference
Still have questions?
Contact support
Top

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

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

clip

Getter for series clip settings.

Returns:

boolean | anychart.math.Rect - Clip settings.
Setter for series clip settings. Clips visible part of a series by a rectangle (or chart).

Params:

NameTypeDefaultDescription
settingsboolean | anychart.math.Rect
False, if series is created manually.
True, if created via chart
Enable/disable series clip.

Returns:

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

colorScale

Getter for the color scale.

Returns:

anychart.scales.OrdinalColor | anychart.scales.LinearColor - Default chart color scale value.
See listing
var map = anychart.map();
var series = map.marker(dataSet);
var colorScale = series.colorScale();
Setter for the color scale.

Params:

NameTypeDescription
colorScaleanychart.scales.LinearColor | anychart.scales.OrdinalColorColor scale to set.

Returns:

anychart.core.map.series.Marker - 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 | stringValue 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.map.series.Marker - 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.map.series.Marker - Self instance for method chaining.
Example.
if (!element.enabled())
   element.enabled(true);

excludePoint

Excludes points at the specified index.

Params:

NameTypeDescription
indexesnumber | Array.<number>Points indexes.

Returns:

boolean - Returns true if the points were excluded.

fill

Getter for series fill color.

Returns:

anychart.graphics.vector.Fill - Series fill color.
Setter for series fill settings using an array, an object or a string. Learn more about coloring.

Params:

NameTypeDescription
coloranychart.graphics.vector.Fill | string | ArrayColor as an array, an object or a string.

Returns:

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

Params:

NameTypeDefaultDescription
fillFunctionfunction():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.
Series fill color with opacity. Fill as a string or an object.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.map.series.Marker - Self instance for method chaining.
Linear gradient series fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.core.map.series.Marker - Self instance for method chaining.
Radial series fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

anychart.core.map.series.Marker - Self instance for method chaining.
Image series fill. Learn more about coloring.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

geoIdField

Getter for the geo id field.

Returns:

string - Geo id filed.
Setter for the geo id field.

Params:

NameTypeDescription
idstringId from geo data.

Returns:

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

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:

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.

hatchFill

Getter fot the hatch fill.

Returns:

anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | boolean - Hatch fill settings.
Setter for the hatch fill.

Params:

NameTypeDefaultDescription
typeanychart.graphics.vector.HatchFill.HatchFillType | string
false
Type of the hatch fill.
colorstring
Color.
thicknessnumber
Thickness.
sizenumber
Pattern size.

Returns:

anychart.core.map.series.Marker - Self instance for method chaining.
Setter for hatch fill settings using function. Learn more about coloring.

Params:

NameTypeDescription
hatchFillFunctionfunctionHatchFill function.

Returns:

anychart.core.map.series.Marker - Self instance for method chaining.
Setter for hatch fill settings using pattern fill. Learn more about coloring.

Params:

NameTypeDescription
patternFillanychart.graphics.vector.PatternFillPattern fill to set.

Returns:

anychart.core.map.series.Marker - Self instance for method chaining.
Setter for hatch fill settings using an instance. Learn more about coloring.

Params:

NameTypeDescription
settingsanychart.graphics.vector.HatchFillHatch fill instance.

Returns:

anychart.core.map.series.Marker - Self instance for method chaining.
Setter for hatch fill using boolean. Learn more about hatch fill settings.

Params:

NameTypeDefaultDescription
enabledboolean
false
Whether to enable hatch fill or no.

Returns:

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

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.map.series.Marker - Returns self for method chaining.

hover

Hovers points.

Returns:

anychart.core.map.series.Marker - Self instance for method chaining.
Hovers point by index.

Params:

NameTypeDescription
indexnumberPoint index.

Returns:

anychart.core.map.series.Marker - Self instance for method chaining.
Hovers points by indexes.

Params:

NameTypeDescription
indexesArray.<number>Array of indexes.

Returns:

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

includeAllPoints

Includes all excluded points.

Returns:

boolean - Returns true if all points were included.

includePoint

Includes excluded points with the specified indexes.

Params:

NameTypeDescription
indexesnumber | Array.<number>Points indexes.

Returns:

boolean - Returns true if the points were included.

keepOnlyPoints

Keep only the specified points.

Params:

NameTypeDescription
indexesnumber | Array.<number>Point index or indexes.

labels

Getter for series data labels.

Returns:

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

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
true
Series data labels settings.

Returns:

anychart.core.map.series.Marker - 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.map.series.Marker - Returns self for method chaining.

legendItem

Getter for series legend item settings.

Returns:

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

Params:

NameTypeDescription
settingsObjectLegend item settings to set.

Returns:

anychart.core.map.series.Marker - 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.map.series.Marker - 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.map.series.Marker - 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.map.series.Marker - Self instance for method chaining.
Setter for series meta data using key.

Params:

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

Returns:

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

overlapMode

Getter for labels overlap mode.

Returns:

anychart.enums.LabelsOverlapMode | string - Overlap mode flag.
Setter for labels overlap mode.

Params:

NameTypeDescription
modeanychart.enums.LabelsOverlapMode | string | booleanOverlap mode to set.

Returns:

anychart.core.map.series.Marker - 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.map.series.Marker - Returns self for method chaining.

select

Selects point by index.

Params:

NameTypeDescription
indexnumberIndex of the point to select.

Returns:

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

size

Getter for the marker size.

Returns:

number - Marker size.
Setter for the marker size setting.

Params:

NameTypeDefaultDescription
sizenumber
4
Marker size to set.

Returns:

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

stroke

Getter for stroke settings.

Returns:

anychart.graphics.vector.Stroke - Stroke settings.
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.map.series.Marker - Self instance for method chaining.
Setter for series stroke settings. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
Stroke settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.core.map.series.Marker - Self instance for method chaining.
Setter for series stroke using an object.

Params:

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

Returns:

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

tooltip

Getter for tooltip settings.

Returns:

anychart.core.ui.Tooltip - Tooltip instance.
Setter for tooltip settings.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
true
Tooltip settings to set.

Returns:

anychart.core.map.series.Marker - 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.map.series.Marker - Returns self for method chaining.

transformXY

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

Params:

NameTypeDescription
xCoordnumberX coordinate.
yCoordnumberY coordinate.

Returns:

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

type

Getter for the marker type settings.

Returns:

anychart.enums.MarkerType | string | function - Marker type.
Setter for the marker type settings.

Params:

NameTypeDefaultDescription
typeanychart.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.

unhover

Removes hover from the series.

Params:

NameTypeDescription
indexOrIndexesnumber | Array.<number>Point index or array of indexes.

Returns:

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

unselect

Deselects all selected points.

Returns:

anychart.core.map.series.Marker - Self instance for method chaining.
Deselects selected point by index.

Params:

NameTypeDescription
indexnumberIndex of the point to select.

Returns:

anychart.core.map.series.Marker - 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.map.series.Marker - 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.map.series.Marker - Returns self 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.map.series.Marker - Self instance for method chaining.