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