Top

class anychart.core.ui.MarkersFactory.Marker Improve this Doc

Extends: anychart.core.VisualBase

Marker of the markers factory. Use data to set settings for the custom marker.

Methods Overview

Specific settings
type()Type for custom marker.
Coloring
fill()Fill settings for custom marker.
stroke()Stroke settings for custom marker.
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 for custom marker.
offsetX()Offset by X for custom marker.
offsetY()Offset by Y for custom marker.
position()Position for custom marker.
positionFormatter()Position formatter for custom marker.
rotation()Rotation settings for custom marker.
size()Size for custom marker.
zIndex()Z-index of the element.

Methods Description

anchor

Getter for the anchor of custom marker.

Returns:

anychart.enums.Anchor string - Markers anchor.

Try it:

Setter for the anchor of custom marker.

Params:

Name Type Default Description
value anychart.enums.Anchor | string
"center"
Marker anchor.

Returns:

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

Try it:

enabled

Getter for the current element state (enabled or disabled).

Returns:

boolean - The current element state.

Try it:

Setter for the element enabled state.

Params:

Name Type Default Description
value boolean
true
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.
Example.
if (!element.enabled())
   element.enabled(true);

Try it:

fill

Getter for fill settings of custom marker.

Returns:

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

Try it:

Setter for fill settings of custom marker. Learn more about coloring.

Params:

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

Returns:

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

Try it:

Params:

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

Returns:

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

Try it:

listen

Adds an event listener to an implementing object.

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:

listenOnce

Adds an event listener to an implementing object.

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:

offsetX

Getter for the offset by X of custom marker.

Returns:

number string - Offset by X.

Try it:

Setter for the offset by X of custom marker.

Params:

Name Type Description
value number | string Marker offsetX settings.

Returns:

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

Try it:

offsetY

Getter for the offset by Y of custom marker.

Returns:

number string - Offset by Y of custom marker.

Try it:

Setter for the offset by Y of custom marker.

Params:

Name Type Description
value number | string Marker offset by Y.

Returns:

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

Try it:

position

Getter for the position of custom marker.

Returns:

anychart.enums.Position string - Markers position.

Try it:

Setter for the position of custom marker.

Params:

Name Type Default Description
value anychart.enums.Position | string
"center"
Markers position.

Returns:

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

Try it:

positionFormatter

Getter for the position formatter of custom marker.

Returns:

* - Position formatter.
Setter for the position formatter of custom marker.

Params:

Name Type Description
value * Position formatter.

Returns:

* - Self instance for method chaining.

Try it:

print

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:

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 rotate a marker around an anchor.

Returns:

number - Rotation angle in degrees.

Try it:

Setter for the rotate a marker around an anchor.

Params:

Name Type Description
value number Rotation angle in degrees.

Returns:

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

Try it:

size

Getter for the size of custom marker.

Returns:

number - Size of custom marker.

Try it:

Setter for the size of custom marker.

Params:

Name Type Description
value number Marker size settings.

Returns:

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

Try it:

stroke

Getter for the stroke of custom marker.

Returns:

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

Try it:

Setter for the stroke settings of custom marker using a string. 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.Marker - Self instance for method chaining.

Try it:

Setter for the stroke settings of custom marker. 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.core.ui.MarkersFactory.Marker - Self instance for method chaining.

Try it:

type

Getter for the type of custom marker.

Returns:

anychart.enums.MarkerType function - Markers type.

Try it:

Setter for the type of custom marker.

Params:

Name Type Description
value anychart.enums.MarkerType | function Marker type settings.

Returns:

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

Try it:

unlisten

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.

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: