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 Inherited from A custom string ID for the element. If set, element can be looked up via Will raise error if an element with the same ID already exists. |
---|---|
layer # |
Type Default Layer number to use for annotations. |
markerState # |
Type Raw annotation info saved by MarkerJS. |
stateAnimationDuration # |
Type Inherited from Duration of transition from one state to another. |
stateAnimationEasing # |
Type Inherited from Easing of transition from one state to another. |
themeTags # |
Type Inherited from Tags which can be used by the theme rules. Click here for more info |
themeTagsSelf # |
Type Inherited from 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 Inherited from A list of themes applied to the element. |
userData # |
Type Inherited from 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 Default Inherited from |
---|---|
className # |
Static
Type Default |
classNames # |
Static
Type Default |
events # |
Type Default Inherited from |
root # |
Type Inherited from An instance of @readonly |
states # |
Type Default Inherited from |
template # |
Type Inherited from @todo needs description |
uid # |
Type Default Inherited from Unique ID. |
There are 6 inherited items currently hidden from this list. |
Methods
animate( options: ) |
Returns Inherited from Animates setting values from current/start values to new ones. Click here for more info |
---|---|
cancel() |
Returns Exits from annotation mode. Any changes made during last session of the annotation editing are cancelled. |
clear() |
Returns All annotations are removed. |
close() |
Returns Exists from annotation mode. All annotations remain visible on the chart. |
dispose() |
Returns |
get( key: ) |
Returns Inherited from Returns settings value for the specified If there is no value, Click here for more info |
getMarkerArea() |
Returns An instance of MarkerJS's Click here for more info |
isDisposed() |
Returns Inherited from Returns |
isType( type: ) |
Returns Inherited from Checks if element is of certain class (or inherits one). |
new( root: ) |
Static Returns Inherited from Use this method to create an instance of this class. Click here for more info |
on( key: ) |
Returns Inherited from Sets a callback function to invoke when specific key of settings changes or is set. Click here for more info |
open() |
Returns Triggers annotation mode on the chart. This will display UI toolbars and disable all interactions on the chart itself. |
remove( key: ) |
Returns Inherited from Removes a setting value for the specified Click here for more info |
removeAll() |
Returns Inherited from Removes all keys; Click here for more info |
set( key: ) |
Returns Inherited from Sets a setting Click here for more info |
setAll( settings: ) |
Returns Inherited from Sets multiple settings at once. Click here for more info |
setTimeout( fn: () => ) |
Returns Inherited from Creates and returns a "disposable" timeout. |
toggle() |
Returns |
There are 11 inherited items currently hidden from this list. |
Events
Annotator does not have any events.