Class Engine

constructor

• new Engine(): Engine

• Returns Engine

Readonly plugins

configs

• get configs(): Record<string, RecursivePartial<IOptions>>

• Returns Record<string, RecursivePartial<IOptions>>

version

• get version(): string

• Returns string

addConfig

• addConfig(nameOrConfig, config?): void

• Parameters

  • nameOrConfig: string | RecursivePartial<IOptions>

  • Optional config: RecursivePartial<IOptions>

  Returns void

addEventListener

• addEventListener(type, listener): void

• Parameters

  • type: string

  • listener: CustomEventListener

  Returns void

addInteractor

• addInteractor(name, interactorInitializer, refresh?): Promise<void>

• Parameters

  • name: string

  • interactorInitializer: ((container) => IInteractor)

    • • (container): IInteractor

      • Parameters

        • container: Container

        Returns IInteractor

  • Optional refresh: boolean

  Returns Promise<void>

addMover

• addMover(name, moverInitializer, refresh?): Promise<void>

• Parameters

  • name: string

  • moverInitializer: ((container) => IParticleMover)

    • • (container): IParticleMover

      • Parameters

        • container: Container

        Returns IParticleMover

  • Optional refresh: boolean

  Returns Promise<void>

addParticleUpdater

• addParticleUpdater(name, updaterInitializer, refresh?): Promise<void>

• Parameters

  • name: string

  • updaterInitializer: ((container) => IParticleUpdater)

    • • (container): IParticleUpdater

      • Parameters

        • container: Container

        Returns IParticleUpdater

  • Optional refresh: boolean

  Returns Promise<void>

addPathGenerator

• addPathGenerator(name, generator, refresh?): Promise<void>

• Parameters

  • name: string

  • generator: IMovePathGenerator

  • Optional refresh: boolean

  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>

• Parameters

  • preset: string

  • options: RecursivePartial<IOptions>

  • Optional override: boolean

  • Optional refresh: boolean

  Returns Promise<void>

addShape

• addShape(shape, drawer, initOrRefresh?, afterEffectOrRefresh?, destroyOrRefresh?, refresh?): Promise<void>

• Parameters

  • shape: SingleOrMultiple<string>

  • drawer: IShapeDrawer | ShapeDrawerDrawFunction

  • Optional initOrRefresh: boolean | ShapeDrawerInitFunction

  • Optional afterEffectOrRefresh: boolean | ShapeDrawerAfterEffectFunction

  • Optional destroyOrRefresh: boolean | ShapeDrawerDestroyFunction

  • Optional refresh: boolean

  Returns Promise<void>

dispatchEvent

• dispatchEvent(type, args): void

• Parameters

  • type: string

  • args: CustomEventArgs

  Returns void

dom

• dom(): Container[]

• Returns Container[]

domItem

• domItem(index): undefined | Container

• Parameters

  • index: number

  Returns undefined | Container

init

• init(): void

• Returns void

load

• load(tagIdOrOptionsOrParams, options?): Promise<undefined | Container>

• Parameters

  • tagIdOrOptionsOrParams: string | ILoadParams | SingleOrMultiple<RecursivePartial<IOptions>>

  • Optional options: SingleOrMultiple<RecursivePartial<IOptions>>

  Returns Promise<undefined | Container>

loadFromArray

• loadFromArray(tagIdOrOptionsOrParams, optionsOrIndex?, index?): Promise<undefined | Container>

• Parameters

  • tagIdOrOptionsOrParams: string | ILoadParams | SingleOrMultiple<RecursivePartial<IOptions>>

  • Optional optionsOrIndex: number | SingleOrMultiple<RecursivePartial<IOptions>>

  • Optional index: number

  Returns Promise<undefined | Container>

loadJSON

• loadJSON(tagId, pathConfigJson?, index?): Promise<undefined | Container>

• Parameters

  • tagId: SingleOrMultiple<string>

  • 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

• Parameters

  • type: string

  • listener: CustomEventListener

  Returns void

set

• set(id, element, options?, index?): Promise<undefined | Container>

• Parameters

  • id: string | HTMLElement

  • element: HTMLElement | RecursivePartial<IOptions>

  • Optional options: number | SingleOrMultiple<RecursivePartial<IOptions>>

  • Optional index: number

  Returns Promise<undefined | Container>

setJSON

• setJSON(id, element, pathConfigJson?, index?): Promise<undefined | Container>

• Parameters

  • id: string | HTMLElement

  • element: HTMLElement | SingleOrMultiple<string>

  • Optional pathConfigJson: number | SingleOrMultiple<string>

  • Optional index: number

  Returns Promise<undefined | Container>

setOnClickHandler

• setOnClickHandler(callback): void

• Parameters

  • callback: ((e, particles?) => void)

    • • (e, particles?): void

      • Parameters

        • e: Event

        • Optional particles: Particle[]

        Returns void

  Returns void