Interface SvgExportOptions

Options for SVG export.

interface SvgExportOptions {
    defaultSize?: Size;
    fill?: string;
    gridPaddingCells?: number;
    labelAttribute?: string;
    labelColor?: string;
    labelStrokeWidth?: string;
    margins?: PointXY;
    outline?: string;
    path?: Path;
    selection?: Selection<Edge | Node | Group>;
    showGrid?: boolean;
    showLabels?: boolean;
    strokeWidth?: number;
    style?: string | Record<string, any>;
}

Hierarchy (view full)

Properties

defaultSize? fill? gridPaddingCells? labelAttribute? labelColor? labelStrokeWidth? margins? outline? path? selection? showGrid? showLabels? strokeWidth? style?

Properties

Optional defaultSize

defaultSize?: Size

Default size to use for nodes if their data does not have width/height properties.

Optional fill

fill?: string

Default fill color to use for vertices. Will be overridden by individual fill values in each node. Default value is white.

Optional gridPaddingCells

gridPaddingCells?: number

Optional, defaults to 1. If a grid is being included in the output JsPlumb will draw this number of blank grid cells around the content. You can set this to 0, but we wouldn't recommend setting it to a negative number!

Optional labelAttribute

labelAttribute?: string

If showing labels, the name of the property in each node that defines the label. Defaults to label.

Optional labelColor

labelColor?: string

If showing labels, the default color to use. Will be overridden by individual textColor values in each node. Default value is black.

Optional labelStrokeWidth

labelStrokeWidth?: string

If showing labels, the stroke width to use when rendering them. Defaults to 0.25px.

Optional margins

margins?: PointXY

Optional whitespace to place around the export. Defaults to 50px in x and y.

Optional outline

outline?: string

Default outline color to use for vertices. Will be overridden by individual outline values in each node. Default value is black.

Optional path

path?: Path

Optional path to render. If null, and selection is null, the whole dataset is exported.

Optional selection

selection?: Selection<Edge | Node | Group>

Optional selection to render. If null, and path is null, the whole dataset is exported.

Optional showGrid

showGrid?: boolean

Optional, defaults to true. When a generated grid background is in use in the Surface whose contents are being exported, by default the exported SVG (or PNG/JPG) will include the grid. This flag allows you to hide the grid if you wish.

Optional showLabels

showLabels?: boolean

Whether or not to display labels (using an SVG text element) on nodes. Defaults to false.

Optional strokeWidth

strokeWidth?: number

Default stroke width to use for nodes. Will be overridden by individual outlineWidth values in each node. Default value is 2.

Optional style

style?: string | Record<string, any>

Optional style to set in a style element in the SVG header. You can provide the CSS for the style element as a string, or you can provide a JS object.

Settings

Member Visibility

Theme

On This Page

defaultSizefillgridPaddingCellslabelAttributelabelColorlabelStrokeWidthmarginsoutlinepathselectionshowGridshowLabelsstrokeWidthstyle
Version :