Interface SurfaceComponentProps

Props for the Surface component.

interface SurfaceComponentProps {
    childProps?: any;
    className?: string;
    data?: any;
    modelOptions?: JsPlumbToolkitOptions;
    renderOptions?: ReactSurfaceRenderOptions;
    shapeLibrary?: ShapeLibraryImpl<ObjectData>;
    surfaceId?: string;
    toolkit?: BrowserUIReact;
    url?: string;
    viewOptions?: ReactSurfaceViewOptions;
}

Properties

childProps?: any

Any props to pass to children.

className?: string

Optional class name to append to the root element's class list.

data?: any

Optional initial data

modelOptions?: JsPlumbToolkitOptions

Options for the underlying JsPlumb Toolkit instance. If you use this component as a child of a JsPlumbComponent then the underlying JsPlumb instance will be sourced from the JsPlumbComponent. Otherwise, this component will instantiate a JsPlumb instance itself, optionally using these params.

Render options such as layout, drag options etc

shapeLibrary?: ShapeLibraryImpl<ObjectData>

Optional shape library for the underlying surface to use. You can provide this or you can also provide a shapes render option to the surface.

surfaceId?: string

Optional ID to assign to the surface that is created.

toolkit?: BrowserUIReact

JsPlumb instance to use - optional. The SurfaceComponent will create find a JsPlumb instance in an enclosing JsPlumbContext, if applicable, or otherwise will create its own JsPlumb instance (for which you can provide modelOptions if you wish)

url?: string

Optional URL to load initial data from.

Mappings of vertex types to components/jsx and edge types.

Version :