Top
You are looking at an outdated 7.12.0 version of this document. Switch to the 8.0.1 version to see the up to date information.

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

Getter for the current anchor settings of all markers.

Returns:

anychart.enums.Anchor - Current marker anchor settings.

Try it:

Setter for the anchor settings of all markers.

Params:

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

Returns:

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

Try it:

enabled

Getter for the current element state.

Returns:

boolean - The current element state.

Try it:

Setter for the element enabled state.

Params:

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

Returns:

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

Try it:

fill

Getter for the current fill settings of all markers.

Returns:

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

Try it:

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

Try it:

Params:

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

Returns:

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

Try it:

listen

Adds an event listener to an implementing object.

Params:

Name Type 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 Whether to fire in capture phase (defaults to false).
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 Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope Object Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

offsetX

Getter for the current offsetX settings of all markers.

Returns:

number string - Marker offsetX settings.

Try it:

Setter for the offsetX settings of all markers.

Params:

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

Returns:

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

Try it:

offsetY

Getter for the current offsetY settings of all markers.

Returns:

number string - Markers offsetY settings.

Try it:

Setter for the offsetY settings of all markers.

Params:

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

Returns:

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

Try it:

position

Getter for the current position settings of all markers.

Returns:

string - Markers position settings.

Try it:

Setter for the position settings of all markers.

Params:

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

Returns:

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

Try it:

positionFormatter

Getter for the current position formatter function of all markers.

Returns:

function - Marker position formatter function.
Setter for the position formatter function of all markers.

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

Try it:

print

Prints all elements on related stage.

Params:

Name Type Default Description
paperSize anychart.graphics.vector.PaperSize
Paper size.
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:

rotation

Getter for the current rotation angle around an anchor.

Returns:

number - Current rotation angle in degrees.

Try it:

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

Try it:

size

Getter for the current size settings of all markers.

Returns:

number - Markers size settings.

Try it:

Setter for the size settings of all markers.

Params:

Name Type Default Description
value number
10
Value to set.

Returns:

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

Try it:

stroke

Getter for the current stroke settings of all markers.

Returns:

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

Try it:

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

Try it:

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

Params:

Name Type Default Description
value 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.core.ui.MarkersFactory - Self instance for method chaining.

Try it:

type

Getter for the current type settings of all markers.

Returns:

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

Try it:

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

unlisten

Removes a listener added using listen() or listenOnce() methods.

Params:

Name Type Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
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:

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: