Documentation

Annotator

Type class

A plugin that can be used to annotate charts.

Click here for more info

Sources

Annotator can be used (imported) via one of the following packages.

// Annotator is available in all of the following modules.
// You only need to import one of them.

/**
 * --------------------------------------------------------
 * Import from: "plugins/exporting.ts"
 * Use like: am5plugins_exporting.Annotator
 * --------------------------------------------------------
 */
import * as am5plugins_exporting from "@amcharts/amcharts5/plugins/exporting";


// Annotator is available in all of the following modules.
// You only need to import one of them.

/**
 * --------------------------------------------------------
 * Include via: <script src="plugins/exporting.js"></script>
 * Access items like: am5plugins_exporting.Annotator
 * --------------------------------------------------------
 */

Inheritance

Annotator extends Entity.

Annotator is not extended by any other symbol.

Settings

Set these settings on a Annotator object using its set() and setAll() methods.

Read about settings concept.

id
#

Type undefined | string

Inherited from IEntitySettings

A custom string ID for the element.

If set, element can be looked up via am5.registry.entitiesById.

Will raise error if an element with the same ID already exists.
layer
#

Type undefined | number

Default 1000

Layer number to use for annotations.
markerState
#

Type any

Raw annotation info saved by MarkerJS.
stateAnimationDuration
#

Type undefined | number

Inherited from IEntitySettings

Duration of transition from one state to another.
stateAnimationEasing
#

Type $ease.Easing

Inherited from IEntitySettings

Easing of transition from one state to another.
themeTags
#

Type Array

Inherited from IEntitySettings

Tags which can be used by the theme rules.

Click here for more info

themeTagsSelf
#

Type Array

Inherited from IEntitySettings

Tags which can be used by the theme rules.

These tags only apply to this object, not any children.

Click here for more info

themes
#

Type Array

Inherited from IEntitySettings

A list of themes applied to the element.
userData
#

Type any

Inherited from IEntitySettings

A storage for any custom user data that needs to be associated with the element.
There are 7 inherited items currently hidden from this list.

Private settings

Properties

adapters
#

Type Adapters

Default new Adapters(this)

Inherited from Entity
className
#

Static

Type string

Default "Annotator"
classNames
#

Static

Type Array

Default "Annotator", "Entity"
events
#

Type EventDispatcher

Default this._createEvents()

Inherited from Entity
root
#

Type Root

Inherited from Entity

An instance of Root object.

@readonly
@since 5.0.6

states
#

Type States

Default new States(this)

Inherited from Entity
template
#

Type Template | undefined

Inherited from Entity

@todo needs description

uid
#

Type number

Default ++counter

Inherited from Settings

Unique ID.
There are 6 inherited items currently hidden from this list.

Methods

animate(

options: AnimationOptions

)

#

Returns Animation

Inherited from Settings

Animates setting values from current/start values to new ones.

Click here for more info

cancel()

#

Returns Promise

Exits from annotation mode. Any changes made during last session of the annotation editing are cancelled.

clear()

#

Returns void

All annotations are removed.

close()

#

Returns Promise

Exists from annotation mode. All annotations remain visible on the chart.

dispose()

#

Returns void

get(

key: Key,
fallback: F

)

#

Returns NonNullable | F

Inherited from Entity

Returns settings value for the specified key.

If there is no value, fallback is returned instead (if set).

Click here for more info

getMarkerArea()

#

Returns Promise

An instance of MarkerJS's MarkerArea.

Click here for more info

isDisposed()

#

Returns boolean

Inherited from Settings

Returns true if this element is disposed.

isType(

type: string

)

#

Returns this

Inherited from Entity

Checks if element is of certain class (or inherits one).

new(

root: Root,
settings: ITSettings,
template?: Template

)

#

Static

Returns T

Inherited from Entity

Use this method to create an instance of this class.

Click here for more info

on(

key: Key,
callback: ( value: [""], target: this, key: Key) => void

)

#

Returns IDisposer

Inherited from Settings

Sets a callback function to invoke when specific key of settings changes or is set.

Click here for more info

open()

#

Returns Promise

Triggers annotation mode on the chart. This will display UI toolbars and disable all interactions on the chart itself.

remove(

key: Key

)

#

Returns void

Inherited from Entity

Removes a setting value for the specified key.

Click here for more info

removeAll()

#

Returns void

Inherited from Settings

Removes all keys;

Click here for more info

set(

key: Key,
value: Value

)

#

Returns Value

Inherited from Entity

Sets a setting value for the specified key, and returns the same value.

Click here for more info

setAll(

settings: Partial

)

#

Returns void

Inherited from Settings

Sets multiple settings at once.

settings must be an object with key: value pairs.

Click here for more info

setTimeout(

fn: () => void,
delay: number

)

#

Returns IDisposer

Inherited from Entity

Creates and returns a "disposable" timeout.

toggle()

#

Returns Promise
There are 11 inherited items currently hidden from this list.

Events

Annotator does not have any events.