Skip to main content
SurfaceComponentProps
NameTypeDescription
additionalProps?Array<Record<string,any>>An optional array of reactive objects. The properties from these objects will be
merged into the props passed to each WrapperComponent, preserving reactivity.
className?stringOptional class name to set on the surface component's container
data?anyOptional data to load after the component has been mounted.
dataType?stringID of the format that data or the data retrieved from url is expected to be in. Defaults to JSON_DATATYPE.
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.
model?BrowserUIModelOptional Visually JS instance to use. If this is not provided, a Visually JS instance will be created, with modelOptions if you provide them.
modelOptions?ModelOptionsOptions for the underlying model instance.
renderOptions?SvelteSurfaceRenderOptionsRender options for the Surface.
shapeLibrary?ShapeLibraryImpl<ObjectData>Shape library to use to render SVG shapes. Optional.
url?stringOptional url from which to load data after the component has been mounted. If you provide this and also data, this will take precedence.
viewOptions?SvelteSurfaceViewOptionsView options for the Surface.