Skip to main content

Interface: PngExportOptions

Options of exportPng.

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


colorMode?​

colorMode?: ColorMode;

Inherited from​

SvgExportOptions.colorMode


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


maxCanvasPixels?​

maxCanvasPixels?: number;

Largest canvas area in px (iOS Safari caps at 16,777,216). Default 16,777,216.


maxCanvasSide?​

maxCanvasSide?: number;

Largest canvas side in px. Default 16384.


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


scale?​

scale?: number;

Device pixels per diagram px. Default 2.


title?​

title?: string;

Written as the SVG <title>.

Inherited from​

SvgExportOptions.title