Skip to content
D
Documentation

types

reference
1 min readUpdated

Import these from @grafloria/renderer.

CreateDiagram

The factory's own signature, for hosts that store it.

ts
type CreateDiagram = typeof import('./create-diagram').createDiagram;

DiagramEventHandler

ts
type DiagramEventHandler<K extends DiagramEventName> = (
  payload: DiagramEventMap[K]
) => void;

DiagramEventName

Also has every member of String, listed on its own entry.

ts
type DiagramEventName = keyof DiagramEventMap;

EdgeInput

Also has every member of EdgeSpec, listed on its own entry.

ts
type EdgeInput = EdgeSpec | LinkModel;

GroupLabelPlacement

Also has every member of String, listed on its own entry.

Where a zone's caption sits.

ts
type GroupLabelPlacement = 'top-left' | 'top' | 'top-right' | 'bottom-left' | 'bottom' | 'bottom-right';

KeyAction

Also has every member of String, listed on its own entry.

What a key the binder handles is about to do — what beforeKey is asked about.

ts
type KeyAction =
  | 'escape'
  | 'delete'
  | 'nudge'
  | 'selectAll'
  | 'undo'
  | 'redo'
  | 'copy'
  | 'cut'
  | 'paste'
  | 'duplicate'
  | 'rename';

NodeInput

Also has every member of NodeSpec, listed on its own entry.

Nodes/edges may be handed in as plain specs or as live engine models.

ts
type NodeInput = NodeSpec | NodeModel;

NodeTemplate

ts
type NodeTemplate = NodeTemplateFn | NodeTemplateDef;

NodeTemplateFn

ts
type NodeTemplateFn = (data: Record<string, unknown>, ctx: NodeTemplateContext) => NodeTemplateOutput;

RunStatus

Also has every member of String, listed on its own entry.

ts
type RunStatus = 'idle' | 'pending' | 'running' | 'completed' | 'error' | 'warning';

Was this page helpful?

types — Grafloria