tsParticles - v4.0.0-beta.12
    Preparing search index...

    The object loaded into an HTML element, it'll contain options loaded and all data to let everything working [[include:Container.md]]

    Index

    Constructors

    Properties

    actualOptions: Options

    The options loaded by the container, it's a full Options object

    Canvas object, in charge of the canvas element and drawing functions

    destroyed: boolean

    Check if the particles' container is destroyed, if so it's not recommended using it

    effectDrawers: Map<string, IEffectDrawer<Particle>>

    The effect drawers map

    fpsLimit: number

    The container fps limit, coming from options

    hdr: boolean

    The container hdr support flag

    id: symbol

    The container id

    pageHidden: boolean

    The container check if it's hidden on the web page

    particleCreatedPlugins: IContainerPlugin[]

    Particle created plugins

    particleDestroyedPlugins: IContainerPlugin[]

    Particle destroyed plugins

    particlePositionPlugins: IContainerPlugin[]

    Particle position plugins

    particles: ParticlesManager

    The particles manager

    particleUpdaters: IParticleUpdater[]

    The particle updaters array

    plugins: IContainerPlugin[]

    All the plugins used by the container

    retina: Retina

    The retina manager

    shapeDrawers: Map<string, IShapeDrawer<Particle>>

    The shape drawers map

    started: boolean

    Check if the particles container is started

    zLayers: number

    The number of z-layers

    Accessors

    • get animationStatus(): boolean

      Gets the animation status

      Returns boolean

      true is playing, false is paused

    Methods

    • Adds to the container lifetime

      Parameters

      • value: number

      Returns void

    • Destroys the current container, invalidating it

      Parameters

      • remove: boolean = true

        if true, removes the container from the engine

      Returns void

    • Dispatches an event from the container

      Parameters

      • type: string
      • Optionaldata: unknown

      Returns void

    • Draws a frame

      Parameters

      • force: boolean

      Returns void

    • Exports the container canvas to the specified format

      Parameters

      • type: string
      • options: Record<string, unknown> = {}

      Returns Promise<Blob | undefined>

    • Starts animations and resume from pause

      Parameters

      • Optionalforce: boolean

      Returns void

    • Stops the container, opposite to start. Clears some resources and stops events.

      Returns void

    • Updates the container options

      Returns boolean

      true if the options were updated, false otherwise