CaptureViewerConstructorOptions

Syntax

interface CaptureViewerConstructorOptions {
	container?: string | HTMLElement;
	keyboardInteractionConfig?: KeyboardInteractionConfig;
	viewerConfig?: CaptureViewerConfig;
	uiConfig?: UiConfig;
	groupUid?: string;
}

Attributes

container

The container which is used to show the viewer. Its id or HTMLElement is accepted.

keyboardInteractionConfig

This configures the use of keyboard shortcuts for the viewer - please see KeyboardInteractionConfig for details. If not specified, all keyboard shortcuts are disabled by default.

viewerConfig

The configurations of viewer, please refer to CaptureViewerConfig. If it is not specified, the default configuration will be applied.

uiConfig

The UI layout configurations of viewer, please refer to UiConfig. If it is not specified, the default UI will be applied.

groupUid

The uid of viewers’ group. If it is not specified, a random groupUid will be generated.

Related

• CaptureViewer()