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
_loadParams
_loadParams: 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, refresh?): Promise<void>
-
Parameters
-
name: string
-
interactorInitializer: ((container) => IInteractor)
-
Optional
refresh: boolean
Returns Promise<void>
addMover
- addMover(name, moverInitializer, refresh?): Promise<void>
-
Parameters
-
name: string
-
moverInitializer: ((container) => IParticleMover)
-
Optional
refresh: boolean
Returns Promise<void>
addParticleUpdater
- addParticleUpdater(name, updaterInitializer, refresh?): Promise<void>
-
Parameters
-
name: string
-
updaterInitializer: ((container) => IParticleUpdater)
-
Optional
refresh: boolean
Returns Promise<void>
addPathGenerator
- addPathGenerator(name, generator, refresh?): Promise<void>
-
Parameters
-
name: string
-
-
Optional
refresh: boolean
Returns Promise<void>
addPlugin
- addPlugin(plugin, refresh?): Promise<void>
-
Parameters
-
-
Optional
refresh: boolean
Returns Promise<void>
addPreset
- addPreset(preset, options, override?, refresh?): Promise<void>
-
Parameters
-
preset: string
-
-
Optional
override: boolean
-
Optional
refresh: boolean
Returns Promise<void>
addShape
- addShape(shape, drawer, initOrRefresh?, afterEffectOrRefresh?, destroyOrRefresh?, refresh?): Promise<void>
-
Parameters
-
-
-
-
-
-
Optional
refresh: boolean
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(tagIdOrOptionsOrParams, options?): Promise<undefined | Container>
-
Returns Promise<undefined | Container>
loadFromArray
- loadFromArray(tagIdOrOptionsOrParams, optionsOrIndex?, index?): Promise<undefined | Container>
-
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(refresh?): Promise<void>
-
Parameters
-
Optional
refresh: boolean
Returns Promise<void>
removeEventListener
- removeEventListener(type, listener): void
-
Returns void
set
- set(id, element, options?, index?): Promise<undefined | Container>
-
Parameters
-
id: string | HTMLElement
-
-
-
Optional
index: number
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