<PaperComponent/>

Provides a static, auto scaling, canvas on which nodes, edges and groups can be drawn, with support for layouts and various plugins.

Usage

This component is a "static" version of the SurfaceComponent - it offers all of the features of the surface, but it does not zoom, pan or allow vertices to be dragged, and it continually adjusts the position and scale of the canvas so that all of the content is visible inside of the viewport. It's useful for situations where you want to give your users a live view of a dataset but without the ability to edit.

There are three main sections of props that you should be familiar with:

• renderOptions This prop contains all of the settings that control the behaviour and appearance of the component itself - what layout to use, whether to zoom to fit a dataset when it has been loaded, whether or not to use a grid, plugins, etc...the list is long.

• viewOptions This contains the mapping from node/edge/group types to their visual representation and behaviour. For nodes and groups this means mapping some JSX to use to render them; for edges this means specifying details of the connector to use to draw an edge, and how the edge should be anchored. You can also supply event mappings in your viewOptions to hook into user interaction with the various parts of the UI

• modelOptions This is used less often than viewOptions and renderOptions, but this is how you can provide settings for the underlying model.

<PaperComponent 
    className="..."
    data={ ... }
    url=" ... "
    renderOptions={ ... }
    viewOptions={ ... }
    modelOptions={ ... }
/>

Props

PaperComponentProps

Props for the PaperComponent.

Name	Type	Description
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
dataType?	string	ID of the format that data or the data retrieved from url is expected to be in. Defaults to JSON_DATATYPE.
model?	BrowserUIReactModel	Optional instance to render. You mostly wont need to do this; the SurfaceComponent or PaperComponent will create an instance.
modelOptions?	ModelOptions	Options for the underlying instance.
paperId?	string	Optional ID to assign to the Paper that is created.
renderOptions?	ReactPaperRenderOptions	Render options such as layout, drag options etc
style?	Record<string,string>	Optional style object to apply to the container element.
url?	string	Optional URL to load initial data from.
viewOptions?	ReactPaperViewOptions	Mappings of vertex types to components/jsx and edge types.

Ref Handle

If you bind this component to a ref, you get an object of type PaperComponentRef:

PaperComponentRef

Reference to a PaperComponent. Offers methods to get the underlying surface and VisuallyJs instance.

Name	Type	Description
getModel	() => BrowserUIReactModel	Gets the underlying model instance, on which you can manage the model.
getPaper	() => Paper	Gets the Paper canvas component.