AnyChart
API Reference
Still have questions?
Contact support
Top
You are looking at an outdated 7.9.0 version of this document. Switch to the 8.4.0 version to see the up to date information.

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 settings for custom marker.
offsetX()Offset by X for custom marker.
offsetY()Offset by Y for custom marker.
position()Position settings 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 current anchor settings of custom marker.

Returns:

anychart.enums.Anchor | string - Current anchor settings.
Setter for the anchor settings of custom marker.

Params:

NameTypeDefaultDescription
valueanychart.enums.Anchor | string
'center'
Marker anchor settings.

Returns:

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

enabled

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

Returns:

boolean - The current element state.
Setter for the element enabled state.

Params:

NameTypeDefaultDescription
valueboolean
true
Value to set.

Returns:

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

fill

Getter for the current fill settings of custom marker.

Returns:

anychart.graphics.vector.Fill | string - Marker fill settings.
Setter for the fill settings of custom marker. Learn more about coloring.

Params:

NameTypeDefaultDescription
valueanychart.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:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

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

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

listen

Adds an event listener to an implementing object.

Params:

NameTypeDescription
typestringThe event type id.
listenerfunctionCallback method.
useCapturebooleanWhether to fire in capture phase (defaults to false).
listenerScopescopeObject in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDescription
typestringThe event type id.
listenerfunctionCallback method.
useCapturebooleanWhether to fire in capture phase (defaults to false).
listenerScopescopeObject in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

offsetX

Getter for the current offsetX settings of custom marker.

Returns:

number | string - Current offsetX settings.
Setter for the offsetX settings of custom marker.

Params:

NameTypeDescription
valuenumber | stringMarker offsetX settings.

Returns:

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

offsetY

Getter for the current offsetY settings of custom marker.

Returns:

number | string - Current offsetY settings.
Setter for the offsetY settings of custom marker.

Params:

NameTypeDescription
valuenumber | stringMarker offsetY settings.

Returns:

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

position

Getter for the current position settings of custom marker.

Returns:

anychart.enums.Position | string - Current markers position settings.
Setter for the position settings of custom marker.

Params:

NameTypeDefaultDescription
valueanychart.enums.Position | string
'center'
Markers position settings.

Returns:

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

positionFormatter

Getter for the current position formatter of custom marker.

Returns:

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

Params:

NameTypeDescription
value*Position formatter.

Returns:

* - Self instance for method chaining.

print

Prints all elements on related stage.

Params:

NameTypeDefaultDescription
paperSizeanychart.graphics.vector.PaperSize
Paper size.
landscapeboolean
false
Flag of landscape.

removeAllListeners

Removes all listeners from an object. You can also optionally remove listeners of some particular type.

Params:

NameTypeDescription
typestringType of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

rotation

Getter for the current rotate a marker around an anchor.

Returns:

number - Current rotation angle in degrees.
Setter for the rotate a marker around an anchor.

Params:

NameTypeDescription
valuenumberRotation angle in degrees.

Returns:

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

size

Getter for the current size settings of custom marker.

Returns:

number - Current size settings.
Setter for the size settings of custom marker.

Params:

NameTypeDescription
valuenumberMarker size settings.

Returns:

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

stroke

Getter for the current stroke settings of custom marker.

Returns:

anychart.graphics.vector.Stroke | string - Current stroke settings.
Setter for the stroke settings of custom marker using a string. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Stroke | string
'none'
Value to set.

Returns:

anychart.core.ui.MarkersFactory.Marker - Self instance for method chaining.
Setter for the stroke settings of custom marker. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
valueanychart.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.
lineJoinanychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapanychart.graphics.vector.StrokeLineCap
Style of line cap.

Returns:

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

type

Getter for the current type settings of custom marker.

Returns:

anychart.enums.MarkerType | function - Current type settings.
Setter for the type settings of custom marker.

Params:

NameTypeDescription
valueanychart.enums.MarkerType | functionMarker type settings.

Returns:

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

unlisten

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

Params:

NameTypeDescription
typestringThe event type id.
listenerfunctionCallback method.
useCapturebooleanWhether to fire in capture phase (defaults to false).
listenerScopescopeObject in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

unlistenByKey

Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().

Params:

NameTypeDescription
keyObjectThe key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

zIndex

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
valuenumber
0
Value to set.

Returns:

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