class anychart.core.ui.MarkersFactory Improve this Doc

Extends: anychart.core.VisualBase

Multiple markers class.
Multiple markers are the set of markers with a common settings, such as type (predefined or custom), size, fill and position:

Also you can access any marker from the set and change it.

Methods Overview

Specific settings
type()	Type settings.
Coloring
fill()	Fill settings.
stroke()	Stroke settings.
Interactivity
enabled()	Element state (enabled or disabled).
Size and Position
anchor()	Anchor settings.
offsetX()	Offset by X.
offsetY()	Offset by Y.
position()	Position settings.
positionFormatter()	Position formatter function.
rotation()	Rotation settings.
size()	Markers size
zIndex()	Markers Z-index.

Methods Description

anchor

anchor()

Getter for anchor settings of all markers.

Returns:

anychart.enums.Anchor | string - Marker anchor settings.

Try it:

Usage sample

anchor(anchor)

Setter for anchor settings of all markers.

Params:

Name	Type	Default	Description
anchor	anychart.enums.Anchor \| string	'center'	Value to set.

Returns:

anychart.core.ui.MarkersFactory - Self instance for method chaining.

Try it:

Usage sample

enabled

enabled()

Getter for the element state.

Detailed description

True, false and null states. True and false are self-explanatory. Null state means that element is enabled, but if it depends on other entities (like, for example, markers() and hoverMarkers() in series), then factory works in auto mode. For example, if series normal markers are enabled, and hover markers are in null state, then upon hover hoverMarkers become enabled because of normal. But if you disable normal markers - hoverMarkers are disabled too.

Returns:

boolean - Element state.

Try it:

Usage sample

enabled(enabled)

Setter for the element enabled state.

Params:

Name	Type	Default	Description
enabled	null \| boolean	null	Enabled state to set.

Returns:

anychart.core.ui.MarkersFactory - Self instance for method chaining.

Try it:

Usage sample

fill

fill()

Getter for fill settings of all markers.

Returns:

anychart.graphics.vector.Fill | string - Markers fill settings.

Try it:

Usage sample

fill(color)

Setter for fill settings of all markers using an array, an object and a string. Learn more about coloring.

Params:

Name	Type	Default	Description
color	anychart.graphics.vector.Fill \| Array.<(anychart.graphics.vector.GradientKey\|string)>	{color: "#64b5f6", opacity: 1}	Color as an array, an object or a string.

Returns:

anychart.core.ui.MarkersFactory - Self instance for method chaining.

Try it:

fill(color, opacity)

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

Detailed description

Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.

Params:

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

Returns:

anychart.core.ui.MarkersFactory - Self instance for method chaining.

Try it:

Usage sample

fill(keys, angle, mode, opacity)

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.ui.MarkersFactory - Self instance for method chaining.

Try it:

Usage sample

fill(keys, cx, cy, mode, opacity, fx, fy)

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.ui.MarkersFactory - Self instance for method chaining.

Try it:

Usage sample

fill(imageSettings)

Image fill. Learn more about coloring.

Params:

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

Returns:

anychart.core.ui.MarkersFactory - Self instance for method chaining.

Try it:

Usage sample

offsetX

offsetX()

Getter for the offset by X of all markers.

Returns:

number | string - Marker offset by X.

Try it:

Usage sample

offsetX(offset)

Setter for the offset by X of all markers.

Params:

Name	Type	Default	Description
offset	number \| string	0	Offset by X to set.

Returns:

anychart.core.ui.MarkersFactory - Self instance for method chaining.

Try it:

Usage sample

offsetY

offsetY()

Getter for the offset by Y of all markers.

Returns:

number | string - Markers offset by Y.

Try it:

Usage sample

offsetY(offset)

Setter for the offset by Y of all markers.

Params:

Name	Type	Default	Description
offset	number \| string	0	Offset by Y to set.

Returns:

anychart.core.ui.MarkersFactory - Self instance for method chaining.

Try it:

Usage sample

position

position()

Getter for position settings of all markers.

Returns:

string - Markers position settings.

Try it:

Usage sample

position(position)

Setter for position settings of all markers.

Detailed description

This method works for discrete series (bar, column) and has additional 'rangeMode' for range series (rangeArea, rangeColumn).

Params:

Name	Type	Default	Description
position	string	'center'	Position to set.

Returns:

anychart.core.ui.MarkersFactory - Self instance for method chaining.

Try it:

Usage sample

positionFormatter

positionFormatter()

Getter for the position formatter function of all markers.

Returns:

function - Marker position formatter function.

positionFormatter(formatter)

Setter for the position formatter function of all markers.

Detailed description

Note: you can pass anything to positionProvider using anychart.core.ui.MarkersFactory#draw, this extends positioning options.
This method works only for discrete series (bar, column).

Params:

Name	Type	Default	Description
formatter	function(positionProvider:*, index:number):anychart.math.CoordinateObject	function(positionProvider, index) { return {x: 80 * index, y: 0}; }	Function to position marker depending on index and context, it should look like this: function(positionProvider, index) { ... //do something return {x: smth, y: smth}; } Parameters: positionProvider - object with information about current (by index) marker position, this object must contain x and y field (with no offsets taken in account). index - current marker index.

Returns:

anychart.core.ui.MarkersFactory - Self instance for method chaining.

Try it:

Usage sample

rotation

rotation()

Getter for the rotation angle around an anchor.

Returns:

number - Rotation angle in degrees.

Try it:

Usage sample

rotation(rotation)

Setter for the rotation angle around an anchor. (anychart.graphics.vector.Element).

Params:

Name	Type	Default	Description
rotation	number	0	Rotation angle in degrees.

Returns:

anychart.core.ui.MarkersFactory - Self instance for method chaining.

Try it:

Usage sample

size

size()

Getter for the size of all markers.

Returns:

number - Markers size.

Try it:

Usage sample

size(size)

Setter for the size of all markers.

Params:

Name	Type	Default	Description
size	number	10	Size to set.

Returns:

anychart.core.ui.MarkersFactory - Self instance for method chaining.

Try it:

Usage sample

stroke

stroke()

Getter for stroke settings of all markers.

Returns:

anychart.graphics.vector.Stroke | string - Markers stroke settings.

Try it:

Usage sample

stroke(color)

Setter for stroke settings of all markers. Learn more about stroke settings.

Params:

Name	Type	Default	Description
color	anychart.graphics.vector.Stroke \| anychart.graphics.vector.ColoredFill \| string	'none'	Color to set.

Returns:

anychart.core.ui.MarkersFactory - Self instance for method chaining.

Try it:

Usage sample

stroke(color, thickness, dashpattern, lineJoin, lineCap)

Setter for stroke settings of all markers. Learn more about stroke settings.

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		Style of line cap.

Returns:

anychart.core.ui.MarkersFactory - Self instance for method chaining.

Try it:

Usage sample

stroke(settings)

Setter for stroke using an object.

Params:

Name	Type	Description
settings	Object	Stroke settings from anychart.graphics.vector.Stroke.

Returns:

anychart.core.ui.MarkersFactory - Self instance for method chaining.

Try it:

Usage sample

type

type()

Getter for type settings of all markers.

Returns:

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

Try it:

Usage sample

type(type)

Setter for type settings of all markers.

Params:

Name	Type	Default	Description
type	anychart.enums.MarkerType \| string \| function	anychart.enums.MarkerType\|string#DIAGONAL_CROSS	Type or custom drawer. Function for a custom marker must look like this: function(path, x, y, size){ // path - anychart.graphics.vector.Path // x, y - current marker position // size - marker size ... //do something return path;

Name

Type

Default

Description

type

anychart.enums.MarkerType | string | function

anychart.enums.MarkerType|string#DIAGONAL_CROSS

Type or custom drawer. Function for a custom marker must look like this:

function(path, x, y, size){
   // path - anychart.graphics.vector.Path
   // x, y - current marker position
   // size - marker size
   ... //do something
   return path;

Returns:

anychart.core.ui.MarkersFactory - Self instance for method chaining.

Try it: