Class UIOption

The UIOption controls UI element layout options, possibly by overriding the default options specified in UI element style.

The class follows the 'copy-on-write' pattern, which means that every operation returns a copy of the UIOption with updates values. It also implies that the values of the UIOption cannot be directly modified.

The concept of immutability improves sharing of objects as all types in TypeScript are assigned by identity, instead of by-value (e.g. a copy) as in other programming languages like C.

Constructors

constructor

Properties

_max _min _state _type

Accessors

max min state type

Methods

assign clone isEqual fixedHeight fixedWidth flexibleHeight flexibleWidth isEqual position scalableHeight scalableWidth

Constructors

constructor

  • new UIOption(state?, min?, max?, type?): UIOption

  • Parameters

    • Optionalstate: boolean
    • Optionalmin: number
    • Optionalmax: number
    • Optionaltype: EnumValue<UIOptionType, number>

    Returns UIOption

Properties

Protected_max

_max: number

Protected_min

_min: number

Protected_state

_state: boolean

Protected_type

_type: EnumValue<UIOptionType, number>

Accessors

max

  • get max(): number

  • Returns number

  • set max(value): void

  • Parameters

    • value: number

    Returns void

min

  • get min(): number

  • Returns number

  • set min(value): void

  • Parameters

    • value: number

    Returns void

state

  • get state(): boolean

  • Returns boolean

  • set state(value): void

  • Parameters

    • value: boolean

    Returns void

type

Methods

assign

  • assign(other): UIOption

  • Copies all properties defined by the prototype of UIOption from other to this instance.

    Parameters

    Returns UIOption

clone

  • clone(): UIOption

  • Clones this instance and returns a new UIOption with identical values.

    Returns UIOption

isEqual

  • isEqual(this, other): boolean

  • Determines if this UIOption instance is equal to the other instance.

    Parameters

    Returns boolean

StaticfixedHeight

  • fixedHeight(height, scalable?): UIOption

  • Constructs a UI option notifying the UI layout that this element has a fixed height. This will override the height property set in element style.

    Parameters

    • height: number

      Height in pixels.

    • Optionalscalable: boolean

      If true, will enable the scaling. If false, will disable.

    Returns UIOption

    New option object that can be used for initializing a UI element.

StaticfixedWidth

  • fixedWidth(width, scalable?): UIOption

  • Constructs a UI option notifying the UI layout that this element has a fixed width. This will override the width property set in element style.

    Parameters

    • width: number

      Width in pixels.

    • Optionalscalable: boolean

      If true, will enable the scaling. If false, will disable.

    Returns UIOption

    New option object that can be used for initializing a UI element.

StaticflexibleHeight

  • flexibleHeight(minHeight?, maxHeight?, expandable?): UIOption

  • Constructs a UI option notifying the UI layout that this element has a flexible height with optional min/max constraints. Element will be resized according to its contents and parent layout but will always stay within the provided range.

    Parameters

    • OptionalminHeight: number

      Minimum height in pixels. Element will never be smaller than this height.

    • OptionalmaxHeight: number

      Maximum height in pixels. Element will never be larger than this height. Specify zero for unlimited height.

    • Optionalexpandable: boolean

      If set to true, the element will expand and take all the available space, similar to a Flexible Space element. By default set to false, which disable the expansion behavior.

    Returns UIOption

    New option object that can be used for initializing a UI element.

StaticflexibleWidth

  • flexibleWidth(minWidth?, maxWidth?, expandable?): UIOption

  • Constructs a UI option notifying the UI layout that this element has a flexible width with optional min/max constraints. Element will be resized according to its contents and parent layout but will always stay within the provided range.

    Parameters

    • OptionalminWidth: number

      Minimum width in pixels. Element will never be smaller than this width.

    • OptionalmaxWidth: number

      Maximum width in pixels. Element will never be larger than this width. Specify zero for unlimited width.

    • Optionalexpandable: boolean

      If set to true, the element will expand and take all the available space, similar to a Flexible Space element. By default set to false, which disable the expansion behavior.

    Returns UIOption

    New option object that can be used for initializing a UI element.

StaticisEqual

Staticposition

  • position(x, y): UIOption

  • Constructs a UI option notifying the UI layout that this element should be positioned at this offset from the parent UI panel. This option is ignored if element is part of a layout since it controls its placement.

    Parameters

    • x: number

      Horizontal offset from the parent UI panel origin, in pixels.

    • y: number

      Vertical offset from the parent UI panel origin, in pixels.

    Returns UIOption

    New option object that can be used for initializing a UI element.

StaticscalableHeight

  • scalableHeight(scalable?): UIOption

  • Constructs a UI option notifying the UI layout that this element should scale it's height with display DPI scale.

    Parameters

    • Optionalscalable: boolean

      If true, will enable the scaling. If false, will disable.

    Returns UIOption

    New option object that can be used for initializing a UI element.

StaticscalableWidth

  • scalableWidth(scalable?): UIOption

  • Constructs a UI option notifying the UI layout that this element should scale it's width with display DPI scale.

    Parameters

    • Optionalscalable: boolean

      If true, will enable the scaling. If false, will disable.

    Returns UIOption

    New option object that can be used for initializing a UI element.

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods