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
_initializers
_initializers: any
Readonly
effectDrawers
Readonly
interactors
Readonly
movers
Readonly
pathGenerators
Readonly
plugins
Readonly
presets
Readonly
shapeDrawers
Readonly
updaters
Accessors
items
- get items(): Container[]
version
- get version(): string
Returns string
Methods
addConfig
- addConfig(config): void
Returns void
addEffect
- addEffect(effect, drawer, refresh?): Promise<void>
Returns Promise<void>
addEventListener
- addEventListener(type, listener): void
Returns void
addInteractor
- addInteractor(name, interactorInitializer, refresh?): Promise<void>
Parameters
- name: string
- interactorInitializer: InteractorInitializer
Optional
refresh: boolean
Returns Promise<void>
addMover
- addMover(name, moverInitializer, refresh?): Promise<void>
Parameters
- name: string
- moverInitializer: MoverInitializer
Optional
refresh: boolean
Returns Promise<void>
addParticleUpdater
- addParticleUpdater(name, updaterInitializer, refresh?): Promise<void>
Parameters
- name: string
- updaterInitializer: UpdaterInitializer
Optional
refresh: boolean
Returns Promise<void>
addPathGenerator
- addPathGenerator(name, generator, refresh?): Promise<void>
Returns Promise<void>
addPlugin
- addPlugin(plugin, refresh?): Promise<void>
Parameters
- plugin: IPlugin
Optional
refresh: boolean
Returns Promise<void>
addPreset
- addPreset(preset, options, override?, refresh?): Promise<void>
Returns Promise<void>
addShape
- addShape(drawer, refresh?): Promise<void>
Returns Promise<void>
clearPlugins
- clearPlugins(container): void
Returns void
dispatchEvent
- dispatchEvent(type, args): void
Returns void
dom
- dom(): Container[]
domItem
- domItem(index): undefined | Container
Returns undefined | Container
getAvailablePlugins
- getAvailablePlugins(container): Promise<Map<string, IContainerPlugin>>
getEffectDrawer
- getEffectDrawer(type): undefined | IEffectDrawer<Particle>
getInteractors
- getInteractors(container, force?): Promise<IInteractor<Particle>[]>
getMovers
- getMovers(container, force?): Promise<IParticleMover[]>
getPathGenerator
- getPathGenerator(type): undefined | IMovePathGenerator
getPlugin
- getPlugin(plugin): undefined | IPlugin
Returns undefined | IPlugin
getShapeDrawer
- getShapeDrawer(type): undefined | IShapeDrawer<Particle>
getSupportedEffects
- getSupportedEffects(): IterableIterator<string>
Returns IterableIterator<string>
getSupportedShapes
- getSupportedShapes(): IterableIterator<string>
Returns IterableIterator<string>
getUpdaters
- getUpdaters(container, force?): Promise<IParticleUpdater[]>
init
- init(): void
Returns void
item
- item(index): undefined | Container
Returns undefined | Container
load
- load(params): Promise<undefined | Container>
Returns Promise<undefined | Container>
loadOptions
- loadOptions(options, sourceOptions): void
Returns void
loadParticlesOptions
- loadParticlesOptions(container, options, ...sourceOptions): void
Returns void
refresh
- refresh(refresh?): Promise<void>
Parameters
Optional
refresh: boolean
Returns Promise<void>
removeEventListener
- removeEventListener(type, listener): void
Returns void
setOnClickHandler
- setOnClickHandler(callback): void
Parameters
- callback: ((e, particles?) => void)
- (e, particles?): void
Returns void
Returns void