Interface ExtensionViewerBase

Extensions which implement Viewer must subclass this.

Note that TypeScript subclasses should not provide a constructor. Pure JavaScript subclasses can have a constructor but it must pass all of its arguments to the super class.

Hierarchy

ExtensionViewerBase

Index

Methods

Methods

created

created(): void

- Defined in main.ts:494
Extension writers can override method to perform set up and initialisation after construction.

Returns void

getBulkFileHandle

getBulkFileHandle(): BulkFileHandle

- Defined in main.ts:516
Get a BulkFileHandle with the contents of this viewer.

Returns BulkFileHandle

getContainerElement

getContainerElement(): HTMLElement

- Defined in main.ts:499
Get the container element under which this Viewer's contents can be placed.

Returns HTMLElement

getMetadata

getMetadata(): ViewerMetadata

- Defined in main.ts:504
Get the metadata describing this viewer.

Returns ViewerMetadata

setBulkFileHandle

setBulkFileHandle(handle: BulkFileHandle): Promise<void>

- Defined in main.ts:521
Parameters
- handle: BulkFileHandle
Returns Promise<void>

updateMetadata

updateMetadata(changes: ViewerMetadataChange): void

- Defined in main.ts:511
Change fields in the metadata.

Parameters
- changes: ViewerMetadataChange
  
  object containing the fields to change
Returns void

Generated using TypeDoc