Interface: ComponentOptions
viewer.ComponentOptions
Interface for the component options that can be provided to the viewer.
interface
Properties#
attribution#
• Optional attribution: boolean
Show attribution.
default true
Defined in#
viewer/options/ComponentOptions.ts:25
bearing#
• Optional bearing: boolean | BearingConfiguration
Show indicator for bearing and field of view.
default true
Defined in#
viewer/options/ComponentOptions.ts:32
cache#
• Optional cache: boolean | CacheConfiguration
Cache images around the current one.
default true
Defined in#
viewer/options/ComponentOptions.ts:39
cover#
• Optional cover: boolean
Use a cover to avoid loading data until viewer interaction.
default true
Defined in#
viewer/options/ComponentOptions.ts:46
direction#
• Optional direction: boolean | DirectionConfiguration
Show spatial direction arrows for navigation.
description Default spatial navigation when there is WebGL support.
Requires WebGL support.
default true
Defined in#
viewer/options/ComponentOptions.ts:56
fallback#
• Optional fallback: FallbackOptions
Enable fallback component options when the browser does not have WebGL support.
default undefined
Defined in#
viewer/options/ComponentOptions.ts:64
image#
• Optional image: boolean
Show image planes in 3D.
description Requires WebGL support.
default true
Defined in#
viewer/options/ComponentOptions.ts:73
keyboard#
• Optional keyboard: boolean | KeyboardConfiguration
Enable use of keyboard commands.
description Requires WebGL support.
default true
Defined in#
viewer/options/ComponentOptions.ts:82
marker#
• Optional marker: boolean | MarkerConfiguration
Enable an interface for showing 3D markers in the viewer.
description Requires WebGL support.
default false
Defined in#
viewer/options/ComponentOptions.ts:91
pointer#
• Optional pointer: boolean | PointerConfiguration
Enable mouse, pen, and touch interaction for zoom and pan.
description Requires WebGL support.
default true
Defined in#
viewer/options/ComponentOptions.ts:100
popup#
• Optional popup: boolean
Show HTML popups over images.
description Requires WebGL support.
default false
Defined in#
viewer/options/ComponentOptions.ts:109
sequence#
• Optional sequence: boolean | SequenceConfiguration
Show sequence related navigation.
description Default sequence navigation when there is WebGL support.
default true
Defined in#
viewer/options/ComponentOptions.ts:118
slider#
• Optional slider: boolean | SliderConfiguration
Show a slider for transitioning between image planes.
description Requires WebGL support.
default false
Defined in#
viewer/options/ComponentOptions.ts:127
spatial#
• Optional spatial: boolean | SpatialConfiguration
Enable an interface for showing spatial data in the viewer.
description Requires WebGL support.
default false
Defined in#
viewer/options/ComponentOptions.ts:136
tag#
• Optional tag: boolean | TagConfiguration
Enable an interface for drawing 2D geometries on top of images.
description Requires WebGL support.
default false
Defined in#
viewer/options/ComponentOptions.ts:145
zoom#
• Optional zoom: boolean | ZoomConfiguration
Show buttons for zooming in and out.
description Requires WebGL support.
default true