Skip to main content
SurfaceComponentProps
Props for the SurfaceComponent.
NameTypeDescription
childProps?anyAny props to pass to children.
className?stringOptional class name to append to the root element's class list.
data?anyOptional initial data
dataType?stringID of the format that data or the data retrieved from url is expected to be in. Defaults to JSON_DATATYPE.
model?BrowserUIReactModelOptional instance to render. You mostly wont need to do this; the SurfaceComponent or PaperComponent will create
an instance.
modelOptions?ModelOptionsOptions for the underlying instance.
renderOptions?ReactSurfaceRenderOptionsRender options such as layout, drag options etc
selection?VisuallyJsSelection | SelectionGeneratorOptional selection (or selection generator) to render, rather than the entire model.
style?Record<string,string>Optional style object to apply to the container element.
surfaceId?stringOptional ID to assign to the surface that is created.
url?stringOptional URL to load initial data from.
viewOptions?ReactSurfaceViewOptionsMappings of vertex types to components/jsx and edge types.