Skip to content

galavi / ViewConfig

Interface: ViewConfig

Defined in: types.ts:54

View configuration — defines a single view within a Galavi instance

Properties

id?

optional id: string

Defined in: types.ts:55


type

type: string

Defined in: types.ts:57

View type


canvas?

optional canvas: HTMLCanvasElement

Defined in: types.ts:59

Canvas element to render into. Omit for delayed mounting via galavi.mount().


layers

layers: string[]

Defined in: types.ts:61

Layers (IDs) to render in this view (must match IDs in state.layers)


controls?

optional controls: Record<string, Record<string, unknown>>

Defined in: types.ts:63

Controls to attach, keyed by control type (e.g. { orbit: {}, fly: {}, resolution: {} })


overlays?

optional overlays: Record<string, Record<string, unknown>>

Defined in: types.ts:65

Overlays to attach, keyed by overlay type (e.g. { scalebar: {}, marker: { visible: false } })


label?

optional label: string

Defined in: types.ts:67

Human-readable label for this view


activatable?

optional activatable: boolean

Defined in: types.ts:69

Whether this view can become the active view (default: true)

Released under the GPL-3.0 License.