Interface SurfaceComponentProps

Props for the SurfaceComponent.

interface SurfaceComponentProps {
    className?: string;
    data?: any;
    injector?: ((v: Vertex) => Record<string, any>);
    modelOptions?: JsPlumbToolkitOptions;
    renderOptions?: SvelteSurfaceRenderOptions;
    shapeLibrary?: ShapeLibraryImpl<ObjectData>;
    toolkit?: JsPlumbToolkit;
    url?: string;
    viewOptions?: SvelteSurfaceViewOptions;
}

Hierarchy

  • DOMAttributes<HTMLDivElement>
    • SurfaceComponentProps

Properties

className? data? injector? modelOptions? renderOptions? shapeLibrary? toolkit? url? viewOptions?

Properties

OptionalclassName

className?: string

Optional class name to set on the surface component's container

Optionaldata

data?: any

Optional data to load after the component has been mounted.

Optionalinjector

injector?: ((v: Vertex) => Record<string, any>)

Optional function that is used to generate a set of props for a given vertex before rendering it. This provides a mechanism for you to inject specific items into the components you use to render your vertices. The return value of this function should be Record<string, any>. It may be null.

OptionalmodelOptions

modelOptions?: JsPlumbToolkitOptions

Options for the underlying Toolkit instance.

OptionalrenderOptions

renderOptions?: SvelteSurfaceRenderOptions

Render options for the Surface.

OptionalshapeLibrary

shapeLibrary?: ShapeLibraryImpl<ObjectData>

Shape library to use to render SVG shapes. Optional.

Optionaltoolkit

toolkit?: JsPlumbToolkit

Optional JsPlumb Toolkit to use. If this is not provided, a Toolkit instance will be created.

Optionalurl

url?: string

Optional url from which to load data after the component has been mounted. If you provide this and also data, this will take precedence.

OptionalviewOptions

viewOptions?: SvelteSurfaceViewOptions

View options for the Surface.

Settings

Member Visibility

On This Page

Properties
Version :