RegionApi

Imperative handle for drawing interactive regions on a bare paper, independent of <Selection>. Returned by useRegion. Each method draws a region and resolves to its raw geometry: no cells are selected.

Properties

startPolygonRegion

readonly startPolygonRegion: (options?) => Promise<Polygon | null>;

Draw an interactive polygon and resolve to its g.Polygon (or null if cancelled).

Parameters

Parameter	Type
options?	StartPolygonRegionOptions

Returns

Promise<Polygon | null>

---

startRangeRegion

readonly startRangeRegion: (options?) => Promise<Range | null>;

Draw an interactive 1D range and resolve to its [start, end] span (or null if cancelled).

Parameters

Parameter	Type
options?	StartRangeRegionOptions

Returns

Promise<Range | null>

---

startRectangleRegion

readonly startRectangleRegion: (options?) => Promise<Rect | null>;

Draw an interactive rectangle and resolve to its g.Rect (or null if cancelled).

Parameters

Parameter	Type
options?	StartRectangleRegionOptions

Returns

Promise<Rect | null>