Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UIGrid

Hierarchy

Index

Constructors

constructor

Properties

Readonly entity

entity: Entity2D

Readonly id

id: number = ...

Readonly isDestroyed

isDestroyed: boolean = false

Readonly isDestroying

isDestroying: boolean = false

Readonly priority

priority: number = ...

Static Arrangement

Arrangement: Readonly<typeof Arrangement> = ...

列表方向枚举值

static
memberof

UIGrid

Static Priority

Priority: { Align: number; Layout: number; Low: number; Physics: number; Render: number; Tool: number } = ...

Type declaration

  • Align: number
  • Layout: number
  • Low: number
  • Physics: number
  • Render: number
  • Tool: number

Static Optional Serialize

Serialize: (...args: any[]) => any

Type declaration

    • (...args: any[]): any
    • Parameters

      • Rest ...args: any[]

      Returns any

Accessors

active

  • get active(): boolean
  • set active(value: boolean): void
  • Returns boolean

  • Parameters

    • value: boolean

    Returns void

activeInHierarchy

  • get activeInHierarchy(): boolean
  • 在场景树中是否active

    readonly
    memberof

    Component

    Returns boolean

arrangement

  • get arrangement(): Arrangement
  • set arrangement(val: Arrangement): void
  • Arrangement类型,列表布局方向。

    memberof

    UIGrid

    Returns Arrangement

  • Arrangement类型,列表布局方向。

    Parameters

    • val: Arrangement

    Returns void

autoSize

  • get autoSize(): boolean
  • set autoSize(val: boolean): void
  • 默认值为false,是否开启动态尺寸布局,取每个行列取最大的元素,作为当前行列cell的大小进行布局。

    memberof

    UIGrid

    Returns boolean

  • 默认值为false,是否开启动态尺寸布局,取每个行列取最大的元素,作为当前行列cell的大小进行布局。

    Parameters

    • val: boolean

    Returns void

cellAlignmentX

  • get cellAlignmentX(): number
  • set cellAlignmentX(val: number): void
  • 动态尺寸布局使用,默认值为0.5,代表居中,取值范围(0-1),决定每列所有单元格内部的水平方向对齐规则。

    memberof

    UIGrid

    Returns number

  • 动态尺寸布局使用,默认值为0.5,代表居中,取值范围(0-1),决定每列所有单元格内部的水平方向对齐规则。

    Parameters

    • val: number

    Returns void

cellAlignmentY

  • get cellAlignmentY(): number
  • set cellAlignmentY(val: number): void
  • 动态尺寸布局使用,默认值为0.5,代表居中,取值范围(0-1),决定每行所有单元格内部的垂直方向对齐规则。

    memberof

    UIGrid

    Returns number

  • 动态尺寸布局使用,默认值为0.5,代表居中,取值范围(0-1),决定每行所有单元格内部的垂直方向对齐规则。

    Parameters

    • val: number

    Returns void

cellHeight

  • get cellHeight(): number
  • set cellHeight(val: number): void
  • 固定尺寸布局使用,每个cell的高度。

    memberof

    UIGrid

    Returns number

  • 固定尺寸布局使用,每个cell的高度。

    Parameters

    • val: number

    Returns void

cellWidth

  • get cellWidth(): number
  • set cellWidth(val: number): void
  • 固定尺寸布局使用,每个cell的宽度。

    memberof

    UIGrid

    Returns number

  • 固定尺寸布局使用,每个cell的宽度。

    Parameters

    • val: number

    Returns void

columns

  • get columns(): number
  • set columns(val: number): void
  • 当前布局方向下的列数,若为0,则以子元素数量作为列数。固定尺寸布局下,列垂直于当前主方向;动态尺寸布局,列平行于的主方向。

    memberof

    UIGrid

    Returns number

  • 当前布局方向下的列数,若为0,则以子元素数量作为列数。固定尺寸布局下,列垂直于当前主方向;动态尺寸布局,列平行于的主方向。

    Parameters

    • val: number

    Returns void

paddingX

  • get paddingX(): number
  • set paddingX(val: number): void
  • 动态尺寸布局使用,默认值为0,每个cell之间的距离水平方向的距离。

    memberof

    UIGrid

    Returns number

  • 动态尺寸布局使用,默认值为0,每个cell之间的距离水平方向的距离。

    Parameters

    • val: number

    Returns void

paddingY

  • get paddingY(): number
  • set paddingY(val: number): void
  • 动态尺寸布局使用,默认值为0,每个cell之间的距离垂直方向的距离。

    memberof

    UIGrid

    Returns number

  • 动态尺寸布局使用,默认值为0,每个cell之间的距离垂直方向的距离。

    Parameters

    • val: number

    Returns void

Methods

destroy

  • destroy(): void
  • Returns void

getTypeName

  • getTypeName(): string

isDetached

  • isDetached(): boolean
  • Returns boolean

resetContext

  • resetContext(): void
  • 立即重新进行一次UIGrid的布局

    memberof

    UIGrid

    Returns void

resetProperties

  • resetProperties(): void

setResetFlag

  • setResetFlag(): void
  • 更新置脏(默认将在Update阶段更新)。

    memberof

    UIGrid

    Returns void

Generated using TypeDoc