Skip to main content

OpenSeadragonController

Classes

default

Defined in: controllers/OpenSeadragonController.ts:14

Constructors

Constructor

new default(viewer): default

Defined in: controllers/OpenSeadragonController.ts:76

Parameters
viewer

Viewer

Returns

default

Properties

DEFAULT_VIEWER_ANIMATION_FINISH_OPTIONS

readonly static DEFAULT_VIEWER_ANIMATION_FINISH_OPTIONS: Options

Defined in: controllers/OpenSeadragonController.ts:44

DEFAULT_VIEWER_ANIMATION_START_OPTIONS

readonly static DEFAULT_VIEWER_ANIMATION_START_OPTIONS: Options

Defined in: controllers/OpenSeadragonController.ts:40

DEFAULT_VIEWER_OPTIONS

readonly static DEFAULT_VIEWER_OPTIONS: Options

Defined in: controllers/OpenSeadragonController.ts:15

Methods

configureAnimationHandlers()

configureAnimationHandlers(viewerAnimationStartOptions, viewerAnimationFinishOptions): void

Defined in: controllers/OpenSeadragonController.ts:98

Parameters
viewerAnimationStartOptions

Partial<ViewerOptions>

viewerAnimationFinishOptions

Partial<ViewerOptions>

Returns

void

destroy()

destroy(): void

Defined in: controllers/OpenSeadragonController.ts:186

Returns

void

getViewportBounds()

getViewportBounds(): Rect

Defined in: controllers/OpenSeadragonController.ts:182

Returns

Rect

synchronize()

synchronize(layerMap, imageMap, labelsMap, loadImage, loadLabels, signal?): Promise<void>

Defined in: controllers/OpenSeadragonController.ts:156

Parameters
layerMap

Map<string, ILayerModel>

imageMap

Map<string, IImageModel>

labelsMap

Map<string, ILabelsModel>

loadImage

(image, signal?) => Promise<IImageData>

loadLabels

(labels, signal?) => Promise<ILabelsData>

signal?

AbortSignal

Returns

Promise<void>

updateViewerOptions()

updateViewerOptions(options): void

Defined in: controllers/OpenSeadragonController.ts:80

Parameters
options

Partial<ViewerOptions>

Returns

void

createViewer()

static createViewer(viewerElement): Viewer

Defined in: controllers/OpenSeadragonController.ts:60

Parameters
viewerElement

HTMLElement

Returns

Viewer