Class RectOffset

The RectOffset implements a rectangle represented in the form of integer (pixel) offsets from a parent rectangle. The class follows the 'copy-on-write' pattern, which means that mutable operations return a copy of the object with updates values. It also implies that the values of the object 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

  • Parameters

    • Optionalleft: number
    • Optionalright: number
    • Optionaltop: number
    • Optionalbottom: number

    Returns RectOffset

Properties

_bottom: number
_left: number
_right: number
_top: number

Accessors

  • get bottom(): number
  • Returns number

  • set bottom(value): void
  • Parameters

    • value: number

    Returns void

  • get horizontal(): number
  • The total horizontal offset.

    Returns number

  • get left(): number
  • Returns number

  • set left(value): void
  • Parameters

    • value: number

    Returns void

  • get right(): number
  • Returns number

  • set right(value): void
  • Parameters

    • value: number

    Returns void

  • get top(): number
  • Returns number

  • set top(value): void
  • Parameters

    • value: number

    Returns void

  • get vertical(): number
  • The total vertical offset.

    Returns number

Methods

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

    Parameters

    Returns RectOffset

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

    Returns RectOffset

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

    Parameters

    Returns boolean

  • Creates a rect offset with a uniform offset.

    Parameters

    • offset: number

    Returns RectOffset