@plures/praxis

---

@plures/praxis / index / createCanvasEditor

Function: createCanvasEditor()

createCanvasEditor(config): object

Defined in: src/integrations/code-canvas.ts:693

Create a CodeCanvas editor instance

Note: This is a placeholder for the visual editor integration. The actual visual editor requires a browser environment.

Parameters

config

CanvasEditorConfig

Editor configuration including the initial canvas document

Returns

object

An editor object with methods to add/remove nodes and edges and export the canvas

addEdge

addEdge: (edge) => CanvasEdge

Parameters

edge

Omit<CanvasEdge, "id">

Returns

CanvasEdge

addNode

addNode: (node) => CanvasNode

Parameters

node

Omit<CanvasNode, "id">

Returns

CanvasNode

document

document: CanvasDocument

removeEdge

removeEdge: (id) => void

Parameters

id

string

Returns

void

removeNode

removeNode: (id) => void

Parameters

id

string

Returns

void

toMermaid

toMermaid: () => string

Returns

string

toSchema

toSchema: () => PSFSchema

Returns

PSFSchema

toYaml

toYaml: () => string

Returns

string