ReadonlycolorReadonlyeasingReadonlyeffectThe drawers (additional effects) array
ReadonlyinitializersReadonlymoversReadonlypathThe path generators array
ReadonlypluginsThe plugins array
ReadonlypresetsThe presets array
ReadonlyshapeThe drawers (additional shapes) array
ReadonlyupdatersThe updaters array
addEffect adds effect to tsParticles, it will be available to all future instances created
the effect name
the effect drawer function or class instance that draws the effect in the canvas
Adds a listener to the specified event
The event to listen to
The listener of the specified event
the mover name
the mover initializer
Adds a particle updater to the collection
the particle updater name used as a key
the particle updater initializer
addPathGenerator adds a named path generator to tsParticles, this can be called by options
the path generator name
the path generator object
addPreset adds preset to tsParticles, it will be available to all future instances created
the preset name
the options to add to the preset
if true, the preset will override any existing with the same name
addShape adds shape to tsParticles, it will be available to all future instances created
the shape names to add, it can be a single shape or an array of shapes
the shape drawer function or class instance that draws the shape in the canvas
the plugin version to check against
Dispatches an event that will be listened from listeners
The event to dispatch
Optionalargs: CustomEventArgsThe event parameters
Searches if the specified plugin exists and returns it
the plugin name
the plugin if found, or undefined
Searches the preset with the given name
the preset name to search
the preset if found, or undefined
Returns all the container particle updaters
the container used to check which particle updaters are enabled
if true reloads the updater collection for the given container
the array of updaters for the given container
init method, used by imports
Loads the provided options to create a Container object.
The particles container params ILoadParams object
A Promise with the Container object created
Load the given particles options for all the updaters
the container of the updaters
the actual options to set
the source options to read
Reloads all existing tsParticles loaded instances
should refresh the dom after reloading
Removes a listener from the specified event
The event to stop listening to
The listener of the specified event
Engine class for creating the singleton on globalThis. It's a singleton class for initializing Container instances, and for Plugins class responsible for every external feature