Class ValueAndUnit

constructor

• new ValueAndUnit(
      value: number,
      unit?: number,
      negativeValueAllowed?: boolean,
  ): ValueAndUnit

  Creates a new ValueAndUnit

  Parameters

  • value: number

    defines the value to store

  • unit: number = ValueAndUnit.UNITMODE_PIXEL

    defines the unit to store - defaults to ValueAndUnit.UNITMODE_PIXEL

  • negativeValueAllowed: boolean = true

    defines a boolean indicating if the value can be negative

  Returns ValueAndUnit

ignoreAdaptiveScaling

negativeValueAllowed

onChangedObservable

Static ReadonlyUNITMODE_EM

Static ReadonlyUNITMODE_REM

internalValue

• get internalValue(): number

  Gets value (without units)

  Returns number

  Deprecated

  use value property instead

isPercentage

• get isPercentage(): boolean

  Gets a boolean indicating if the value is a percentage

  Returns boolean

isPixel

• get isPixel(): boolean

  Gets a boolean indicating if the value is store as pixel

  Returns boolean

unit

• get unit(): number

  Gets units (without value)

  Returns number

• set unit(value: number): void

  Sets units (without value)

  Parameters

  • value: number

  Returns void

value

• get value(): number

  Gets value (without units)

  Returns number

• set value(value: number): void

  Sets value (without units)

  Parameters

  • value: number

  Returns void

StaticUNITMODE_PERCENTAGE

• get UNITMODE_PERCENTAGE(): number

  UNITMODE_PERCENTAGE

  Returns number

StaticUNITMODE_PIXEL

• get UNITMODE_PIXEL(): number

  UNITMODE_PIXEL

  Returns number

fromString

• fromString(source: string | number): boolean

  Store a value parsed from a string

  Parameters

  • source: string | number

    defines the source string

  Returns boolean

  true if the value was successfully parsed and updated

getValue

• getValue(
      host: AdvancedDynamicTexture,
      fontSize?: number,
      rootFontSize?: number,
  ): number

  Gets the value accordingly to its unit

  Parameters

  • host: AdvancedDynamicTexture

    defines the root host

  • OptionalfontSize: number

    defines the computed font size in pixels for em units

  • OptionalrootFontSize: number

    defines the computed root font size in pixels for rem units

  Returns number

  the value

getValueInPixel

• getValueInPixel(
      host: AdvancedDynamicTexture,
      refValue: number,
      fontSize?: number,
      rootFontSize?: number,
  ): number

  Gets value as pixel

  Parameters

  • host: AdvancedDynamicTexture

    defines the root host

  • refValue: number

    defines the reference value for percentages

  • OptionalfontSize: number

    defines the computed font size in pixels for em units

  • OptionalrootFontSize: number

    defines the computed root font size in pixels for rem units

  Returns number

  the value as pixel

toString

• toString(host: AdvancedDynamicTexture, decimals?: number): string

  Gets a string representation of the value

  Parameters

  • host: AdvancedDynamicTexture

    defines the root host

  • Optionaldecimals: number

    defines an optional number of decimals to display

  Returns string

  a string

updateInPlace

• updateInPlace(value: number, unit?: number): ValueAndUnit

  Update the current value and unit.

  Parameters

  • value: number

    defines the value to store

  • unit: number = ValueAndUnit.UNITMODE_PIXEL

    defines the unit to store

  Returns ValueAndUnit

  the current ValueAndUnit