BaseObjectEvents

Type class

A version of BaseObject with events properties and methods.

Classes that use EventDispatcher should extend this instead of BaseObject directly.

Sources

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

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

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

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

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

Inheritance

BaseObjectEvents extends BaseObject.

BaseObjectEvents is extended by Language, Animation, InteractionObject, Interaction, Popup, DataItem, Responsive, Sprite, DataSource.

Properties

clonedFrom
#

Type $type.Optional < this >

Inherited from BaseObject

Reference to the original object this object was cloned from. We need to keep this so we can disassociate it from source object when this object is disposed.

config
#

Type object

Inherited from BaseObject

Use this property to set JSON-based config. When set, triggers processing routine, which will go through all properties, and try to apply values, create instances, etc.

Use this with caution, as it is a time-consuming process. It's used for initialchart setup only, not routine operations.

events
#

Type EventDispatcher < AMEvent < this, IBaseObjectEvents > >

An EventDispatcher instance

id
#

Type $type.Optional < string >

Inherited from BaseObject

Sets the user-defined id of the element.

uid
#

Type string

Inherited from BaseObject

Returns object's internal unique ID.

There are 4 inherited items currently hidden from this list.

Methods

constructor()

#

Returns BaseObjectEvents

Constructor

clone(

cloneId?: string

)

#

Returns this

Inherited from BaseObject

Makes a copy of this object and returns the clone. Try to avoid cloning complex objects like chart, create new instances if you need them.

copyFrom(

source: this

)

#

Returns void

Copies all parameters from another Sprite.

dispatch(

eventType: Key,
data?: any

)

#

Returns void

Dispatches an event using own event dispatcher. Will automatically populate event data object with event type and target (this element).

It also checks if there are any handlers registered for this sepecific event.

dispatchImmediately(

eventType: Key,
data?: any

)

#

Returns void

Works like dispatch, except event is triggered immediately, without waiting for the next frame cycle.

dispose()

#

Returns void

Inherited from BaseObject

Destroys this object and all related data.

getCurrentThemes()

#

Returns ITheme[]

Inherited from BaseObject

Returns a list of themes that should be applied to this element. It could either be a list of themes set explicitly on this element, or system-wide.

isDisposed()

#

Returns boolean

Inherited from BaseObject

Returns if this object has been already been disposed.

There are 4 inherited items currently hidden from this list.

Events

BaseObjectEvents does not have any events.

Adapters

BaseObjectEvents does not have any adapters.