Options
All
  • Public
  • Public/Protected
  • All
Menu

Module Core/Container

Particles Container

The Container class is the manager of the entire tsParticles instance. If you get the result of tsParticles.load the result it's this class, in the tsParticles.loadJSON is the then parameter.

Otherwise you can retrieve any loaded instance using tsParticles.dom() or tsParticles.domItem(index).

Properties

id: the Container id, normally is the related DOM element id attribute. It's set by tsParticles.load() and tsParticles.loadJSON().

options: Where to find the current options loaded. Changing this options while playing can result in an unexpected behavior. A refresh() after the change is the best thing to do.
{@link sourceOptions}: The options used when the Container was created, these options will be used only in the constructor.

particles: The particles manager, you can add/remove particles from here.

Methods

play(): Used to resume the animations, can be stopped using pause().
pause(): Used to pause the animations, can be restarted using play().

destroy(): Prepare the instance to destruction, you won't retrieve this instance anymore. Only if you have a variable set with it.

exportImage(callback, type?, quality?): Exports an image of the canvas (without the background property if set), type and quality are optional and are the image output type and quality.
exportConfiguration(): Exports the current configuration in JSON, returns a string

start(): Starts the container, it's different from play(), this will reload everything.
stop(): Stops the container, it's different from pause(), this will clean up what need to be reloaded.
refresh(): Restarts the container, just a stop()/start() shortcut.

setTheme(name): Sets the specified theme reloading options, if name is undefined the default theme will be used (if set)

Index

Core Classes