Install

Document format

An editable Open Canvas backup is a JSON file that describes pages and their layers.

Editable document files

Open Canvas JSON files use the .cavas.json extension. A version 2 document stores a name, optional design tokens, and pages. Each page contains layers. Older version 1 single-page documents can be imported.

Layers share fields such as id, kind, name, parentId, position (x, y), size (width, height), fill, opacity, rotation, hidden state, locked state, and radius. Common layer kinds are artboard, rectangle, ellipse, text, and image.

Text layers also store their text content and typography, including font family, size, weight, alignment, line height, letter spacing, wrapping, and sizing mode. Image layers use embedded raster data rather than a remote image URL.

Pages and review threads

A version 2 file has one or more pages. Each page has a stable ID and name, its own layers, and an optional threads array for posted review comments. JSON backups preserve all pages and their posted threads. Current selection, viewport, undo history, and unposted comment drafts are not part of the document.

Example

This abbreviated example uses fields from the site's Signal Study sample:

json
{
  "version": 2,
  "name": "Signal Study 01",
  "pages": [
    {
      "id": "cb077a1155d95bce74d5a5aae87bf658",
      "name": "Page 1",
      "nodes": [
        { "id": "b5c2940e7b725bdff982669af4df65d1", "kind": "artboard", "name": "Signal Study 01", "parentId": null, "x": 0, "y": 0, "width": 1120, "height": 720, "fill": "#d6d5f2", "opacity": 1, "rotation": 0, "hidden": false, "locked": false, "radius": 0 }
      ]
    }
  ]
}

Import validates the document and does not execute its contents. SVG and PDF exports are artwork outputs, not re-importable Open Canvas documents.

Written for Open Canvas 0.8.0