ExcaliDocument: ExcaliDocument

In baptiste/minixcali: Excalidraw Document Builder

ExcaliDocument

Description

R6 Methods for ExcaliDocument object. Object structure is based on the Excalidraw JSON Schema: https://docs.excalidraw.com/docs/codebase/json-schema

Public fields

type

(character(1))
The type of the Excalidraw schema

version

(integer(1))
The version of the Excalidraw schema

source

(character(1))
The source URL of the Excalidraw application

elements

(list())
A list of objects representing excalidraw elements on canvas

appState

(list())
Additional application state/configuration

files

(list())
List of data for excalidraw image elements

Methods

Public methods

• ExcaliDocument$new()

• ExcaliDocument$add()

• ExcaliDocument$replace()

• ExcaliDocument$export()

• ExcaliDocument$clone()

---

Method new()

Initialize an ExcalidrawDoc object

Usage

ExcaliDocument$new()

---

Method add()

Add a glyph to the scene

Usage

ExcaliDocument$add(...)

Arguments

...

glyph attributes

---

Method replace()

Replace all diagram components

Usage

ExcaliDocument$replace(...)

Arguments

...

List of replacement components

---

Method export()

Save the document as json

Usage

ExcaliDocument$export(file)

Arguments

file

Export file path

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ExcaliDocument$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

baptiste/minixcali documentation built on April 4, 2024, 2:10 a.m.