Interface IParticlesJS

[[include:pjsMigration.md]]

interface IParticlesJS {
    load(tagId: string, pathConfigJson: string, callback: ((container?: Container) => void)): void;
    setOnClickHandler(callback: EventListenerOrEventListenerObject): void;
    (tagId: string, options: IParticlesJSOptions): Promise<undefined | Container>;
}

Methods

load setOnClickHandler

Methods

load

  • load(tagId, pathConfigJson, callback): void

  • Loads the provided json with a GET request. The content will be used to create a Container object.

    Parameters

    • tagId: string

      the particles container element id

    • pathConfigJson: string

      the json path to use in the GET request

    • callback: ((container?: Container) => void)

      called after the Container is loaded and it will be passed as a parameter

        • (container?): void

        • Parameters

          Returns void

    Returns void

    Deprecated

    this method is obsolete, please use the new tsParticles.load

setOnClickHandler

  • setOnClickHandler(callback): void

  • Adds an additional click handler to all the loaded Container objects.

    Parameters

    • callback: EventListenerOrEventListenerObject

      the function called after the click event is fired

    Returns void

    Deprecated

    this method is obsolete, please use the new tsParticles.setOnClickHandler

Settings

Member Visibility

On This Page

Methods