Skip to main content

Interface: PrintOptions

Options of printDiagram.

Extends​

Properties​

background?​

background?: string | boolean;

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

Inherited from​

SvgExportOptions.background


decorations?​

decorations?: Decorations | null;

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

Inherited from​

SvgExportOptions.decorations


detailLevel?​

detailLevel?: DetailLevel;

Inherited from​

SvgExportOptions.detailLevel


edgeStyle?​

edgeStyle?: EdgeStyle;

Inherited from​

SvgExportOptions.edgeStyle


highlight?​

highlight?: readonly string[];

Inherited from​

SvgExportOptions.highlight


margin?​

margin?: string;

Page margin (CSS length). Default '10mm'.


orientation?​

orientation?: "landscape" | "portrait" | "auto";

Page orientation. Default 'landscape'; 'auto' picks from the diagram's aspect ratio.


padding?​

padding?: number;

Space around the diagram, in px. Default 24.

Inherited from​

SvgExportOptions.padding


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.

Inherited from​

SvgExportOptions.palette


title?​

title?: string;

Written as the SVG <title>.

Inherited from​

SvgExportOptions.title