tsParticles - v4.0.0-beta.12
    Preparing search index...

    Class Particle

    The single particle object

    Index

    Constructors

    constructor

    Properties

    backColor? bubble destroyed direction effect? effectClose effectData? fillColor? fillEnabled? fillOpacity? group? id ignoresResizeRatio initialPosition initialVelocity isRotating justWarped lastPathTime misplaced moveCenter offset opacity? options outType pathRotation position randomIndexData? retina roll? rotation shape? shapeClose shapeData? 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

    Constructors

    Properties

    backColor?: IHsl

    Particles back color

    bubble: IBubbleParticleData

    Gets particles bubble data

    destroyed: boolean

    Checks if the particle is destroyed

    direction: number

    Gets particle direction, the value is an angle in rad

    effect?: string

    Gets particle effect type

    effectClose: boolean

    Checks if the particle effect needs a closed path

    effectData?: IShapeValues

    Gets particle effect options

    fillColor?: IParticleHslAnimation

    Sets the particle fill color

    fillEnabled?: boolean

    Sets the particle fill status

    fillOpacity?: number

    Sets the particle fill opacity

    group?: string

    The particle group

    id: number

    The particle id

    ignoresResizeRatio: boolean

    When this is enabled, the particle won't resize when the canvas resize event is fired

    initialPosition: Vector

    Gets particle initial position

    initialVelocity: Vector

    Gets particle initial velocity

    isRotating: boolean

    Checks if the particle is rotating

    justWarped: boolean

    Checks if the particle just warped

    lastPathTime: number

    Last path timestamp

    misplaced: boolean

    Check if the particle needs a fix on the position

    moveCenter: ICenterCoordinates

    The move center coordinates

    offset: Vector

    Gets particle offset position, used for parallax interaction

    opacity?: IParticleNumericValueAnimation

    Gets the particle opacity options

    options: ParticlesOptions

    Gets the particle options

    outType: ParticleOutType

    The particle out type

    pathRotation: boolean

    Gets if the particle should rotate with path

    position: Vector3d

    Gets particle current position

    randomIndexData?: number

    The random index used by the particle

    retina: IParticleRetinaProps

    Gets the particle retina values

    roll?: IParticleRoll

    Gets the particle roll options

    rotation: number

    Gets the particle rotation angle

    shape?: string

    Gets particle shape type

    shapeClose: boolean

    Checks if the particle shape needs a closed path

    shapeData?: IShapeValues

    Gets particle shape options

    sides: number

    Gets the particle side count

    size: IParticleNumericValueAnimation

    Gets particle size options

    slow: ISlowParticleData

    Gets particle slow options

    spawning: boolean

    Check if the particle is spawning, and can't be touched

    strokeColor?: IParticleHslAnimation

    Sets the particle stroke color

    strokeOpacity?: number

    Sets the particle stroke opacity

    strokeWidth?: number

    Sets the particle stroke width

    unbreakable: boolean

    Checks if the particle is unbreakable, if true the particle won't destroy on collisions

    velocity: Vector

    Gets particle current velocity

    zIndexFactor: number

    Gets the particle Z-Index factor

    Methods

    • Destroys the particle

      Parameters

      • Optionaloverride: boolean

      Returns void

    • Checks if the particle is inside the canvas

      Returns boolean

    • Checks if the particle is showing its back side

      Returns boolean

    • Checks if the particle is visible

      Returns boolean

    • This method is used when the particle has lost a life and needs some value resets

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods