class anychart.core.annotations.Base Improve this Doc

Extends: anychart.core.VisualBaseWithBounds

Base annotations class.

Methods Overview

Specific settings
getPlot()	Returns the plot on which the annotation is drawn.
getType()	Returns annotation type.
hoverMarkers()	Hover markers settings.
markers()	Markers settings.
selectMarkers()	Select markers settings.
Axes and Scales
xScale()	X-scale settings
yScale()	Y-scale settings
Charts
getChart()	Returns the chart on which the annotation is drawn.
Coloring
color()	Color settings.
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
allowEdit()	Interactivity settings.
enabled()	Element state (enabled or disabled).
Size and Position
bottom()	Bottom bound setting.
bounds()	Bounds settings.
getPixelBounds()	Returns pixel bounds.
height()	Height setting.
hoverGap()	Hover gap settings.
left()	Left bound setting.
maxHeight()	Maximum height.
maxWidth()	Maximum width.
minHeight()	Minimum height.
minWidth()	Minimum width.
right()	Right bound setting.
top()	Top bound setting.
width()	Width setting.
zIndex()	Z-index of the element.

Methods Description

allowEdit

allowEdit()Since version 7.11.0

Getter for an interactivity in the annotation.

Returns:

boolean - Interactivity settings.

See listing.

var currentAllowEdit = annotation.allowEdit();

allowEdit(value)Since version 7.11.0

Setter for an interactivity in the annotation.

Params:

Name	Type	Description
value	*	Whether to disable the interactivity in the annotation. If set to false, the interactivity is disabled in the annotation.

Returns:

anychart.core.annotations.Base - Self instance for method chaining.

Try it:

Usage sample

bottom

bottom()

Getter for element bottom bound setting.

Returns:

number | string | undefined - Current element's bottom bound setting.

bottom(value)

Sets element bottom bound setting.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Bottom bound setting for the element.

Returns:

anychart.core.annotations.Base - Returns self for method chaining.

Try it:

Usage sample

bounds

bounds()

Getter for the element bounds settings.

Returns:

anychart.core.utils.Bounds - Current bounds of the element.

bounds(value)

Sets bounds of the element using one parameter.

Params:

Name	Type	Description
value	anychart.utils.RectObj \| anychart.math.Rect \| anychart.core.utils.Bounds	Bounds of element.

Returns:

anychart.core.annotations.Base - Self instance for method chaining.

Try it:

Usage sample

bounds(x, y, width, height)

Setter for the element bounds settings.

Params:

Name	Type	Default	Description
x	number \| string	null	X-coordinate.
y	number \| string	null	Y-coordinate.
width	number \| string	null	Width.
height	number \| string	null	Height.

Returns:

anychart.core.annotations.Base - Self instance for method chaining.

Try it:

Usage sample

color

color()Since version 7.11.0

Getter for the annotation color.

Returns:

string - The annotation color.

See listing.

var color = annotation.color();

color(value)Since version 7.11.0

Setter for the annotation color.

Detailed description

Note: color methods sets fill and stroke settings, which means it is not wise to pass image fill here - stroke doesn't accept image fill.
Learn more about coloring.

Params:

Name	Type	Description
value	string	Color as a string.

Returns:

anychart.core.annotations.Base - Self instance for method chaining.

Try it:

Usage sample

enabled

enabled()

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

Returns:

boolean - The current element state.

Try it:

Usage sample

Name	Type	Default	Description
value	boolean	true	Value to set.

getChart

getChart()Since version 7.11.0

Returns the chart on which the annotation is drawn.

Returns:

anychart.core.SeparateChart - Chart.

Try it:

Usage sample

getPixelBounds

getPixelBounds()

Returns pixel bounds of the element due to parent bounds and self bounds settings.

Returns:

anychart.math.Rect - Pixel bounds of the element.

getPlot

getPlot()Since version 7.11.0

Returns the plot on which the annotation is drawn.

Returns:

anychart.core.stock.Plot - Stock plot.

Try it:

Usage sample

getType

getType()Since version 7.11.0

Returns annotation type.

Returns:

anychart.enums.AnnotationTypes | string - Annotation type

Try it:

Usage sample

height

height()

Getter for element height setting.

Returns:

number | string | undefined - Current element's height setting.

height(value)

Sets element height setting.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Height setting for the element.

Returns:

anychart.core.annotations.Base - Returns self for method chaining.

Try it:

Usage sample

hoverGap

hoverGap()Since version 7.11.0

Getter for the hover gap.

Returns:

number - The hover gap value.

See listing.

var currentHoverGap = annotation.hoverGap();

hoverGap(value)Since version 7.11.0

Setter for the hover gap.
The contour size around annotation.

Params:

Name	Type	Description
value	*	Value to set.

Returns:

anychart.core.annotations.Base - Self instance for method chaining.

Try it:

Usage sample

hoverMarkers

hoverMarkers()Since version 7.11.0

Getter for data hover markers.

Returns:

anychart.core.ui.MarkersFactory - Markers instance.

Try it:

Usage sample

hoverMarkers(value)Since version 7.11.0

Setter for data hover markers.

Detailed description

Sets chart markers settings depending on parameter type:

null/boolean - disable or enable annotation hover markers.
object - sets annotation hover markers settings.
string - sets annotation hover markers type.

Params:

Name	Type	Default	Description
value	Object \| boolean \| null \| string	false	Data markers settings.

Returns:

anychart.core.annotations.Base - Self instance for method chaining.

Try it:

left

left()

Getter for element left bound setting.

Returns:

number | string | undefined - Current element's left bound setting.

left(value)

Sets element left bound setting.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Left bound setting for the element.

Returns:

anychart.core.annotations.Base - Returns self for method chaining.

Try it:

Usage sample

listen

listen(type, listener, useCapture, listenerScope)

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.

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:

Usage sample

listenOnce

listenOnce(type, listener, useCapture, listenerScope)

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).

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:

Usage sample

markers

markers()Since version 7.11.0

Getter for data markers.

Returns:

anychart.core.ui.MarkersFactory - Markers instance.

Try it:

Usage sample

markers(value)Since version 7.11.0

Setter for data markers.

Detailed description

Sets chart markers settings depending on parameter type:

null/boolean - disable or enable annotation markers.
object - sets annotation markers settings.
string - sets annotation markers type.

Params:

Name	Type	Default	Description
value	Object \| boolean \| null \| string	false	Data markers settings.

Returns:

anychart.core.annotations.Base - Self instance for method chaining.

Try it:

maxHeight

maxHeight()

Getter for maximum height.

Returns:

number | string | null - Current element's maximum height.

maxHeight(value)

Setter for maximum height.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Value to set.

Returns:

anychart.core.annotations.Base - Self instance for method chaining.

Try it:

Usage sample

maxWidth

maxWidth()

Getter for maximum width.

Returns:

number | string | null - Current element's maximum width.

maxWidth(value)

Setter for maximum width.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Value to set.

Returns:

anychart.core.annotations.Base - Self instance for method chaining.

Try it:

Usage sample

minHeight

minHeight()

Getter for minimum height.

Returns:

number | string | null - Current element's minimum height.

minHeight(value)

Setter for minimum height.

Detailed description

The method sets a minimum height of elements, that will be to remain after a resize of element.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Value to set.

Returns:

anychart.core.annotations.Base - Self instance for method chaining.

Try it:

Usage sample

minWidth

minWidth()

Getter for minimum width.

Returns:

number | string | null - Current element's minimum width.

minWidth(value)

Setter for minimum width.

Detailed description

The method sets a minimum width of elements, that will be to remain after a resize of element.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Value to set.

Returns:

anychart.core.annotations.Base - Self instance for method chaining.

Try it:

Usage sample

print

print(paperSizeOrOptions, landscape)

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:

Usage sample

removeAllListeners

removeAllListeners(type)

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:

Usage sample

right

right()

Getter for element right bound setting.

Returns:

number | string | undefined - Current element's right bound setting.

right(value)

Sets element right bound setting.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Right bound setting for the element.

Returns:

anychart.core.annotations.Base - Returns self for method chaining.

Try it:

Usage sample

selectMarkers

selectMarkers()Since version 7.11.0

Getter for data select markers.

Returns:

anychart.core.ui.MarkersFactory - Markers instance.

Try it:

Usage sample

selectMarkers(value)Since version 7.11.0

Setter for data select markers.

Detailed description

Sets chart markers settings depending on parameter type:

null/boolean - disable or enable annotation select markers.
object - sets annotation select markers settings.
string - sets annotation select markers type.

Params:

Name	Type	Default	Description
value	Object \| boolean \| null \| string	false	Data markers settings.

Returns:

anychart.core.annotations.Base - Self instance for method chaining.

Try it:

top

top()

Getter for element top bound setting.

Returns:

number | string | undefined - Current element's top bound setting.

top(value)

Sets element top bound setting.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Top bound setting for the element.

Returns:

anychart.core.annotations.Base - Returns self for method chaining.

Try it:

Usage sample

unlisten

unlisten(type, listener, useCapture, listenerScope)

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.