AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.core.annotations.ChartController Improve this Doc

Extends: anychart.core.Base

Chart controller class.

Methods Overview

Specific settings
cancelDrawing()Cancels current annotation drawing.
getSelectedAnnotation()Returns currently selected annotation.
removeAllAnnotations()Removes all annotations from the chart.
removeAnnotation()Removes one of annotations from plot by its instance.
startDrawing()Starts annotation drawing.
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.
Interactivity
select()Selects annotation.
unselect()Unselects annotations.

Methods Description

cancelDrawing

Cancels current annotation drawing.

getSelectedAnnotation

Returns currently selected annotation.

Returns:

anychart.core.annotations.Base - Annotation instance.

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.

removeAllAnnotations

Removes all annotations from the chart.

Returns:

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

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.

removeAnnotation

Removes one of annotations from plot by its instance.

Params:

NameTypeDescription
annotationanychart.core.annotations.BaseAnnotation instance to set.

Returns:

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

select

Selects annotation.

Params:

NameTypeDescription
annotationanychart.core.annotations.BaseAnnotation instance to set.

Returns:

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

startDrawing

Starts annotation drawing.
Note: Works only after anychart.charts.Stock#draw is called.

Params:

NameTypeDescription
annotationTypeOrConfiganychart.enums.AnnotationTypes | string | anychart.core.annotations.AnnotationJSONFormatType or annotation object.

Returns:

anychart.core.annotations.Base - Annotation instance

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.

unselect

Unselects annotations.

Returns:

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