tsParticles - v4.1.1
    Preparing search index...

    Interface TextParticle

    interface TextParticle {
        backColor?: IHsl;
        bubble: IBubbleParticleData;
        destroyed: boolean;
        direction: number;
        effect?: string;
        effectClose: boolean;
        effectData?: IShapeValues;
        fillColor?: IParticleHslAnimation;
        fillEnabled?: boolean;
        fillOpacity?: number;
        group?: string;
        id: number;
        ignoresResizeRatio: boolean;
        initialPosition: Vector;
        initialVelocity: Vector;
        isRotating: boolean;
        justWarped: boolean;
        lastPathTime: number;
        maxTextLength?: number;
        misplaced: boolean;
        moveCenter: ICenterCoordinates;
        offset: Vector;
        opacity?: IParticleNumericValueAnimation;
        options: ParticlesOptions;
        outType: ParticleOutType;
        pathRotation: boolean;
        position: Vector3d;
        randomIndexData?: number;
        retina: IParticleRetinaProps;
        roll?: IParticleRoll;
        rotation: number;
        shape?: string;
        shapeClose: boolean;
        shapeData?: ITextShape;
        sides: number;
        size: IParticleNumericValueAnimation;
        slow: ISlowParticleData;
        spawning: boolean;
        strokeColor?: IParticleHslAnimation;
        strokeOpacity?: number;
        strokeWidth?: number;
        textLines?: string[];
        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(direction?: OutModeDirection): boolean;
        isInsideCanvasForOutMode(
            outMode: "bounce" | OutMode | "none" | "out" | "destroy" | "split",
            direction?: OutModeDirection,
        ): boolean;
        isShowingBack(): boolean;
        isVisible(): boolean;
        reset(): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    backColor? bubble destroyed direction effect? effectClose effectData? fillColor? fillEnabled? fillOpacity? group? id ignoresResizeRatio initialPosition initialVelocity isRotating justWarped lastPathTime maxTextLength? misplaced moveCenter offset opacity? options outType pathRotation position randomIndexData? retina roll? rotation shape? shapeClose shapeData? sides size slow spawning strokeColor? strokeOpacity? strokeWidth? textLines? unbreakable velocity zIndexFactor

    Methods

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

    Properties

    backColor?: IHsl
    bubble: IBubbleParticleData
    destroyed: boolean
    direction: number
    effect?: string
    effectClose: boolean
    effectData?: IShapeValues
    fillColor?: IParticleHslAnimation
    fillEnabled?: boolean
    fillOpacity?: number
    group?: string
    id: number
    ignoresResizeRatio: boolean
    initialPosition: Vector
    initialVelocity: Vector
    isRotating: boolean
    justWarped: boolean
    lastPathTime: number
    maxTextLength?: number
    misplaced: boolean
    moveCenter: ICenterCoordinates
    offset: Vector
    opacity?: IParticleNumericValueAnimation
    options: ParticlesOptions
    outType: ParticleOutType
    pathRotation: boolean
    position: Vector3d
    randomIndexData?: number
    retina: IParticleRetinaProps
    roll?: IParticleRoll
    rotation: number
    shape?: string
    shapeClose: boolean
    shapeData?: ITextShape
    sides: number
    size: IParticleNumericValueAnimation
    slow: ISlowParticleData
    spawning: boolean
    strokeColor?: IParticleHslAnimation
    strokeOpacity?: number
    strokeWidth?: number
    textLines?: string[]
    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 boolean

    • Returns boolean

    • Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods