Interface: DiagramSvgProps
Props of DiagramSvg.
Properties
background?
background?: string | boolean;
Fill the canvas background (default true); a colour string fills with that colour.
className?
className?: string;
Class of the <svg> element.
colorMode?
colorMode?: ColorMode;
Light or dark palette. Default light.
decorations?
decorations?: Decorations | null;
Search hits, paths, focus and diff tones (§4.2).
detailLevel?
detailLevel?: DetailLevel;
Which columns tables show. Default all.
edgeStyle?
edgeStyle?: EdgeStyle;
How refs are drawn. Default orthogonal.
geometry
geometry: DiagramGeometry;
Where everything is drawn (layoutDiagram / layoutDiagramSync).
height?
height?: string | number;
See width.
highlight?
highlight?: readonly string[] | null;
Table, note or ref ids to emphasise; everything not related to them is dimmed.
idPrefix?
idPrefix?: string;
Prefix for ids inside the SVG (filters). Default rv.
literalColors?
literalColors?: boolean;
Write literal colours instead of var(--rv-*) (standalone export).
measure?
measure?: TextMeasure;
Text measurement; use the one the geometry was laid out with. Default: the built-in width estimate.
model
model: DiagramModel;
View-filtered model (selectView).
padding?
padding?: number;
Space around the diagram bounds, in diagram units. Default 24.
palette?
palette?: PaletteOverrides | null;
Colours and fonts replacing the colorMode palette's (the literal values, and the fallbacks
of the var(--rv-*) references), such as what a page shows (resolvePalette).
routes?
routes?: ReadonlyMap<string, RefRoute> | null;
Precomputed ref routes keyed by ref id (default: routeAll of this model and geometry).
shadows?
shadows?: boolean;
Draw a card shadow (default true).
style?
style?: CSSProperties;
Inline style of the <svg> element.
title?
title?: string;
Accessible title.
width?
width?: string | number;
width/height attributes; default the diagram size in px. Pass '100%' to fill a box.