Interface: CanvasMetrics

Defined in: src/paper/paperApi.ts:9

Represents canvas viewport size and transformation.

Allows to convert between different canvas coordinate types.

Properties

Property	Modifier	Type	Description
area	readonly	CanvasPaneMetrics	Sizes and offsets for the canvas area DOM element. Deprecated Use CanvasMetrics.pane instead.
pane	readonly	CanvasPaneMetrics	Sizes and offsets for the canvas area DOM element.
transform	readonly	PaperTransform	Gets transformation data between paper and scrollable pane coordinates.

Methods

clientToPaperCoords()

clientToPaperCoords(areaClientX, areaClientY): Vector

Defined in: src/paper/paperApi.ts:54

Translates client (viewport) to paper coordinates.

Parameters

Parameter	Type
areaClientX	number
areaClientY	number

Returns

Vector

---

clientToScrollablePaneCoords()

clientToScrollablePaneCoords(areaClientX, areaClientY): Vector

Defined in: src/paper/paperApi.ts:58

Translates client (viewport) to scrollable pane coordinates.

Parameters

Parameter	Type
areaClientX	number
areaClientY	number

Returns

Vector

---

getPaperSize()

getPaperSize(): Size

Defined in: src/paper/paperApi.ts:38

Returns paper size in paper coordinates.

Returns

Size

---

getTransform()

getTransform(): PaperTransform

Defined in: src/paper/paperApi.ts:29

Returns transformation data between paper and scrollable pane coordinates.

Returns

PaperTransform

Deprecated

Use CanvasMetrics.transform instead.

---

getViewportPageRect()

getViewportPageRect(): Rect

Defined in: src/paper/paperApi.ts:42

Returns viewport bounds in page coordinates.

Returns

Rect

---

pageToPaperCoords()

pageToPaperCoords(pageX, pageY): Vector

Defined in: src/paper/paperApi.ts:46

Translates page to paper coordinates.

Parameters

Parameter	Type
pageX	number
pageY	number

Returns

Vector

---

paperToPageCoords()

paperToPageCoords(paperX, paperY): Vector

Defined in: src/paper/paperApi.ts:50

Translates paper to page coordinates.

Parameters

Parameter	Type
paperX	number
paperY	number

Returns

Vector

---

paperToScrollablePaneCoords()

paperToScrollablePaneCoords(paperX, paperY): Vector

Defined in: src/paper/paperApi.ts:70

Translates paper to scrollable pane coordinates.

Parameters

Parameter	Type
paperX	number
paperY	number

Returns

Vector

---

scrollablePaneToClientCoords()

scrollablePaneToClientCoords(paneX, paneY): Vector

Defined in: src/paper/paperApi.ts:62

Translates scrollable pane to client (viewport) coordinates.

Parameters

Parameter	Type
paneX	number
paneY	number

Returns

Vector

---

scrollablePaneToPaperCoords()

scrollablePaneToPaperCoords(paneX, paneY): Vector

Defined in: src/paper/paperApi.ts:66

Translates scrollable pane to paper coordinates.

Parameters

Parameter	Type
paneX	number
paneY	number

Returns

Vector

---

snapshot()

snapshot(): CanvasMetrics

Defined in: src/paper/paperApi.ts:34

Returns a immutable instance of this metrics which is guaranteed to never change even if original canvas viewport changes.

Returns

CanvasMetrics