Interface SurfaceShapesOptions

Options for a shape library for the surface to use. If you want to use a shape library with a surface you at least need to provide library here.

interface SurfaceShapesOptions {
    labelAttribute?: string;
    library: ShapeLibrary<ObjectData>;
    showLabels?: boolean;
    strokeWidth?: number;
    tagName?: string;
}

Properties

labelAttribute? library showLabels? strokeWidth? tagName?

Properties

OptionallabelAttribute

labelAttribute?: string

The attribute containing each vertex's label. Defaults to 'label'

library

library: ShapeLibrary<ObjectData>

The shape library to use. Required.

OptionalshowLabels

showLabels?: boolean

Whether or not to show labels. Defaults to true.

OptionalstrokeWidth

strokeWidth?: number

Stroke width to use when drawing svg shapes.

OptionaltagName

tagName?: string

The name of the tag to make available to node/group renderers. Defaults to jtk-shape. You'll only use this tag with vanilla JsPlumb. If you're using an integration there's a dedicated shape component you will use instead.

Settings

Member Visibility

On This Page

Properties
Version :