Skip to main content

PaperComponentProps

Props for the PaperComponent.

Properties

childProps?

optional childProps: any

Any props to pass to children.


className?

optional className: string

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


data?

optional data: any

Optional initial data


dataType?

optional dataType: string

ID of the format that data or the data retrieved from url is expected to be in. Defaults to JSON_DATATYPE.


model?

optional model: BrowserUIReactModel

Optional instance to render. You mostly wont need to do this; the SurfaceComponent or PaperComponent will create an instance.


modelOptions?

optional modelOptions: ModelOptions

Options for the underlying instance.


paperId?

optional paperId: string

Optional ID to assign to the Paper that is created.


renderOptions?

optional renderOptions: ReactPaperRenderOptions

Render options such as layout, drag options etc


style?

optional style: Record<string, string>

Optional style object to apply to the container element.


url?

optional url: string

Optional URL to load initial data from.


viewOptions?

optional viewOptions: ReactPaperViewOptions

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