Skip to main content
Version: Version 5 beta

Class: abstract Layer<T>

Abstract base class for a Layer, which is an event emitter that renders on a native HTML element.

Extends​

Extended by​

Type Parameters​

• T extends LayerNativeElementType

The type of the native element, either HTMLDivElement or HTMLCanvasElement.

Constructors​

new Layer()​

new Layer<T>(id, documentViewPage): Layer<T>

Creates an instance of Layer.

Parameters​

• id: string

The unique identifier for the layer.

• documentViewPage: DocumentViewPage

The associated document view page.

Returns​

Layer<T>

Overrides​

EventEmitter.constructor

Accessors​

documentViewPage​

get documentViewPage(): DocumentViewPage

Gets the document view page associated with this layer.

Returns​

DocumentViewPage

id​

get id(): string

Gets the unique identifier of the layer.

Returns​

string

nativeElement​

get nativeElement(): T

Gets the native HTML element of this layer.

Returns​

T

size​

get size(): Size

Gets the size of the layer.

set size(v): void

Sets the size of the layer and dispatches a size change event if the size is different.

Parameters​

• v: Size

The new size to be set.

Returns​

Size

Methods​

addEventListener()​

addEventListener<K>(type, listener): void

Register a function that will be called whenever the specified event is delivered.

Type Parameters​

• K extends "sizeChanged"

A generic type representing the key of the event type.

Parameters​

• type: K

String representing the event type to listen for.

• listener

The function that will be executed when an event of the specified type occurs.

Returns​

void

Inherited from​

EventEmitter.addEventListener

dispatchEvent()​

dispatchEvent<K>(type, args): void

Dispatches an event to all registered listeners.

Type Parameters​

• K extends "sizeChanged"

A generic type representing the key of the event type.

Parameters​

• type: K

String representing the event type to dispatch.

• args: Parameters<LayerEventMap[K]>

The data associated with the event.

Returns​

void

Inherited from​

EventEmitter.dispatchEvent

dispose()?​

optional dispose(): void

Optional cleanup method called when the layer is about to be removed. Override this method to release resources, remove event listeners, or perform any necessary cleanup. The PDF Web SDK calls this method automatically when a page is removed from the viewport.

Returns​

void

removeAllListeners()​

removeAllListeners<K>(type): void

Remove all listeners for a given event.

Type Parameters​

• K extends "sizeChanged"

A generic type representing the key of the event type.

Parameters​

• type: K

String representing the event for which to remove all listeners.

Returns​

void

Inherited from​

EventEmitter.removeAllListeners

removeEventListener()​

removeEventListener<K>(type, listener): void

Removes an event listener previously registered with addEventListener.

Type Parameters​

• K extends "sizeChanged"

A generic type representing the key of the event type.

Parameters​

• type: K

String representing the event for which to remove an event listener.

• listener

The event listener function of the event handler to remove from the event target.

Returns​

void

Inherited from​

EventEmitter.removeEventListener