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.Try it:
Setter for the anchor settings of custom marker.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | anychart.enums.Anchor | string | 'center' | Marker anchor settings. |
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.ui.MarkersFactory.Marker - Self instance for method chaining. Example.
if (!element.enabled()) element.enabled(true);
Try it:
fill
Getter for the current 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.Try it:
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.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:
Image fill.
Learn more about coloring.
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.
Detailed description
The listener can be added to an object once, and if it is added one more time, its key will be returned.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.
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.
Detailed description
After the event is called, its handler will be deleted.
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).
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 current offsetX settings of custom marker.
Returns:
number | string - Current offsetX settings.Try it:
Setter for the offsetX settings 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 current offsetY settings of custom marker.
Returns:
number | string - Current offsetY settings.Try it:
Setter for the offsetY settings of custom marker.
Params:
| Name | Type | Description |
|---|---|---|
| value | number | string | Marker offsetY settings. |
Returns:
anychart.core.ui.MarkersFactory.Marker - Self instance for method chaining.Try it:
position
Getter for the current position settings of custom marker.
Returns:
anychart.enums.Position | string - Current markers position settings.Try it:
Setter for the position settings of custom marker.
Detailed description
This method works only for discrete series (bar, column).
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | anychart.enums.Position | string | 'center' | Markers position settings. |
Returns:
anychart.core.ui.MarkersFactory.Marker - Self instance for method chaining.Try it:
positionFormatter
Getter for the current position formatter of custom marker.
Returns:
* - Current 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:
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 current rotate a marker around an anchor.
Returns:
number - Current 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 |
|---|---|---|
| value | number | Rotation angle in degrees. |
Returns:
anychart.core.ui.MarkersFactory.Marker - Self instance for method chaining.Try it:
size
Getter for the current size settings of custom marker.
Returns:
number - Current size settings.Try it:
Setter for the size settings 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 current stroke settings of custom marker.
Returns:
anychart.graphics.vector.Stroke | string - Current 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 current type settings of custom marker.
Returns:
anychart.enums.MarkerType | function - Current type settings.Try it:
Setter for the type settings 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.
Detailed description
The bigger the index - the higher the element position is.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | 0 | Value to set. |
Returns:
anychart.core.ui.MarkersFactory.Marker - Self instance for method chaining.Try it: