Plugin

Type class

This is a base class that provides core functionality for plugins.

The easiest way to start off with a new plugin is to extend this class.

It will provide all the mandatory functionality, such as disposers.

@since 4.2.2

Sources

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

/**
 * --------------------------------------------------------
 * Import from: "core.ts"
 * Use like: am4core.Plugin
 * --------------------------------------------------------
 */
import * as am4core from "@amcharts/amcharts4/core";

/**
 * --------------------------------------------------------
 * Include via: <script src="core.js"></script>
 * Access items like: am4.Plugin
 * --------------------------------------------------------
 */

Inheritance

Plugin does not extend any other symbol.

Plugin is extended by Annotation, OverlapBuster, Regression, SliceGrouper.

Properties

target #	Type Optional < Sprite > A target object plugin is for.

Methods

constructor() #	Returns Plugin Constructor
dispose() #	Returns void Disposes this object and related stuff.
init() #	Returns void Decorates series with required events and adapters used to hijack its data.
isDisposed() #	Returns boolean Returns if this element is already disposed.

Events

Plugin does not have any events.

Adapters

Plugin does not have any adapters.