@pixi/marquee-selection

Class: MarqueeSelection

MarqueeSelection

Marching Ants is a UI component commonly used to indicate a selection area. It is a dashed line.

new MarqueeSelection (options)

Name Type Description
options MarqueeSelectionOptions

The options for the marching ants.
See:

Extends

  • Container

Members

autoUpdate boolean

Whether to use Ticker.shared to auto update animation time.

dash number readonly

The color of the line, set by constructor options

dashSpace number readonly

The space between dashes, set by constructor options

speed number readonly

The speed of the animation, set by constructor options

thickness number readonly

The thickness of the line, set by constructor options

_autoUpdate boolean protected

true uses Ticker.shared to auto update animation time.

Default Value:
  • true

_bottomLine TilingSprite protected

Used for the bottom line

_currentTime number protected

The current time of the animation

Default Value:
  • 0

_leftLine TilingSprite protected

Used for the left line

_rightLine TilingSprite protected

Used for the right line

_texture Texture protected

The texture used for the lines

_topLine TilingSprite protected

Used for the top line

Methods

destroy ()

Destroy the marching ants, don't use after calling this.

resize (width, height)

Resize the dimensions

Name Type Description
width number

The width of the marching ants box
height number

The height of the marching ants box

update ()

Update the marching ants animation. This is called automatically if autoUpdate is true (default). If you'd like to tick this manually set autoUpdate to false and call this method manually.