Skip to main content

SurfaceComponent

const SurfaceComponent: object

Provides a pannable and zoomable canvas onto which nodes, groups and edges can be drawn, with support for various plugins.

Type Declaration

data()

data: () => object

Returns

object

overlays

overlays: OverlayPlaceholder[]

vertices

vertices: VertexPlaceholder[]

name

name: string = COMPONENT_SURFACE

props

props: object

props.data

data: object

props.data.type

type: PropType<ObjectData>

props.dataType

dataType: object

props.dataType.type

type: StringConstructor = String

props.model

model: object

props.model.type

type: PropType<BrowserUIModel>

props.modelOptions

modelOptions: object

props.modelOptions.type

type: PropType<ModelOptions>

props.renderOptions

renderOptions: object

props.renderOptions.type

type: PropType<RenderOptions>

props.surfaceId

surfaceId: object

props.surfaceId.type

type: StringConstructor = String

props.url

url: object

props.url.type

type: StringConstructor = String

props.viewOptions

viewOptions: object

props.viewOptions.type

type: PropType<ViewOptions>

render()

render: () => VNode<RendererNode, RendererElement, {[key: string]: any; }>

Returns

VNode<RendererNode, RendererElement, {[key: string]: any; }>

watch

watch: object

watch.data

data: object

watch.data.handler()

handler(newData): void

Parameters
newData

any

Returns

void

watch.url

url: object

watch.url.handler()

handler(newUrl): void

Parameters
newUrl

any

Returns

void

mounted()

mounted(): void

Returns

void

setup()

setup(props): object

Parameters

props

SurfaceComponentProps

Returns

object

service

service: unknown

surfaceId

surfaceId: string