Viewport API Reference
kittl.state.viewport — read and update the canvas viewport.
Scope: design:state:read (get) · design:state:write (set)
get()
Returns the full viewport state (coordinates, transform, zoom, position).
Returns: SdkResultAsync<Viewport>
set(patch)
Patches multiple viewport properties at once. Accepts exactly one of three mutually exclusive shapes:
ViewportPatch
| Variant | Properties | Description |
|---|---|---|
| Transform-driven | { transform } | Set the full 6-value transformation matrix directly |
| Zoom-driven | { zoom, position? } | Set zoom level, optionally with a pan position |
| Pan-only | { position } | Pan without changing zoom |
Note: These variants are mutually exclusive — you cannot combine
transformwithzoomorpositionin the same call.
Individual Viewport Properties
Each getter returns its value in an SDK result. Each setter returns an SDK result with no payload and accepts an optional origin argument.
| Getter | Setter | Value |
|---|---|---|
getTransform() | setTransform(transform, origin?) | Viewport['transform']: six-value transformation matrix |
getZoom() | setZoom(zoom, origin?) | number |
getCoords() | setCoords(coords, origin?) | Viewport['coords']: viewport corner coordinates |
getPosition() | setPosition(position, origin?) | { x: number; y: number } |
All methods above belong to kittl.state.viewport. See Viewport and ViewportAPI for the exact property types.