UICanvas

Defined in: ui/UICanvas.ts:67

Extends

• _UICanvas

Type Parameters

T

T extends Application = Application

Constructors

Constructor

new UICanvas<T>(config): UICanvas<T>

Defined in: ui/UICanvas.ts:82

Parameters

config

Partial<UICanvasProps>

Returns

UICanvas<T>

Overrides

_UICanvas.constructor

Properties

add

add: object

Defined in: mixins/factory/Factory.ts:6

animatedSprite()

animatedSprite: (props?) => AnimatedSprite

Parameters

props?

Partial<AnimatedSpriteProps>

Returns

AnimatedSprite

bitmapText()

bitmapText: (props?) => BitmapText

Parameters

props?

Partial<TextProps>

Returns

BitmapText

button()

button: (props?) => Button

Parameters

props?

Partial<ButtonProps>

Returns

Button

container()

container: (props?) => Container<Application<DataSchema, ActionContext, Action, Renderer>>

Parameters

props?

Partial<ContainerProps>

Returns

Container<Application<DataSchema, ActionContext, Action, Renderer>>

existing()

existing: <TEntity>(entity, props?) => TEntity

Type Parameters

TEntity

TEntity

Parameters

entity

TEntity

props?

Partial<ExistingProps>

Returns

TEntity

flexContainer()

flexContainer: (props?) => FlexContainer

Parameters

props?

Partial<FlexContainerProps>

Returns

FlexContainer

graphics()

graphics: (props?) => Graphics

Parameters

props?

Partial<GraphicsProps>

Returns

Graphics

htmlText()

htmlText: (props?) => HTMLText

Parameters

props?

Partial<HTMLTextProps>

Returns

HTMLText

particleContainer()

particleContainer: (props?) => ParticleContainer<Application<DataSchema, ActionContext, Action, Renderer>>

Parameters

props?

Partial<ParticleContainerProps>

Returns

ParticleContainer<Application<DataSchema, ActionContext, Action, Renderer>>

spine()

spine: (props?) => Spine

Parameters

props?

Partial<SpineProps>

Returns

Spine

spineAnimation()

spineAnimation: <ANames, A>(props?) => SpineAnimation<ANames, A>

Type Parameters

ANames

ANames extends string = string

A

A extends Application<DataSchema, ActionContext, Action, Renderer> = Application<DataSchema, ActionContext, Action, Renderer>

Parameters

props?

Partial<SpineProps>

Returns

SpineAnimation<ANames, A>

sprite()

sprite: (props?) => Sprite

Parameters

props?

Partial<SpriteProps>

Returns

Sprite

text()

text: (props?) => Text

Parameters

props?

Partial<TextProps>

Returns

Text

texture()

texture: (props?) => Texture = resolveTexture

Parameters

props?

Partial<TextureProps>

Returns

Texture

tilingSprite()

tilingSprite: (props?) => TilingSprite

Parameters

props?

Partial<TilingSpriteProps>

Returns

TilingSprite

toaster()

toaster: (toasterConfig?, defaultToastConfig) => Toaster

Parameters

toasterConfig?

Partial<ToasterConfig>

defaultToastConfig?

Partial<ToastConfig> = {}

Returns

Toaster

uiCanvas()

uiCanvas: (props?) => UICanvas

Parameters

props?

Partial<UICanvasFactoryProps>

Returns

UICanvas

svg()

svg(props): Svg

Parameters

props

WithRequiredProps<SvgProps, "ctx">

Returns

Svg

Inherited from

_UICanvas.add

---

bottomRow

bottomRow: FlexContainer

Defined in: ui/UICanvas.ts:80

---

config

config: UICanvasConfig

Defined in: ui/UICanvas.ts:68

---

make

make: object

Defined in: mixins/factory/Factory.ts:7

animatedSprite()

animatedSprite: (props?) => AnimatedSprite

Parameters

props?

Partial<AnimatedSpriteProps>

Returns

AnimatedSprite

bitmapText()

bitmapText: (props?) => BitmapText

Parameters

props?

Partial<TextProps>

Returns

BitmapText

button()

button: (props?) => Button

Parameters

props?

Partial<ButtonProps>

Returns

Button

container()

container: (props?) => Container<Application<DataSchema, ActionContext, Action, Renderer>>

Parameters

props?

Partial<ContainerProps>

Returns

Container<Application<DataSchema, ActionContext, Action, Renderer>>

existing()

existing: <TEntity>(entity, props?) => TEntity

Type Parameters

TEntity

TEntity

Parameters

entity

TEntity

props?

Partial<ExistingProps>

Returns

TEntity

flexContainer()

flexContainer: (props?) => FlexContainer

Parameters

props?

Partial<FlexContainerProps>

Returns

FlexContainer

graphics()

graphics: (props?) => Graphics

Parameters

props?

Partial<GraphicsProps>

Returns

Graphics

htmlText()

htmlText: (props?) => HTMLText

Parameters

props?

Partial<HTMLTextProps>

Returns

HTMLText

particleContainer()

particleContainer: (props?) => ParticleContainer<Application<DataSchema, ActionContext, Action, Renderer>>

Parameters

props?

Partial<ParticleContainerProps>

Returns

ParticleContainer<Application<DataSchema, ActionContext, Action, Renderer>>

spine()

spine: (props?) => Spine

Parameters

props?

Partial<SpineProps>

Returns

Spine

spineAnimation()

spineAnimation: <ANames, A>(props?) => SpineAnimation<ANames, A>

Type Parameters

ANames

ANames extends string = string

A

A extends Application<DataSchema, ActionContext, Action, Renderer> = Application<DataSchema, ActionContext, Action, Renderer>

Parameters

props?

Partial<SpineProps>

Returns

SpineAnimation<ANames, A>

sprite()

sprite: (props?) => Sprite

Parameters

props?

Partial<SpriteProps>

Returns

Sprite

text()

text: (props?) => Text

Parameters

props?

Partial<TextProps>

Returns

Text

texture()

texture: (props?) => Texture = resolveTexture

Parameters

props?

Partial<TextureProps>

Returns

Texture

tilingSprite()

tilingSprite: (props?) => TilingSprite

Parameters

props?

Partial<TilingSpriteProps>

Returns

TilingSprite

toaster()

toaster: (toasterConfig?, defaultToastConfig) => Toaster

Parameters

toasterConfig?

Partial<ToasterConfig>

defaultToastConfig?

Partial<ToastConfig> = {}

Returns

Toaster

uiCanvas()

uiCanvas: (props?) => UICanvas

Parameters

props?

Partial<UICanvasFactoryProps>

Returns

UICanvas

svg()

svg(props): Svg

Parameters

props

WithRequiredProps<SvgProps, "ctx">

Returns

Svg

Inherited from

_UICanvas.make

---

middleRow

middleRow: FlexContainer

Defined in: ui/UICanvas.ts:79

---

signalConnections

signalConnections: SignalConnections

Defined in: mixins/signals.ts:9

Inherited from

_UICanvas.signalConnections

---

topRow

topRow: FlexContainer

Defined in: ui/UICanvas.ts:78

Accessors

app

Get Signature

get app(): T

Defined in: ui/UICanvas.ts:318

Get the application instance.

Returns

T

---

canvasChildren

Get Signature

get canvasChildren(): Container<ContainerChild>[]

Defined in: ui/UICanvas.ts:311

Returns

Container<ContainerChild>[]

---

padding

Set Signature

set padding(value): void

Defined in: ui/UICanvas.ts:350

Parameters

value

PointLike | Partial<Padding>

Returns

void

---

size

Set Signature

set size(value): void

Defined in: ui/UICanvas.ts:342

Parameters

value

SizeLike

Returns

void

Methods

addChild()

addChild<U>(…children): U[0]

Defined in: ui/UICanvas.ts:413

Adds one or more children to the container. The children will be rendered as part of this container’s display list.

Type Parameters

U

U extends (ContainerChild | IRenderLayer)[]

Parameters

children

…U

The Container(s) to add to the container

Returns

U[0]

The first child that was added

Example

// Add a single child
container.addChild(sprite);

// Add multiple children
container.addChild(background, player, foreground);

// Add with type checking
const sprite = container.addChild<Sprite>(new Sprite(texture));
sprite.tint = 'red';

See

• Container#removeChild For removing children
• Container#addChildAt For adding at specific index

Overrides

_UICanvas.addChild

---

addChildAt()

addChildAt<U>(child, index): U

Defined in: ui/UICanvas.ts:383

Adds a child to the container at the specified index

Type Parameters

U

U extends Container<ContainerChild> | IRenderLayer

Parameters

child

U

index

number

Returns

U

Overrides

_UICanvas.addChildAt

---

addElement()

addElement<U>(child, settings?): U

Defined in: ui/UICanvas.ts:470

Type Parameters

U

U extends Container<ContainerChild> = Container<ContainerChild>

Parameters

child

Container

settings?

Partial<UICanvasChildProps>

Returns

U

---

addSignalConnection()

addSignalConnection(…args): void

Defined in: mixins/signals.ts:13

Parameters

args

…SignalConnection[]

Returns

void

Inherited from

_UICanvas.addSignalConnection

---

connectAction()

connectAction(…args): void

Defined in: mixins/signals.ts:15

Parameters

args

…SignalConnection[]

Returns

void

Inherited from

_UICanvas.connectAction

---

connectSignal()

connectSignal(…args): void

Defined in: mixins/signals.ts:14

Parameters

args

…SignalConnection[]

Returns

void

Inherited from

_UICanvas.connectSignal

---

destroy()

destroy(): void

Defined in: ui/UICanvas.ts:322

Removes all internal references and listeners as well as removes children from the display list. Do not use a Container after calling destroy.

Returns

void

Example

container.destroy();
container.destroy(true);
container.destroy({ children: true });
container.destroy({ children: true, texture: true, textureSource: true });

Overrides

_UICanvas.destroy

---

getChildAt()

getChildAt<U>(index): U

Defined in: ui/UICanvas.ts:409

Gets the child at the specified index

Type Parameters

U

U extends Container<ContainerChild> | IRenderLayer

Parameters

index

number

Returns

U

Overrides

_UICanvas.getChildAt

---

getChildIndex()

getChildIndex<U>(child): number

Defined in: ui/UICanvas.ts:402

Gets the index of a child in the container

Type Parameters

U

U extends Container<ContainerChild>

Parameters

child

U

Returns

number

Overrides

_UICanvas.getChildIndex

---

removeChild()

removeChild(…children): Container

Defined in: ui/UICanvas.ts:428

Removes one or more children from the container

Parameters

children

…(Container<ContainerChild> | IRenderLayer)[]

Returns

Container

Overrides

_UICanvas.removeChild

---

removeChildAt()

removeChildAt<U>(index): U

Defined in: ui/UICanvas.ts:376

Removes a child from the container at the specified index

Type Parameters

U

U extends Container<ContainerChild> | IRenderLayer

Parameters

index

number

Returns

U

Overrides

_UICanvas.removeChildAt

---

removeChildren()

removeChildren(beginIndex?, endIndex?): Container<ContainerChild>[]

Defined in: ui/UICanvas.ts:369

Removes all the children from the container

Parameters

beginIndex?

number

endIndex?

number

Returns

Container<ContainerChild>[]

Overrides

_UICanvas.removeChildren

---

resize()

resize(): void

Defined in: ui/UICanvas.ts:443

Returns

void

---

setChildIndex()

setChildIndex<U>(child, index): void

Defined in: ui/UICanvas.ts:394

Sets the index of the child in the container

Type Parameters

U

U extends Container<ContainerChild>

Parameters

child

U

index

number

Returns

void

Overrides

_UICanvas.setChildIndex

---

updateLayout()

updateLayout(): void

Defined in: ui/UICanvas.ts:454

Returns

void