BaseObject

Type class

Provides base functionality for all derivative objects, like generating ids, handling cache, etc.

Sources

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

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

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

// BaseObject 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.BaseObject
 * --------------------------------------------------------
 */

Inheritance

BaseObject does not extend any other symbol.

BaseObject is extended by BaseObjectEvents, Inertia, Filter, SpriteState, InterfaceColorSet, Pattern, LinearGradient, RadialGradient, TextFormatter, NumberFormatter, DateFormatter, DurationFormatter, ColorSet, PatternSet, Morpher.

Properties

clonedFrom
#

Type $type.Optional < this >

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

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.

id
#

Type $type.Optional < string >

Sets the user-defined id of the element.

uid
#

Type string

Returns object's internal unique ID.

Methods

constructor()

#

Returns BaseObject

Constructor

  • Sets class name

clone(

cloneId?: string

)

#

Returns this

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(

object: this

)

#

Returns void

Copies all properties and related data from different element.

dispose()

#

Returns void

Destroys this object and all related data.

getCurrentThemes()

#

Returns ITheme[]

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

Returns if this object has been already been disposed.

Events

BaseObject does not have any events.

Adapters

BaseObject does not have any adapters.