SurfaceComponentProps

Supported props for the SurfaceComponent.

Properties

data?

optional data: any

Optional dataset to load.

---

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.

---

modelOptions?

optional modelOptions: ModelOptions

Options for the underlying model.

---

renderOptions?

optional renderOptions: RenderOptions

Parameters to configure the underlying surface.

---

surfaceId?

optional surfaceId: string

ID of the surface to attach to. This is optional; Visually JS will use the default surface ID if you do not provide this. For apps where there's only one surface there is no need to provide this.

---

url?

optional url: string

Optional url for a dataset to load.

---

viewOptions?

optional viewOptions: ViewOptions

Mapping of model object types to components and behaviour