Interface IParticlesJS

Hierarchy

IParticlesJS

IParticlesJS(tagId, options): Promise<undefined | Container>
Loads the provided options to create a Container object.
Parameters
- tagId: string
  
  the particles container element id
- options: IParticlesJSOptions
  
  the options object to initialize the Container
Returns Promise<undefined | Container>

Deprecated
this method is obsolete, please use the new tsParticles.load
- Defined in bundles/pjs/src/VincentGarreau/IParticlesJS.ts:133

Index

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?) => void)
  
  called after the Container is loaded and it will be passed as a parameter
  - - (container?): void
    - Parameters
      
      Optional container: Container
      
      Returns void
Returns void

Deprecated
this method is obsolete, please use the new tsParticles.load
- Defined in bundles/pjs/src/VincentGarreau/IParticlesJS.ts:143

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
- Defined in bundles/pjs/src/VincentGarreau/IParticlesJS.ts:150