JSON Canvas Spec

Summary

JSON Canvas Spec Version 1.0 — 2024-03-11 Top level The top level of JSON Canvas contains two arrays: nodes (optional, array of nodes) edges (optional, array of edges) Nodes Nodes are objects within the canvas. Nodes may be text, files, links, or groups. Nodes are placed in the array in ascending order by z-index. The first node in the array should be displayed below all other nodes, and the last node in the array should be displayed on top of all other nodes. Generic node All nodes include the following attributes: id (required, string) is a unique ID for the node. type (required, string) is the node type. x (required, integer) is the x position of the node in pixels. y (required, integer) is the y position of the node in pixels. width (required, integer) is the width of the node in pixels. height (required, integer) is the height of the node in pixels. color (optional, canvasColor) is the color of the node, see the Color section. Text type nodes Text type nodes store text. Along with generic node attributes, text nodes include the following attribute: text (required, string) in plain text with Markdown syntax. File type nodes File type nodes reference other files or attachments, such as images, videos, etc. Along with generic node attributes, file nodes include the following attributes: file (required, string) is the path to the file within the system. subpath (optional, string) is a subpath that may link to a heading or a block. Always starts with a #. Link type nodes Link type nodes reference a URL. Along with generic node attributes, link nodes include the following attribute: Group type nodes Group type nodes are used as a visual container for nodes within it. Along with generic node attributes, group nodes include the following attributes: label (optional, string) is a text label for the group. background (optional, string) is the path to the background image. backgroundStyle (optional, string) is the rendering style of the background image. Valid values: cov...