tsParticles - v0.0.0
    Preparing search index...

    Interface Engine

    interface Engine {
        colorManagers: Map<string, IColorManager>;
        easingFunctions: Map<EasingTypeAlt | EasingType, EasingFunction>;
        effectDrawers: Map<string, IEffectDrawer<Particle>>;
        movers: Map<Container, IParticleMover[]>;
        pathGenerators: Map<string, IMovePathGenerator>;
        plugins: IPlugin[];
        presets: Map<string, RecursivePartial<IOptions>>;
        shapeDrawers: Map<string, IShapeDrawer<Particle>>;
        updaters: Map<Container, IParticleUpdater[]>;
        get configs(): Record<string, ISourceOptions>;
        get items(): Container[];
        get version(): string;
        addColorManager(manager: IColorManager): void;
        addConfig(config: ISourceOptions): void;
        addEasing(name: EasingTypeAlt | EasingType, easing: EasingFunction): void;
        addEffect(effect: string, drawer: IEffectDrawer): void;
        addEventListener(type: string, listener: CustomEventListener): void;
        addMover(name: string, moverInitializer: MoverInitializer): void;
        addParticleUpdater(
            name: string,
            updaterInitializer: UpdaterInitializer,
        ): void;
        addPathGenerator(name: string, generator: IMovePathGenerator): void;
        addPlugin(plugin: IPlugin): void;
        addPreset(
            preset: string,
            options: Readonly<ISourceOptions>,
            override?: boolean,
        ): void;
        addShape(drawer: IShapeDrawer): void;
        checkVersion(pluginVersion: string): void;
        clearPlugins(container: Container): void;
        dispatchEvent(type: string, args?: CustomEventArgs): void;
        getEasing(name: EasingTypeAlt | EasingType): EasingFunction;
        getEffectDrawer(type: string): IEffectDrawer<Particle> | undefined;
        getMovers(container: Container, force?: boolean): Promise<IParticleMover[]>;
        getPathGenerator(type: string): IMovePathGenerator | undefined;
        getPlugin(plugin: string): IPlugin | undefined;
        getPreset(preset: string): RecursivePartial<IOptions> | undefined;
        getShapeDrawer(type: string): IShapeDrawer<Particle> | undefined;
        getSupportedEffects(): IterableIterator<string>;
        getSupportedShapes(): IterableIterator<string>;
        getUpdaters(
            container: Container,
            force?: boolean,
        ): Promise<IParticleUpdater[]>;
        init(): Promise<void>;
        item(index: number): Container | undefined;
        load(params: ILoadParams): Promise<Container | undefined>;
        loadParticlesOptions(
            container: Container,
            options: ParticlesOptions,
            ...sourceOptions: (RecursivePartial<IParticlesOptions> | undefined)[],
        ): void;
        refresh(refresh?: boolean): Promise<void>;
        register(...loaders: LoadPluginFunction[]): Promise<void>;
        removeEventListener(type: string, listener: CustomEventListener): void;
    }
    Index

    Properties

    colorManagers easingFunctions effectDrawers movers pathGenerators plugins presets shapeDrawers updaters

    Accessors

    configs items version

    Methods

    addColorManager addConfig addEasing addEffect addEventListener addMover addParticleUpdater addPathGenerator addPlugin addPreset addShape checkVersion clearPlugins dispatchEvent getEasing getEffectDrawer getMovers getPathGenerator getPlugin getPreset getShapeDrawer getSupportedEffects getSupportedShapes getUpdaters init item load loadParticlesOptions refresh register removeEventListener

    Properties

    colorManagers: Map<string, IColorManager>
    easingFunctions: Map<EasingTypeAlt | EasingType, EasingFunction>
    effectDrawers: Map<string, IEffectDrawer<Particle>>
    movers: Map<Container, IParticleMover[]>
    pathGenerators: Map<string, IMovePathGenerator>
    plugins: IPlugin[]
    presets: Map<string, RecursivePartial<IOptions>>
    shapeDrawers: Map<string, IShapeDrawer<Particle>>
    updaters: Map<Container, IParticleUpdater[]>

    Accessors

    • get items(): Container[]

      Returns Container[]

    • get version(): string

      Returns string

    Methods

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      • preset: string
      • options: Readonly<ISourceOptions>
      • Optionaloverride: boolean

      Returns void

    • Parameters

      Returns void

    • Parameters

      • pluginVersion: string

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      • plugin: string

      Returns IPlugin | undefined

    • Returns IterableIterator<string>

    • Returns IterableIterator<string>

    • Returns Promise<void>

    • Parameters

      • index: number

      Returns Container | undefined

    • Parameters

      • Optionalrefresh: boolean

      Returns Promise<void>

    • Parameters

      • ...loaders: LoadPluginFunction[]

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods