class anychart.standalones.MarkersFactory Improve this Doc

Extends: anychart.core.ui.MarkersFactory

Methods Overview

Specific settings
type()	Type settings.
Coloring
fill()	Fill settings.
stroke()	Stroke 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).
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()	Size setting
zIndex()	Z-index of the element.

Methods Description

anchor

anchor()

Getter for the current anchor settings of all markers.

Returns:

anychart.enums.Anchor - Current marker anchor settings.

Try it:

Usage sample

anchor(value)

Setter for the anchor settings of all markers.

Params:

Name	Type	Default	Description
value	anychart.enums.Anchor \| string	"center"	Value to set.

Returns:

anychart.standalones.MarkersFactory - Self instance for method chaining.

Try it:

Usage sample

enabled

enabled()

Getter for the current 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 - The current element state.

Try it:

Usage sample

enabled(value)

Setter for the element enabled state.

Params:

Name	Type	Default	Description
value	null \| boolean	null	Value to set.

Returns:

anychart.standalones.MarkersFactory - Self instance for method chaining.

Try it:

Usage sample

fill

fill()

Getter for the current fill settings of all markers.

Returns:

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

Try it:

Usage sample

fill(value)

Setter for fill settings of all markers. Learn more about coloring.

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Fill \| string	'black'	Value to set.

Returns:

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

Try it:

Usage sample

listen

listen(type, listener, useCapture, listenerScope)

Adds an event listener to an implementing object.

Detailed description

The listener can be added to an object once, and if it is added one more time, its key will be returned.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.

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:

Usage sample

listenOnce

listenOnce(type, listener, useCapture, listenerScope)

Adds an event listener to an implementing object.

Detailed description

After the event is called, its handler will be deleted.
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).

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:

Usage sample

offsetX

offsetX()

Getter for the current offsetX settings of all markers.

Returns:

number | string - Marker offsetX settings.

Try it:

Usage sample

offsetX(value)

Setter for the offsetX settings of all markers.

Params:

Name	Type	Default	Description
value	number \| string	0	Value to set.

Returns:

anychart.standalones.MarkersFactory - Self instance for method chaining.

Try it:

Usage sample

offsetY

offsetY()

Getter for the current offsetY settings of all markers.

Returns:

number | string - Markers offsetY settings.

Try it:

Usage sample

offsetY(value)

Setter for the offsetY settings of all markers.

Params:

Name	Type	Default	Description
value	number \| string	0	Value to set.

Returns:

anychart.standalones.MarkersFactory - Self instance for method chaining.

Try it:

Usage sample

position

position()

Getter for the current position settings of all markers.

Returns:

string - Markers position settings.

Try it:

Usage sample

position(value)

Setter for the position settings of all markers.

Detailed description

This method works only for discrete series (bar, column).

Params:

Name	Type	Default	Description
value	string	"center"	Value to set.

Returns:

anychart.standalones.MarkersFactory - Self instance for method chaining.

Try it:

Usage sample

positionFormatter

positionFormatter()

Getter for the current position formatter function of all markers.

Returns:

function - Marker position formatter function.

positionFormatter(value)

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
value	function	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.standalones.MarkersFactory - Self instance for method chaining.

Try it:

Usage sample

print

print(paperSizeOrOptions, landscape)

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:

Usage sample

removeAllListeners

removeAllListeners(type)

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:

Usage sample

rotation

rotation()

Getter for the current rotation angle around an anchor.

Returns:

number - Current rotation angle in degrees.

Try it:

Usage sample

rotation(value)

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

Params:

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

Returns:

anychart.standalones.MarkersFactory - Self instance for method chaining.

Try it:

Usage sample

size

size()

Getter for the current size settings of all markers.

Returns:

number - Markers size settings.

Try it:

Usage sample

size(value)

Setter for the size settings of all markers.

Params:

Name	Type	Default	Description
value	number	10	Value to set.

Returns:

anychart.standalones.MarkersFactory - Self instance for method chaining.

Try it:

Usage sample

stroke

stroke()

Getter for the current stroke settings of all markers.

Returns:

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

Try it:

Usage sample

stroke(value)

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

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Stroke \| string	'none'	Value to set.

Returns:

anychart.standalones.MarkersFactory - Self instance for method chaining.

Try it:

Usage sample

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

Setter for the 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	anychart.graphics.vector.StrokeLineJoin		Line join style.
lineCap	anychart.graphics.vector.StrokeLineCap		Style of line cap.

Returns:

anychart.standalones.MarkersFactory - Self instance for method chaining.

Try it:

Usage sample

type

type()

Getter for the current type settings of all markers.

Returns:

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

Try it:

Usage sample

type(value)

Setter for the type settings of all markers.

Params:

Name	Type	Default	Description
value	string \| anychart.enums.MarkerType \| function	anychart.enums.MarkerType#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.standalones.MarkersFactory - Self instance for method chaining.

Try it:

unlisten

unlisten(type, listener, useCapture, listenerScope)

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.