Class EdgeInsets

Index

Constructors

Methods

clone compare get update updateFrom

Constructors

constructor

new EdgeInsets(
    top?: number,
    left?: number,
    bottom?: number,
    right?: number,
): EdgeInsets
simple data class containing edge insets for a region
Parameters
- Optionaltop: number
  inset for the top edge
- Optionalleft: number
  inset for the left edge
- Optionalbottom: number
  inset for the bottom edge
- Optionalright: number
  inset for the right edge
Returns EdgeInsets

Methods

clone

clone(): EdgeInsets
clone the object

Returns EdgeInsets

compare

compare(insets: null | EdgeInsets): boolean
compares this object to another instance
Parameters
- insets: null | EdgeInsets
Returns boolean

get

get(value: "right" | "top" | "left" | "bottom"): number
returns value of requested config option
Parameters
- value: "right" | "top" | "left" | "bottom"
Returns number

update

update(top: number, left: number, bottom: number, right: number): boolean
update the insets returns true if the insets changed, false if no update was required
Parameters
- top: number
  inset for the top edge
- left: number
  inset for the left edge
- bottom: number
  inset for the bottom edge
- right: number
  inset for the right edge
Returns boolean

updateFrom

updateFrom(insets: EdgeInsets): boolean
update the insets by copying from another insets objects returns true if the insets changed, false if no update was required
Parameters
- insets: EdgeInsets
Returns boolean