Skip to content

Vizel API / core/src / VizelDiagramOptions

Interface: VizelDiagramOptions

Defined in: packages/core/src/extensions/diagram.ts:41

Options for the Diagram extension

Properties

defaultCode?

ts
optional defaultCode?: string;

Defined in: packages/core/src/extensions/diagram.ts:61

Default diagram code for new diagrams (for mermaid)

Default

ts
"flowchart TD\n  A[Start] --> B[End]"

defaultGraphvizCode?

ts
optional defaultGraphvizCode?: string;

Defined in: packages/core/src/extensions/diagram.ts:66

Default diagram code for new GraphViz diagrams

Default

ts
"digraph G {\n  A -> B\n}"

defaultType?

ts
optional defaultType?: VizelDiagramType;

Defined in: packages/core/src/extensions/diagram.ts:56

Default diagram type when creating new diagrams

Default

ts
"mermaid"

graphvizEngine?

ts
optional graphvizEngine?: GraphvizEngine;

Defined in: packages/core/src/extensions/diagram.ts:51

Default GraphViz layout engine

Default

ts
"dot"

mermaidConfig?

ts
optional mermaidConfig?: MermaidConfig;

Defined in: packages/core/src/extensions/diagram.ts:46

Mermaid configuration options

See

https://mermaid.js.org/config/setup/modules/config.html

Released under the MIT License.