Class Engine

constructor

• new Engine(): Engine

• Engine constructor, initializes plugins, loader and the containers array

  Returns Engine

Readonly effectDrawers

Readonly interactors

Readonly movers

Readonly pathGenerators

Readonly plugins

Readonly presets

Readonly shapeDrawers

Readonly updaters

configs

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

• Returns Record<string, RecursivePartial<IOptions>>

version

• get version(): string

• Returns string

addConfig

• addConfig(config): void

• Parameters

  • config: RecursivePartial<IOptions>

  Returns void

addEffect

• addEffect(effect, drawer, refresh?): Promise<void>

• addEffect adds effect to tsParticles, it will be available to all future instances created

  Parameters

  • effect: SingleOrMultiple<string>

    the effect name

  • drawer: IEffectDrawer<Particle>

    the effect drawer function or class instance that draws the effect in the canvas

  • refresh: boolean = true

    should refresh the dom after adding the effect

  Returns Promise<void>

addEventListener

• addEventListener(type, listener): void

• Adds a listener to the specified event

  Parameters

  • type: string

    The event to listen to

  • listener: CustomEventListener

    The listener of the specified event

  Returns void

addInteractor

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

• Adds an interaction manager to the current collection

  Parameters

  • name: string

    the interaction manager name

  • interactorInitializer: InteractorInitializer

    the interaction manager initializer

  • refresh: boolean = true

    if true the engine will refresh all the containers

  Returns Promise<void>

addMover

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

• Parameters

  • name: string

    the mover name

  • moverInitializer: MoverInitializer

    the mover initializer

  • refresh: boolean = true

    if true the engine will refresh all the containers

  Returns Promise<void>

addParticleUpdater

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

• Adds a particle updater to the collection

  Parameters

  • name: string

    the particle updater name used as a key

  • updaterInitializer: UpdaterInitializer

    the particle updater initializer

  • refresh: boolean = true

    if true the engine will refresh all the containers

  Returns Promise<void>

addPathGenerator

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

• addPathGenerator adds a named path generator to tsParticles, this can be called by options

  Parameters

  • name: string

    the path generator name

  • generator: IMovePathGenerator

    the path generator object

  • refresh: boolean = true

    should refresh the dom after adding the path generator

  Returns Promise<void>

addPlugin

• addPlugin(plugin, refresh?): Promise<void>

• addPlugin adds plugin to tsParticles, if an instance needs it, it will be loaded

  Parameters

  • plugin: IPlugin

    the plugin implementation of IPlugin

  • refresh: boolean = true

    should refresh the dom after adding the plugin

  Returns Promise<void>

addPreset

• addPreset(preset, options, override?, refresh?): Promise<void>

• addPreset adds preset to tsParticles, it will be available to all future instances created

  Parameters

  • preset: string

    the preset name

  • options: RecursivePartial<IOptions>

    the options to add to the preset

  • override: boolean = false

    if true, the preset will override any existing with the same name

  • refresh: boolean = true

    should refresh the dom after adding the preset

  Returns Promise<void>

addShape

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

• addShape adds shape to tsParticles, it will be available to all future instances created

  Parameters

  • shape: SingleOrMultiple<string>

    the shape name

  • drawer: IShapeDrawer<Particle>

    the shape drawer function or class instance that draws the shape in the canvas

  • refresh: boolean = true

    should refresh the dom after adding the shape

  Returns Promise<void>

clearPlugins

• clearPlugins(container): void

• Parameters

  • container: Container

  Returns void

dispatchEvent

• dispatchEvent(type, args): void

• Dispatches an event that will be listened from listeners

  Parameters

  • type: string

    The event to dispatch

  • args: CustomEventArgs

    The event parameters

  Returns void

dom

• dom(): Container[]

• All the Container objects loaded

  Returns Container[]

  All the Container objects loaded

domItem

• domItem(index): undefined | Container

• Retrieves a Container from all the objects loaded

  Parameters

  • index: number

    The object index

  Returns undefined | Container

  The Container object at specified index, if present or not destroyed, otherwise undefined

getAvailablePlugins

• getAvailablePlugins(container): Promise<Map<string, IContainerPlugin>>

• Gets all the available plugins, for the specified container

  Parameters

  • container: Container

    the container used to check which are the valid plugins

  Returns Promise<Map<string, IContainerPlugin>>

  a map containing all enabled plugins, with the id as a key

getEffectDrawer

• getEffectDrawer(type): undefined | IEffectDrawer<Particle>

• Searches the given effect drawer type with the given type name

  Parameters

  • type: string

    the effect drawer type name

  Returns undefined | IEffectDrawer<Particle>

  the effect drawer if found, or undefined

getInteractors

• getInteractors(container, force?): Promise<IInteractor<Particle>[]>

• Returns all the container interaction managers

  Parameters

  • container: Container

    the container used to check which interaction managers are compatible

  • force: boolean = false

    if true reloads the interaction managers collection for the given container

  Returns Promise<IInteractor<Particle>[]>

  the array of interaction managers for the given container

getMovers

• getMovers(container, force?): Promise<IParticleMover[]>

• Parameters

  • container: Container

  • force: boolean = false

  Returns Promise<IParticleMover[]>

getPathGenerator

• getPathGenerator(type): undefined | IMovePathGenerator

• Searches the path generator with the given type name

  Parameters

  • type: string

    the path generator type to search

  Returns undefined | IMovePathGenerator

  the path generator if found, or undefined

getPlugin

• getPlugin(plugin): undefined | IPlugin

• Searches if the specified plugin exists and returns it

  Parameters

  • plugin: string

    the plugin name

  Returns undefined | IPlugin

  the plugin if found, or undefined

getPreset

• getPreset(preset): undefined | RecursivePartial<IOptions>

• Searches the preset with the given name

  Parameters

  • preset: string

    the preset name to search

  Returns undefined | RecursivePartial<IOptions>

  the preset if found, or undefined

getShapeDrawer

• getShapeDrawer(type): undefined | IShapeDrawer<Particle>

• Searches the given shape drawer type with the given type name

  Parameters

  • type: string

    the shape drawer type name

  Returns undefined | IShapeDrawer<Particle>

  the shape drawer if found, or undefined

getSupportedEffects

• getSupportedEffects(): IterableIterator<string>

• This method returns all the supported effects with this Plugins instance

  Returns IterableIterator<string>

  all the supported effects type name

getSupportedShapes

• getSupportedShapes(): IterableIterator<string>

• This method returns all the supported shapes with this Plugins instance

  Returns IterableIterator<string>

  all the supported shapes type name

getUpdaters

• getUpdaters(container, force?): Promise<IParticleUpdater[]>

• Returns all the container particle updaters

  Parameters

  • container: Container

    the container used to check which particle updaters are enabled

  • force: boolean = false

    if true reloads the updater collection for the given container

  Returns Promise<IParticleUpdater[]>

  the array of updaters for the given container

init

• init(): void

• init method, used by imports

  Returns void

load

• load(params): Promise<undefined | Container>

• Loads the provided options to create a Container object.

  Parameters

  • params: ILoadParams

    The particles container params ILoadParams object

  Returns Promise<undefined | Container>

  A Promise with the Container object created

loadOptions

• loadOptions(options, sourceOptions): void

• Load the given options for all the plugins

  Parameters

  • options: Options

    the actual options to set

  • sourceOptions: RecursivePartial<IOptions>

    the source options to read

  Returns void

loadParticlesOptions

• loadParticlesOptions(container, options, ...sourceOptions): void

• Load the given particles options for all the updaters

  Parameters

  • container: Container

    the container of the updaters

  • options: ParticlesOptions

    the actual options to set

  • Rest ...sourceOptions: (undefined | RecursivePartial<IParticlesOptions>)[]

    the source options to read

  Returns void

refresh

• refresh(refresh?): Promise<void>

• Reloads all existing tsParticles loaded instances

  Parameters

  • refresh: boolean = true

    should refresh the dom after reloading

  Returns Promise<void>

removeEventListener

• removeEventListener(type, listener): void

• Removes a listener from the specified event

  Parameters

  • type: string

    The event to stop listening to

  • listener: CustomEventListener

    The listener of the specified event

  Returns void

setOnClickHandler

• setOnClickHandler(callback): void

• Adds another click handler to all the loaded Container objects.

  Parameters

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

    The function called after the click event is fired

    • • (e, particles?): void

      • Parameters

        • e: Event

        • Optional particles: Particle[]

        Returns void

  Returns void