Skip to main content
Version: Version 5 beta

Class: AccessibilityLayer

Represents a layer that provides accessibility features for text fragments in a PDF document. This layer creates an invisible HTML structure that aligns with the text fragments on the page, enabling screen readers and other accessibility tools to interact with the content.

Extends​

Constructors​

new AccessibilityLayer()​

new AccessibilityLayer(id, documentViewPage): AccessibilityLayer

Creates an instance of Layer.

Parameters​

• id: string

The unique identifier for the layer.

• documentViewPage: DocumentViewPage

The associated document view page.

Returns​

AccessibilityLayer

Inherited from​

Layer.constructor

Accessors​

documentViewPage​

get documentViewPage(): DocumentViewPage

Gets the document view page associated with this layer.

Returns​

DocumentViewPage

Inherited from​

Layer.documentViewPage

id​

get id(): string

Gets the unique identifier of the layer.

Returns​

string

Inherited from​

Layer.id

nativeElement​

get nativeElement(): T

Gets the native HTML element of this layer.

Returns​

T

Inherited from​

Layer.nativeElement

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

Inherited from​

Layer.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​

Layer.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​

Layer.dispatchEvent

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​

Layer.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​

Layer.removeEventListener