Class DocumentLayersController

Index

Constructors

Accessors

Methods

clear getLayers setApi setLayerVisibility

Constructors

constructor

new DocumentLayersController(
api?: DocumentApi<DocumentApiState>,
): DocumentLayersController
Parameters
- Optionalapi: DocumentApi<DocumentApiState>
Returns DocumentLayersController
- Defined in packages/doc-viewer/src/lib/document/layers/controller.ts:8

Accessors

enabled

get enabled(): boolean
Returns a boolean indicating whether the document supports layers.

Returns boolean
- Defined in packages/doc-viewer/src/lib/document/layers/controller.ts:31

Methods

clear

clear(): void
Returns void
- Defined in packages/doc-viewer/src/lib/document/layers/controller.ts:23

getLayers

getLayers(): Promise<DocumentLayer[]>
Retrieves the layers of the document.

Returns Promise<DocumentLayer[]>

Throws
if the loaded document does not support layers.
- Defined in packages/doc-viewer/src/lib/document/layers/controller.ts:40

setApi

setApi(api: DocumentApi): void
Parameters
- api: DocumentApi
Returns void
- Defined in packages/doc-viewer/src/lib/document/layers/controller.ts:14

setLayerVisibility

setLayerVisibility(id: string, visible: boolean): Promise<void>
Sets the visibility of a layer by ID.
Parameters
- id: string
- visible: boolean
Returns Promise<void>

Throws
if the loaded document does not support layers.
- Defined in packages/doc-viewer/src/lib/document/layers/controller.ts:49