tsParticles - v0.0.0
    Preparing search index...

    Interface Particle

    interface Particle {
        backColor?: IHsl;
        bubble: IBubbleParticleData;
        color?: IParticleHslAnimation;
        container: Container;
        destroyed: boolean;
        direction: number;
        effect?: string;
        effectClose: boolean;
        effectData?: IShapeValues;
        effectFill: boolean;
        group?: string;
        id: number;
        ignoresResizeRatio: boolean;
        initialPosition: Vector;
        initialVelocity: Vector;
        isRotating: boolean;
        lastPathTime: number;
        misplaced: boolean;
        moveCenter: ICenterCoordinates;
        moveDecay: number;
        offset: Vector;
        opacity?: IParticleNumericValueAnimation;
        options: ParticlesOptions;
        outType: ParticleOutType;
        pathDelay: number;
        pathGenerator?: IMovePathGenerator;
        pathRotation: boolean;
        position: Vector3d;
        randomIndexData?: number;
        retina: IParticleRetinaProps;
        roll?: IParticleRoll;
        rotation: number;
        shape?: string;
        shapeClose: boolean;
        shapeData?: IShapeValues;
        shapeFill: boolean;
        sides: number;
        size: IParticleNumericValueAnimation;
        slow: ISlowParticleData;
        spawning: boolean;
        strokeColor?: IParticleHslAnimation;
        strokeOpacity?: number;
        strokeWidth?: number;
        unbreakable: boolean;
        velocity: Vector;
        zIndexFactor: number;
        destroy(override?: boolean): void;
        draw(delta: IDelta): void;
        getAngle(): number;
        getFillColor(): IHsl | undefined;
        getMass(): number;
        getOpacity(): IParticleOpacityData;
        getPosition(): ICoordinates3d;
        getRadius(): number;
        getRotateData(): IParticleRotateData;
        getStrokeColor(): IHsl | undefined;
        getTransformData(
            externalTransform: Partial<IParticleTransformValues>,
        ): IParticleTransformValues;
        init(
            id: number,
            position?: ICoordinates,
            overrideOptions?: RecursivePartial<IParticlesOptions>,
            group?: string,
        ): void;
        isInsideCanvas(): boolean;
        isShowingBack(): boolean;
        isVisible(): boolean;
        reset(): void;
    }
    Index

    Properties

    backColor? bubble color? container destroyed direction effect? effectClose effectData? effectFill group? id ignoresResizeRatio initialPosition initialVelocity isRotating lastPathTime misplaced moveCenter moveDecay offset opacity? options outType pathDelay pathGenerator? pathRotation position randomIndexData? retina roll? rotation shape? shapeClose shapeData? shapeFill sides size slow spawning strokeColor? strokeOpacity? strokeWidth? unbreakable velocity zIndexFactor

    Methods

    destroy draw getAngle getFillColor getMass getOpacity getPosition getRadius getRotateData getStrokeColor getTransformData init isInsideCanvas isShowingBack isVisible reset

    Properties

    backColor?: IHsl
    bubble: IBubbleParticleData
    color?: IParticleHslAnimation
    container: Container
    destroyed: boolean
    direction: number
    effect?: string
    effectClose: boolean
    effectData?: IShapeValues
    effectFill: boolean
    group?: string
    id: number
    ignoresResizeRatio: boolean
    initialPosition: Vector
    initialVelocity: Vector
    isRotating: boolean
    lastPathTime: number
    misplaced: boolean
    moveCenter: ICenterCoordinates
    moveDecay: number
    offset: Vector
    opacity?: IParticleNumericValueAnimation
    options: ParticlesOptions
    outType: ParticleOutType
    pathDelay: number
    pathGenerator?: IMovePathGenerator
    pathRotation: boolean
    position: Vector3d
    randomIndexData?: number
    retina: IParticleRetinaProps
    roll?: IParticleRoll
    rotation: number
    shape?: string
    shapeClose: boolean
    shapeData?: IShapeValues
    shapeFill: boolean
    sides: number
    size: IParticleNumericValueAnimation
    slow: ISlowParticleData
    spawning: boolean
    strokeColor?: IParticleHslAnimation
    strokeOpacity?: number
    strokeWidth?: number
    unbreakable: boolean
    velocity: Vector
    zIndexFactor: number

    Methods

    • Parameters

      • Optionaloverride: boolean

      Returns void

    • Parameters

      Returns void

    • Returns number

    • Returns IHsl | undefined

    • Returns number

    • Returns IParticleOpacityData

    • Returns number

    • Returns IParticleRotateData

    • Returns IHsl | undefined

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods