AnyChart
API Reference
Still have questions?
Contact support
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.
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
parentBounds()Getter for the parent bounds.

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

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

parentBounds

Getter for the parent bounds.
Bounds that would be used in case of percent size calculations. Expects pixel values only.

Returns:

anychart.math.Rect - The parent bounds of the element.
Setter for the parent bounds using single value.
Bounds that would be used in case of percent size calculations. Expects pixel values only.

Params:

NameTypeDescription
boundsanychart.math.Rect | Object | number | nullBounds to set.

Returns:

anychart.core.ui.MarkersFactory.Marker - Self instance for method chaining.
Setter for the parent bounds using several values.
Bounds that would be used in case of percent size calculations. Expects pixel values only.

Params:

NameTypeDescription
leftnumberLeft space.
topnumberTop space.
widthnumberElement width.
heightnumberElement height.

Returns:

anychart.core.ui.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.core.ui.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.

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.core.ui.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.core.ui.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 | anychart.graphics.vector.ColoredFill | stringColor 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
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.core.ui.MarkersFactory.Marker - Self instance for method chaining.
Setter for stroke using an object.

Params:

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

Returns:

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

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