Region
Defined in: src/geometry/region.ts:5
An immutable rectangle (offset + size) in cell coordinates — a widget’s region.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Region(
offset,size):Region
Defined in: src/geometry/region.ts:6
Parameters
Section titled “Parameters”offset
Section titled “offset”Top-left corner.
Width × height.
Returns
Section titled “Returns”Region
Properties
Section titled “Properties”offset
Section titled “offset”
readonlyoffset:Offset
Defined in: src/geometry/region.ts:8
Top-left corner.
readonlysize:Size
Defined in: src/geometry/region.ts:10
Width × height.
readonlystaticEMPTY:Region
Defined in: src/geometry/region.ts:14
An empty region at the origin.
Accessors
Section titled “Accessors”bottom
Section titled “bottom”Get Signature
Section titled “Get Signature”get bottom():
number
Defined in: src/geometry/region.ts:38
One past the bottom edge (y + height).
Returns
Section titled “Returns”number
height
Section titled “height”Get Signature
Section titled “Get Signature”get height():
number
Defined in: src/geometry/region.ts:29
Height in cells.
Returns
Section titled “Returns”number
Get Signature
Section titled “Get Signature”get right():
number
Defined in: src/geometry/region.ts:34
One past the right edge (x + width).
Returns
Section titled “Returns”number
Get Signature
Section titled “Get Signature”get width():
number
Defined in: src/geometry/region.ts:25
Width in cells.
Returns
Section titled “Returns”number
Get Signature
Section titled “Get Signature”get x():
number
Defined in: src/geometry/region.ts:17
Left edge (column).
Returns
Section titled “Returns”number
Get Signature
Section titled “Get Signature”get y():
number
Defined in: src/geometry/region.ts:21
Top edge (row).
Returns
Section titled “Returns”number
Methods
Section titled “Methods”clone()
Section titled “clone()”clone():
Region
Defined in: src/geometry/region.ts:96
A copy of this region.
Returns
Section titled “Returns”Region
contains()
Section titled “contains()”Call Signature
Section titled “Call Signature”contains(
x,y):boolean
Defined in: src/geometry/region.ts:43
True if the point lies inside this region (right/bottom edges exclusive).
Parameters
Section titled “Parameters”number
number
Returns
Section titled “Returns”boolean
Call Signature
Section titled “Call Signature”contains(
offset):boolean
Defined in: src/geometry/region.ts:44
True if the point lies inside this region (right/bottom edges exclusive).
Parameters
Section titled “Parameters”offset
Section titled “offset”Returns
Section titled “Returns”boolean
containsRegion()
Section titled “containsRegion()”containsRegion(
other):boolean
Defined in: src/geometry/region.ts:56
True if other lies entirely within this region.
Parameters
Section titled “Parameters”Region
Returns
Section titled “Returns”boolean
equals()
Section titled “equals()”equals(
other):boolean
Defined in: src/geometry/region.ts:91
True if offset and size both match.
Parameters
Section titled “Parameters”Region
Returns
Section titled “Returns”boolean
intersection()
Section titled “intersection()”intersection(
other):Region|null
Defined in: src/geometry/region.ts:78
The overlapping region, or null if they don’t overlap.
Parameters
Section titled “Parameters”Region
Returns
Section titled “Returns”Region | null
overlaps()
Section titled “overlaps()”overlaps(
other):boolean
Defined in: src/geometry/region.ts:70
True when the two regions overlap. A non-allocating predicate for hot paths (e.g. per-child clip culling each frame) that only need a yes/no, not the intersection rectangle itself.
Parameters
Section titled “Parameters”Region
Returns
Section titled “Returns”boolean
toString()
Section titled “toString()”toString():
string
Defined in: src/geometry/region.ts:101
"(x,y WxH)".
Returns
Section titled “Returns”string