Interface: CanvasMetrics

Defined in: diagram/canvasApi.ts:364

Represents canvas viewport size and transformation.

Allows to convert between different canvas coordinate types.

Properties

Property	Modifier	Type	Description
area	readonly	CanvasAreaMetrics	Sizes and offsets for the canvas area DOM element.

Methods

clientToPaperCoords()

clientToPaperCoords(areaClientX, areaClientY): Vector

Defined in: diagram/canvasApi.ts:397

Translates client (viewport) to paper coordinates.

Parameters

Parameter	Type
areaClientX	number
areaClientY	number

Returns

Vector

---

clientToScrollablePaneCoords()

clientToScrollablePaneCoords(areaClientX, areaClientY): Vector

Defined in: diagram/canvasApi.ts:401

Translates client (viewport) to scrollable pane coordinates.

Parameters

Parameter	Type
areaClientX	number
areaClientY	number

Returns

Vector

---

getPaperSize()

getPaperSize(): Size

Defined in: diagram/canvasApi.ts:381

Returns paper size in paper coordinates.

Returns

Size

---

getTransform()

getTransform(): PaperTransform

Defined in: diagram/canvasApi.ts:372

Returns transformation data between paper and scrollable pane coordinates.

Returns

PaperTransform

---

getViewportPageRect()

getViewportPageRect(): Rect

Defined in: diagram/canvasApi.ts:385

Returns viewport bounds in page coordinates.

Returns

Rect

---

pageToPaperCoords()

pageToPaperCoords(pageX, pageY): Vector

Defined in: diagram/canvasApi.ts:389

Translates page to paper coordinates.

Parameters

Parameter	Type
pageX	number
pageY	number

Returns

Vector

---

paperToPageCoords()

paperToPageCoords(paperX, paperY): Vector

Defined in: diagram/canvasApi.ts:393

Translates paper to page coordinates.

Parameters

Parameter	Type
paperX	number
paperY	number

Returns

Vector

---

paperToScrollablePaneCoords()

paperToScrollablePaneCoords(paperX, paperY): Vector

Defined in: diagram/canvasApi.ts:413

Translates paper to scrollable pane coordinates.

Parameters

Parameter	Type
paperX	number
paperY	number

Returns

Vector

---

scrollablePaneToClientCoords()

scrollablePaneToClientCoords(paneX, paneY): Vector

Defined in: diagram/canvasApi.ts:405

Translates scrollable pane to client (viewport) coordinates.

Parameters

Parameter	Type
paneX	number
paneY	number

Returns

Vector

---

scrollablePaneToPaperCoords()

scrollablePaneToPaperCoords(paneX, paneY): Vector

Defined in: diagram/canvasApi.ts:409

Translates scrollable pane to paper coordinates.

Parameters

Parameter	Type
paneX	number
paneY	number

Returns

Vector

---

snapshot()

snapshot(): CanvasMetrics

Defined in: diagram/canvasApi.ts:377

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

Returns

CanvasMetrics