Interface AngularSvgExportOptions<T>

Options for SVG export.

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

Type Parameters

  • T extends ObjectData

Hierarchy

  • SvgExportOptions
    • AngularSvgExportOptions

Properties

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

Properties

OptionaldefaultSize

defaultSize?: Size

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

Optionalfill

fill?: string

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

OptionalgridPaddingCells

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!

OptionallabelAttribute

labelAttribute?: string

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

OptionallabelColor

labelColor?: string

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

OptionallabelStrokeWidth

labelStrokeWidth?: string

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

Optionalmargins

margins?: PointXY

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

Optionaloutline

outline?: string

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

Optionalpath

path?: Path

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

Optionalselection

selection?: Selection<Node | Edge | Group>

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

OptionalshapeLibrary

shapeLibrary?: ShapeLibrary<T>

Optional ShapeLibrary to use. If not supplied, supply shapeLibraryId - or ensure the Surface you are exporting has a ShapeLibrary registered on it.

OptionalshapeLibraryId

shapeLibraryId?: string

Optional ID of a ShapeLibrary to use - must have been registered on the jsPlumb Angular service via the registerShapeLibrary method. If not supplied, supply shapeLibrary - or ensure the Surface you are exporting has a ShapeLibrary registered on it.

OptionalshowGrid

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.

OptionalshowLabels

showLabels?: boolean

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

OptionalstrokeWidth

strokeWidth?: number

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

Optionalstyle

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.

surface

surface: Surface

Surface to export

Settings

Member Visibility

On This Page

Properties
Version :