Options
All
  • Public
  • Public/Protected
  • All
Menu

Class YogaLayout

Hierarchy

  • YogaLayout

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private _aspectRatio

_aspectRatio: number

Used instead of Yoga.AspectRatio because of Yoga issue https://github.com/facebook/yoga/issues/677

Private _cachedLayout

_cachedLayout: ComputedLayout | undefined

Private _height

_height: YogaSize

Private _lastRecalculationDuration

_lastRecalculationDuration: number = 0

Private _needUpdateAsRoot

_needUpdateAsRoot: boolean = false

Will be recalculated in next frame

Private _width

_width: YogaSize

children

children: YogaLayout[] = []

node

node: Yoga.YogaNode

Optional parent

parent: YogaLayout

rescaleToYoga

rescaleToYoga: boolean = false

True if Yoga should manage PIXI objects width/height

target

target: DisplayObject

Static LAYOUT_UPDATED_EVENT

LAYOUT_UPDATED_EVENT: "LAYOUT_UPDATED_EVENT" = "LAYOUT_UPDATED_EVENT"

Static NEED_LAYOUT_UPDATE

NEED_LAYOUT_UPDATE: "NEED_LAYOUT_UPDATE" = "NEED_LAYOUT_UPDATE"

Static roots

roots: Map<string, YogaLayout> = new Map()

Experimental feature for building layouts independent of pixi tree

Accessors

alignContent

  • get alignContent(): keyof typeof Align
  • set alignContent(align: keyof typeof Align): void

alignItems

  • get alignItems(): keyof typeof Align
  • set alignItems(align: keyof typeof Align): void

alignSelf

  • get alignSelf(): keyof typeof Align
  • set alignSelf(align: keyof typeof Align): void

aspectRatio

  • get aspectRatio(): number
  • set aspectRatio(value: number): void

border

  • get border(): number[]
  • set border(margin: number[]): void

borderAll

  • set borderAll(value: number): void

borderBottom

  • get borderBottom(): number
  • set borderBottom(value: number): void

borderLeft

  • set borderLeft(value: number): void

borderRight

  • get borderRight(): number
  • set borderRight(value: number): void

borderTop

  • get borderTop(): number
  • set borderTop(value: number): void

bordereft

  • get bordereft(): number

bottom

calculatedHeight

  • get calculatedHeight(): number

calculatedWidth

  • get calculatedWidth(): number

computedLayout

config

display

  • get display(): keyof typeof Display
  • set display(value: keyof typeof Display): void

flexBasis

  • get flexBasis(): number
  • set flexBasis(basis: number): void

flexDirection

flexGrow

  • get flexGrow(): number
  • set flexGrow(grow: number): void

flexShrink

  • get flexShrink(): number
  • set flexShrink(shrink: number): void

flexWrap

  • get flexWrap(): keyof typeof FlexWrap
  • set flexWrap(wrap: keyof typeof FlexWrap): void

hasContantDeclaredSize

  • get hasContantDeclaredSize(): boolean

  • Returns true if object size is independent of its children sizes.

    Returns boolean

height

  • Can handle:

    • pixels (eg 150)
    • percents ("50%")
    • "auto" to use values from yoga
    • "pixi" to use DisplayObject.width/height

    Returns YogaSize

  • Can handle:

    • pixels (eg 150)
    • percents ("50%")
    • "auto" to use values from yoga
    • "pixi" to use DisplayObject.width/height

    Parameters

    Returns void

isHeightCalculatedFromPixi

  • get isHeightCalculatedFromPixi(): boolean

isRoot

  • get isRoot(): boolean

isWidthCalculatedFromPixi

  • get isWidthCalculatedFromPixi(): boolean

justifyContent

left

margin

  • get margin(): number[]
  • set margin(margin: number[]): void

marginAll

  • set marginAll(value: number): void

marginBottom

  • get marginBottom(): number
  • set marginBottom(value: number): void

marginLeft

  • get marginLeft(): number
  • set marginLeft(value: number): void

marginRight

  • get marginRight(): number
  • set marginRight(value: number): void

marginTop

  • get marginTop(): number
  • set marginTop(value: number): void

maxHeight

maxWidth

minHeight

minWidth

padding

  • get padding(): number[]
  • set padding(margin: number[]): void

paddingAll

  • set paddingAll(value: number): void

paddingBottom

  • get paddingBottom(): number
  • set paddingBottom(value: number): void

paddingLeft

  • get paddingLeft(): number
  • set paddingLeft(value: number): void

paddingRight

  • get paddingRight(): number
  • set paddingRight(value: number): void

paddingTop

  • get paddingTop(): number
  • set paddingTop(value: number): void

position

right

root

  • set root(val: string): void

top

width

  • Can handle:

    • pixels (eg 150)
    • percents ("50%")
    • "auto" to use values from yoga
    • "pixi" to use DisplayObject.width/height

    Returns YogaSize

  • Can handle:

    • pixels (eg 150)
    • percents ("50%")
    • "auto" to use values from yoga
    • "pixi" to use DisplayObject.width/height

    Parameters

    Returns void

Methods

Private _parseValue

addChild

copy

  • Copies all properties (styles, size, rescaleToYoga etc) from other YogaLayout objects

    Parameters

    Returns void

fillDefaults

  • fillDefaults(): void

fromConfig

recalculateLayout

  • recalculateLayout(): void

removeChild

requestLayoutUpdate

  • requestLayoutUpdate(): void

  • Mark object as dirty and request layout recalculation

    Returns void

update

  • update(): void

Generated using TypeDoc