Class GraphicsLayer

Hierarchy

GraphicsLayer

Index

Constructors

Properties

Accessors

currentKeys name offset order

Methods

Constructors

constructor

new GraphicsLayer(_options: GraphicsLayerOptions, _graphics: GraphicsComponent): GraphicsLayer
Parameters
- _options: GraphicsLayerOptions
- _graphics: GraphicsComponent
Returns GraphicsLayer
- Defined in Graphics/GraphicsComponent.ts:78

Properties

graphics

graphics: {
graphic: Graphic;
options: GraphicsShowOptions;
}[] = []

Accessors

currentKeys

get currentKeys(): string
Returns string
- Defined in Graphics/GraphicsComponent.ts:176

name

get name(): string
Returns string
- Defined in Graphics/GraphicsComponent.ts:79

offset

get offset(): Vector
Get or set the pixel offset from the layer anchor for all graphics in the layer

Returns Vector
- Defined in Graphics/GraphicsComponent.ts:168
set offset(value: Vector): void
Parameters
- value: Vector
Returns void
- Defined in Graphics/GraphicsComponent.ts:172

order

get order(): number
Current order of the layer, higher numbers are on top, lower numbers are on the bottom.

For example a layer with order = -1 would be under a layer of order = 1

Returns number
- Defined in Graphics/GraphicsComponent.ts:152
set order(order: number): void
Set the order of the layer, higher numbers are on top, lower numbers are on the bottom.

For example a layer with order = -1 would be under a layer of order = 1
Parameters
- order: number
Returns void
- Defined in Graphics/GraphicsComponent.ts:161

Methods

hide

hide(nameOrGraphic: string | Graphic): void
Remove any instance(s) of a graphic currently being shown in this layer
Parameters
- nameOrGraphic: string | Graphic
Returns void
- Defined in Graphics/GraphicsComponent.ts:86
hide(): void
Remove all currently shown graphics in this layer

Returns void
- Defined in Graphics/GraphicsComponent.ts:90

show

show<T>(nameOrGraphic: string | T, options?: GraphicsShowOptions): T
Show a graphic by name or instance at an offset, graphics are shown in the order in which show() is called.

If show() is called multiple times for the same graphic it will be shown multiple times.
Type Parameters
- T extends Graphic<T> = Graphic
Parameters
- nameOrGraphic: string | T
- Optional options: GraphicsShowOptions
Returns T
- Defined in Graphics/GraphicsComponent.ts:113

use

use<T>(nameOrGraphic: string | T, options?: GraphicsShowOptions): T
Use a specific graphic, swap out any current graphics being shown
Type Parameters
- T extends Graphic<T> = Graphic
Parameters
- nameOrGraphic: string | T
- Optional options: GraphicsShowOptions
Returns T
- Defined in Graphics/GraphicsComponent.ts:141