Class ZToggle

A two-state toggle that flips between "onState" and "offState". Mirrors the PIXI ZToggle interface.

Hierarchy (View Summary)

ZState
- ZToggle

Index

Constructors

constructor

Accessors

alpha cursor name pivotX pivotY rotation scaleX scaleY visible x y

Constructors

constructor

new ZToggle(): ZToggle
Returns ZToggle
Inherited from ZState.constructor
- Defined in ZContainer.ts:69

Properties

_fitToScreen

_fitToScreen: boolean = false

`Optional`_props

_props?: any

children

children: ZContainer[] = []

Typed child list (mirrors PIXI's children array).

currentState

currentState: ZContainer | null = null

currentTransform

currentTransform: OrientationData

`Readonly`el

el: HTMLDivElement

The root div element for this container.

`Optional`fixedBoxSize

fixedBoxSize?: boolean

interactive

interactive: boolean = false

interactiveChildren

interactiveChildren: boolean = true

landscape

landscape: OrientationData

`Optional`originalFontSize

originalFontSize?: number

`Optional`originalTextHeight

originalTextHeight?: number

`Optional`originalTextWidth

originalTextWidth?: number

parent

parent: ZContainer | null = null

portrait

portrait: OrientationData

resizeable

resizeable: boolean = true

`Readonly`scale

scale: { x: number; y: number }

PIXI-compatible scale object. Setting .x / .y delegates to the scaleX / scaleY setters so that ZScene can write stage.scale.x = s exactly as in the PIXI version.

Initialised in the constructor so this is captured correctly.

`Optional`toggleCallback

toggleCallback?: (state: boolean) => void

`Static`stageOffsetX

stageOffsetX: number = 0

Current CSS-pixel X offset of the stage from the viewport edge.

`Static`stageOffsetY

stageOffsetY: number = 0

Current CSS-pixel Y offset of the stage from the viewport edge.

`Static`stageScale

stageScale: number = 1

Current uniform CSS scale applied to the stage element.

Accessors

alpha

get alpha(): number
Returns number
Inherited from ZState.alpha
- Defined in ZContainer.ts:217
set alpha(value: number): void
Parameters
- value: number
Returns void
Inherited from ZState.alpha
- Defined in ZContainer.ts:218

cursor

get cursor(): string
Returns string
Inherited from ZState.cursor
- Defined in ZContainer.ts:525
set cursor(value: string): void
Parameters
- value: string
Returns void
Inherited from ZState.cursor
- Defined in ZContainer.ts:522

name

get name(): string
Returns string
Inherited from ZState.name
- Defined in ZContainer.ts:37
set name(value: string): void
Parameters
- value: string
Returns void
Inherited from ZState.name
- Defined in ZContainer.ts:38

pivotX

get pivotX(): number
Returns number
Inherited from ZState.pivotX
- Defined in ZContainer.ts:203
set pivotX(value: number): void
Parameters
- value: number
Returns void
Inherited from ZState.pivotX
- Defined in ZContainer.ts:204

pivotY

get pivotY(): number
Returns number
Inherited from ZState.pivotY
- Defined in ZContainer.ts:210
set pivotY(value: number): void
Parameters
- value: number
Returns void
Inherited from ZState.pivotY
- Defined in ZContainer.ts:211

rotation

get rotation(): number
Returns number
Inherited from ZState.rotation
- Defined in ZContainer.ts:181
set rotation(value: number): void
Parameters
- value: number
Returns void
Inherited from ZState.rotation
- Defined in ZContainer.ts:182

scaleX

get scaleX(): number
Returns number
Inherited from ZState.scaleX
- Defined in ZContainer.ts:189
set scaleX(value: number): void
Parameters
- value: number
Returns void
Inherited from ZState.scaleX
- Defined in ZContainer.ts:190

scaleY

get scaleY(): number
Returns number
Inherited from ZState.scaleY
- Defined in ZContainer.ts:196
set scaleY(value: number): void
Parameters
- value: number
Returns void
Inherited from ZState.scaleY
- Defined in ZContainer.ts:197

visible

get visible(): boolean
Returns boolean
Inherited from ZState.visible
- Defined in ZContainer.ts:223
set visible(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from ZState.visible
- Defined in ZContainer.ts:224

x

get x(): number
Returns number
Inherited from ZState.x
- Defined in ZContainer.ts:167
set x(value: number): void
Parameters
- value: number
Returns void
Inherited from ZState.x
- Defined in ZContainer.ts:168

y

get y(): number
Returns number
Inherited from ZState.y
- Defined in ZContainer.ts:174
set y(value: number): void
Parameters
- value: number
Returns void
Inherited from ZState.y
- Defined in ZContainer.ts:175

Methods

addChild

addChild(child: ZContainer): ZContainer
Parameters
- child: ZContainer
Returns ZContainer
Inherited from ZState.addChild
- Defined in ZContainer.ts:90

applyTransform

applyTransform(): void
Returns void
Inherited from ZState.applyTransform
- Defined in ZContainer.ts:347

disable

disable(): void
Returns void
- Defined in ZToggle.ts:56

emit

emit(event: string, ...args: any[]): void
Parameters
- event: string
- ...args: any[]
Returns void
Inherited from ZState.emit
- Defined in ZContainer.ts:556

enable

enable(): void
Returns void
- Defined in ZToggle.ts:50

executeFitToScreen

executeFitToScreen(
    viewportW: number,
    viewportH: number,
    stageOffsetX: number,
    stageOffsetY: number,
    stageScale: number,
): void
Stretches this container to visually cover the entire browser viewport. Mirrors PIXI's executeFitToScreen — positions the container at the viewport's top-left (expressed in stage / scene-unit coords) and scales the first child image element to fill the viewport dimensions.
Parameters
- viewportW: number
  Current browser viewport width in CSS pixels.
- viewportH: number
  Current browser viewport height in CSS pixels.
- stageOffsetX: number
  CSS-pixel X offset of the scaled stage from the viewport edge.
- stageOffsetY: number
  CSS-pixel Y offset of the scaled stage from the viewport edge.
- stageScale: number
  Uniform CSS scale applied to the stage.
Returns void
Inherited from ZState.executeFitToScreen
- Defined in ZContainer.ts:285

get

get(childName: string): ZContainer | null
Parameters
- childName: string
Returns ZContainer | null
Inherited from ZState.get
- Defined in ZContainer.ts:129

getAll

getAll(childName: string): ZContainer[]
Parameters
- childName: string
Returns ZContainer[]
Inherited from ZState.getAll
- Defined in ZContainer.ts:139

getAllOfType

getAllOfType(type: string): ZContainer[]
Parameters
- type: string
Returns ZContainer[]
Inherited from ZState.getAllOfType
- Defined in ZContainer.ts:150

getAllStateNames

getAllStateNames(): (string | null)[]
Returns (string | null)[]
Inherited from ZState.getAllStateNames
- Defined in ZState.ts:50

getAlpha

getAlpha(): number
Returns number
Inherited from ZState.getAlpha
- Defined in ZContainer.ts:443

getChildAt

getChildAt(index: number): ZContainer
Parameters
- index: number
Returns ZContainer
Inherited from ZState.getChildAt
- Defined in ZContainer.ts:123

getChildByName

getChildByName(name: string): ZContainer | null
Parameters
- name: string
Returns ZContainer | null
Inherited from ZState.getChildByName
- Defined in ZContainer.ts:116

getCurrentState

getCurrentState(): ZContainer | null
Returns ZContainer | null
Inherited from ZState.getCurrentState
- Defined in ZState.ts:15

getProps

getProps(): any
Returns any
Inherited from ZState.getProps
- Defined in ZContainer.ts:453

getTextField

getTextField(): HTMLElement | null
Finds the first text element (a <span class="z-text">) among children. Mirrors PIXI's getTextField().

Returns HTMLElement | null
Inherited from ZState.getTextField
- Defined in ZContainer.ts:467

getTextStyle

getTextStyle(): CSSStyleDeclaration | null
Returns CSSStyleDeclaration | null
Inherited from ZState.getTextStyle
- Defined in ZContainer.ts:492

getType

getType(): string
Returns string
Overrides ZState.getType
- Defined in ZToggle.ts:66

getVisible

getVisible(): boolean
Returns boolean
Inherited from ZState.getVisible
- Defined in ZContainer.ts:451

hasState

hasState(str: string): boolean
Parameters
- str: string
Returns boolean
Inherited from ZState.hasState
- Defined in ZState.ts:19

init

init(): void
Called once all children have been added. Captures original text dimensions.

Returns void
Overrides ZState.init
- Defined in ZToggle.ts:12

isAnchored

isAnchored(): boolean
Returns boolean
Inherited from ZState.isAnchored
- Defined in ZContainer.ts:429

isOn

isOn(): boolean
Returns boolean
- Defined in ZToggle.ts:39

off

off(event: string, listener: Function): this
Parameters
- event: string
- listener: Function
Returns this
Inherited from ZState.off
- Defined in ZContainer.ts:542

on

on(event: string, listener: Function): this
Parameters
- event: string
- listener: Function
Returns this
Inherited from ZState.on
- Defined in ZContainer.ts:535

reapplyAnchor

reapplyAnchor(): void
Public entry point for ZScene to re-run the anchor computation after all containers in the resize map have been updated to the new orientation. This guarantees that ancestor _x / _y values are current when chain inversion runs.

Returns void
Inherited from ZState.reapplyAnchor
- Defined in ZContainer.ts:375

removeAllListeners

removeAllListeners(event?: string): this
Parameters
- Optionalevent: string
Returns this
Inherited from ZState.removeAllListeners
- Defined in ZContainer.ts:547

removeCallback

removeCallback(): void
Returns void
- Defined in ZToggle.ts:29

removeChild

removeChild(child: ZContainer): ZContainer
Parameters
- child: ZContainer
Returns ZContainer
Inherited from ZState.removeChild
- Defined in ZContainer.ts:100

removeChildren

removeChildren(): void
Returns void
Inherited from ZState.removeChildren
- Defined in ZContainer.ts:112

resize

resize(
    width: number,
    height: number,
    orientation: "portrait" | "landscape",
): void
Parameters
- width: number
- height: number
- orientation: "portrait" | "landscape"
Returns void
Inherited from ZState.resize
- Defined in ZContainer.ts:424

setAlpha

setAlpha(value: number): void
Parameters
- value: number
Returns void
Inherited from ZState.setAlpha
- Defined in ZContainer.ts:437

setCallback

setCallback(func: (t: boolean) => void): void
Parameters
- func: (t: boolean) => void
Returns void
- Defined in ZToggle.ts:25

setFixedBoxSize

setFixedBoxSize(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from ZState.setFixedBoxSize
- Defined in ZContainer.ts:457

setInstanceData

setInstanceData(data: InstanceData, orientation: string): void
Parameters
- data: InstanceData
- orientation: string
Returns void
Inherited from ZState.setInstanceData
- Defined in ZContainer.ts:259

setIsClickable

setIsClickable(val: boolean): void
Parameters
- val: boolean
Returns void
- Defined in ZToggle.ts:33

setLabelOnAllStates

setLabelOnAllStates(label: string, str: string): void
Parameters
- label: string
- str: string
Returns void
- Defined in ZToggle.ts:62

setState

setState(str: string): ZContainer | null
Parameters
- str: string
Returns ZContainer | null
Inherited from ZState.setState
- Defined in ZState.ts:23

setText

setText(text: string): void
Parameters
- text: string
Returns void
Inherited from ZState.setText
- Defined in ZContainer.ts:478

setTextStyle

setTextStyle(data: Partial<CSSStyleDeclaration>): void
Parameters
- data: Partial<CSSStyleDeclaration>
Returns void
Inherited from ZState.setTextStyle
- Defined in ZContainer.ts:486

setVisible

setVisible(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from ZState.setVisible
- Defined in ZContainer.ts:445

toggle

toggle(state: boolean, sendCallback?: boolean): void
Parameters
- state: boolean
- sendCallback: boolean = true
Returns void
- Defined in ZToggle.ts:43

Class ZToggle

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns ZToggle

Properties

_fitToScreen

Optional_props

children

currentState

currentTransform

Readonlyel

OptionalfixedBoxSize

interactive

interactiveChildren

landscape

OptionaloriginalFontSize

OptionaloriginalTextHeight

OptionaloriginalTextWidth

parent

portrait

resizeable

Readonlyscale

OptionaltoggleCallback

StaticstageOffsetX

StaticstageOffsetY

StaticstageScale

Accessors

alpha

Returns number

Parameters

Returns void

cursor

Returns string

Parameters

Returns void

name

Returns string

Parameters

Returns void

pivotX

Returns number

Parameters

Returns void

pivotY

Returns number

Parameters

Returns void

rotation

Returns number

Parameters

Returns void

scaleX

Returns number

Parameters

Returns void

scaleY

Returns number

Parameters

Returns void

visible

Returns boolean

Parameters

Returns void

x

Returns number

Parameters

Returns void

y

Returns number

Parameters

Returns void

Methods

addChild

Parameters

`Optional`_props

`Readonly`el

`Optional`fixedBoxSize

`Optional`originalFontSize

`Optional`originalTextHeight

`Optional`originalTextWidth

`Readonly`scale

`Optional`toggleCallback

`Static`stageOffsetX

`Static`stageOffsetY

`Static`stageScale