AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.standalones.MarkersFactory.Marker Improve this Doc

Extends: anychart.core.ui.MarkersFactory.Marker

The Marker class contains methods for configuring 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.
Miscellaneous
clear()Resets marker to the initial state, but leaves DOM elements intact, but without the parent.
draw()Marker drawing.

Methods Description

anchor

Getter for the anchor of custom marker.

Returns:

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

Params:

NameTypeDefaultDescription
anchoranychart.enums.Anchor | string
'center'
Marker anchor.

Returns:

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

clear

Resets marker to the initial state, but leaves DOM elements intact, but without the parent.

draw

Marker drawing.

Returns:

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

enabled

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.
Setter for the element enabled state.

Params:

NameTypeDefaultDescription
enabledboolean
true
Enabled state to set.

Returns:

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

fill

Getter for fill settings of custom marker.

Returns:

anychart.graphics.vector.Fill | string - Marker fill settings.
Setter for fill settings of custom marker using an array, an object and a string. Learn more about coloring.

Params:

NameTypeDescription
coloranychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)>Color as an array, an object or a string.

Returns:

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

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
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
}
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

offsetX

Getter for the offset by X of custom marker.

Returns:

number | string - Offset by X.
Setter for the offset by X of custom marker.

Params:

NameTypeDescription
offsetnumber | stringMarker offsetX settings.

Returns:

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

offsetY

Getter for the offset by Y of custom marker.

Returns:

number | string - Offset by Y of custom marker.
Setter for the offset by Y of custom marker.

Params:

NameTypeDescription
offsetnumber | stringMarker offset by Y.

Returns:

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

position

Getter for the position of custom marker.

Returns:

anychart.enums.Position | string - Markers position.
Setter for the position of custom marker.

Params:

NameTypeDefaultDescription
positionanychart.enums.Position | string
'center'
Markers position.

Returns:

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

positionFormatter

Getter for the position formatter of custom marker.

Returns:

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

Params:

NameTypeDescription
formatter*Position formatter.

Returns:

* - Self instance for method chaining.

print

Prints all elements on related stage.

Params:

NameTypeDefaultDescription
paperSizeOrOptionsanychart.graphics.vector.PaperSize | Object
Paper size or object with options.
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 rotate a marker around an anchor.

Returns:

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

Params:

NameTypeDescription
anglenumberRotation angle in degrees.

Returns:

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

size

Getter for the size of custom marker.

Returns:

number - Size of custom marker.
Setter for the size of custom marker.

Params:

NameTypeDescription
sizenumberMarker size settings.

Returns:

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

stroke

Getter for the stroke of custom marker.

Returns:

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

Params:

NameTypeDescription
coloranychart.graphics.vector.Stroke | stringColor to set.

Returns:

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

Params:

NameTypeDefaultDescription
coloranychart.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.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
Style of line cap.

Returns:

anychart.standalones.MarkersFactory.Marker - Self instance for method chaining.
Setter for stroke using an object.

Params:

NameTypeDescription
settingsObjectStroke settings from anychart.graphics.vector.Stroke.

Returns:

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

type

Getter for the type of custom marker.

Returns:

anychart.enums.MarkerType | string | function - Markers type.
Setter for the type of custom marker.

Params:

NameTypeDescription
typeanychart.enums.MarkerType | string | functionMarker type settings.

Returns:

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

unlisten

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

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object):boolean|undefined
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object 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 Z-index of the element.

Returns:

number - Z-index.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
zIndexnumber
0
Value to set.

Returns:

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