Skip to main content

Interface: SvgExportOptions

Options of renderDiagramSvgString.

Properties​

background?​

background?: string | boolean;

true (default) fills with the palette's canvas colour, false is transparent, a string is a colour.


colorMode?​

colorMode?: ColorMode;

decorations?​

decorations?: Decorations | null;

Search, path and diff tones, drawn into the file too (a diff can be exported).


detailLevel?​

detailLevel?: DetailLevel;

edgeStyle?​

edgeStyle?: EdgeStyle;

highlight?​

highlight?: readonly string[];

padding?​

padding?: number;

Space around the diagram, in px. Default 24.


palette?​

palette?: PaletteOverrides | null;

Colours and fonts replacing the colorMode palette's: what the page shows, so the file matches it (resolvePalette). The interactive canvas passes them for its own exports.


scale?​

scale?: number;

Scale of the width/height attributes (the viewBox is unchanged). Default 1.


title?​

title?: string;

Written as the SVG <title>.