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. |
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.Try it:
Setter for the anchor of custom marker.
Params:
Name | Type | Default | Description |
---|---|---|---|
anchor | anychart.enums.Anchor | string | 'center' | Marker anchor. |
Returns:
anychart.standalones.MarkersFactory.Marker - Self instance for method chaining.Try it:
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.Try it:
Setter for the element enabled state.
Params:
Name | Type | Default | Description |
---|---|---|---|
enabled | boolean | true | Enabled state to set. |
Returns:
anychart.standalones.MarkersFactory.Marker - 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 using an array, an object and a string.
Learn more about coloring.
Params:
Name | Type | Description |
---|---|---|
color | anychart.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.
Detailed description
Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which
means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.
Params:
Name | Type | Description |
---|---|---|
color | string | Color as a string. |
opacity | number | Color opacity. |
Returns:
anychart.standalones.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.standalones.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.standalones.MarkersFactory.Marker - Self instance for method chaining.Try it:
Image fill.
Learn more about coloring.
Params:
Name | Type | Description |
---|---|---|
imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.standalones.MarkersFactory.Marker - Self instance for method chaining.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 |
---|---|---|
offset | number | string | Marker offsetX settings. |
Returns:
anychart.standalones.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 |
---|---|---|
offset | number | string | Marker offset by Y. |
Returns:
anychart.standalones.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.
Detailed description
This method works only for discrete series (bar, column).
Params:
Name | Type | Default | Description |
---|---|---|---|
position | anychart.enums.Position | string | 'center' | Markers position. |
Returns:
anychart.standalones.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 |
---|---|---|
formatter | * | Position formatter. |
Returns:
* - Self instance for method chaining.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.
Detailed description
(anychart.graphics.vector.Element). Method resets transformation and applies a new one.
Params:
Name | Type | Description |
---|---|---|
angle | number | Rotation angle in degrees. |
Returns:
anychart.standalones.MarkersFactory.Marker - Self instance for method chaining.Try it:
size
Setter for the size of custom marker.
Params:
Name | Type | Description |
---|---|---|
size | number | Marker size settings. |
Returns:
anychart.standalones.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 | Description |
---|---|---|
color | anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | Color to set. |
Returns:
anychart.standalones.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 | string | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
lineCap | string | anychart.graphics.vector.StrokeLineCap | Style of line cap. |
Returns:
anychart.standalones.MarkersFactory.Marker - Self instance for method chaining.Try it:
Setter for stroke using an object.
Params:
Name | Type | Description |
---|---|---|
settings | Object | Stroke 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.Try it:
Setter for the type of custom marker.
Params:
Name | Type | Description |
---|---|---|
type | anychart.enums.MarkerType | string | function | Marker type settings. |
Returns:
anychart.standalones.MarkersFactory.Marker - Self instance for method chaining.Try it:
zIndex
Setter for the Z-index of the element.
Detailed description
The bigger the index - the higher the element position is.
Params:
Name | Type | Default | Description |
---|---|---|---|
zIndex | number | 0 | Value to set. |
Returns:
anychart.standalones.MarkersFactory.Marker - Self instance for method chaining.Try it: