Top
You are looking at an outdated 7.12.0 version of this document. Switch to the 7.14.3 version to see the up to date information.

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.

Try it:

getSelectedAnnotation

Returns currently selected annotation.

Returns:

anychart.core.annotations.Base - Annotation instance.

Try it:

listen

Adds an event listener to an implementing object.

Params:

Name Type 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 Whether to fire in capture phase (defaults to false).
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.

Params:

Name Type Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope Object Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

removeAllAnnotations

Removes all annotations from the chart.

Returns:

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

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:

removeAnnotation

Removes one of annotations from plot by its instance.

Params:

Name Type Description
annotation anychart.core.annotations.Base Annotation instance to set.

Returns:

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

Try it:

select

Selects annotation.

Params:

Name Type Description
annotation anychart.core.annotations.Base Annotation instance to set.

Returns:

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

Try it:

startDrawing

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

Params:

Name Type Description
annotationTypeOrConfig anychart.enums.AnnotationTypes | anychart.core.annotations.AnnotationJSONFormat Type or annotation object.

Returns:

anychart.core.annotations.Base - Annotation instance

Try it:

unlisten

Removes a listener added using listen() or listenOnce() methods.

Params:

Name Type Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
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:

unselect

Unselects annotations.

Returns:

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

Try it: