Constructors
constructor
- new Engine(): Engine
-
Properties
Private
Readonly
_configs
_configs: any
Private
Readonly
_domArray
_domArray: any
Private
Readonly
_eventDispatcher
_eventDispatcher: any
Private
_initialized
_initialized: any
Private
Readonly
_loader
_loader: any
Readonly
plugins
Accessors
version
- get version(): string
-
Returns string
Methods
addConfig
- addConfig(nameOrConfig, config?): void
-
Returns void
addEventListener
- addEventListener(type, listener): void
-
Returns void
addInteractor
- addInteractor(name, interactorInitializer): Promise<void>
-
Parameters
-
name: string
-
interactorInitializer: ((container) => IInteractor)
Returns Promise<void>
addMover
- addMover(name, moverInitializer): Promise<void>
-
Returns Promise<void>
addParticleUpdater
- addParticleUpdater(name, updaterInitializer): Promise<void>
-
Returns Promise<void>
addPathGenerator
- addPathGenerator(name, generator): Promise<void>
-
Returns Promise<void>
addPlugin
- addPlugin(plugin): Promise<void>
-
Returns Promise<void>
addPreset
- addPreset(preset, options, override?): Promise<void>
-
Parameters
-
preset: string
-
-
Optional
override: boolean
Returns Promise<void>
addShape
- addShape(shape, drawer, init?, afterEffect?, destroy?): Promise<void>
-
Returns Promise<void>
dispatchEvent
- dispatchEvent(type, args): void
-
Returns void
dom
- dom(): Container[]
-
domItem
- domItem(index): undefined | Container
-
Returns undefined | Container
init
- init(): void
-
Returns void
load
- load(tagId, options?): Promise<undefined | Container>
-
Returns Promise<undefined | Container>
loadFromArray
- loadFromArray(tagId, options, index?): Promise<undefined | Container>
-
Parameters
-
tagId: string
-
-
Optional
index: number
Returns Promise<undefined | Container>
loadJSON
- loadJSON(tagId, pathConfigJson?, index?): Promise<undefined | Container>
-
Parameters
-
-
Optional
pathConfigJson: number | SingleOrMultiple<string>
-
Optional
index: number
Returns Promise<undefined | Container>
refresh
- refresh(): Promise<void>
-
Returns Promise<void>
removeEventListener
- removeEventListener(type, listener): void
-
Returns void
set
- set(id, element, options?): Promise<undefined | Container>
-
Returns Promise<undefined | Container>
setJSON
- setJSON(id, element, pathConfigJson?, index?): Promise<undefined | Container>
-
Parameters
-
id: string | HTMLElement
-
-
Optional
pathConfigJson: number | SingleOrMultiple<string>
-
Optional
index: number
Returns Promise<undefined | Container>
setOnClickHandler
- setOnClickHandler(callback): void
-
Parameters
-
callback: ((e, particles?) => void)
-
- (e, particles?): void
-
Returns void
Returns void