SidePanelUI Class

Namespace:
@gembox/pdfviewer
Assembly:
@gembox/pdfviewer

Represents the side panel component of the PDF viewer.

export declare class SidePanelUI implements VisibilityElement
Inheritance:
SidePanelUI
Implements
Remarks

This class manages the side panel UI element, including its visibility, pinned state, and the currently active panel type (thumbnails, bookmarks, etc.).

Fields

digitalSignature

Gets the digital signature component of the side panel.

readonly digitalSignature: DigitalSignatureUI;
Field Value
DigitalSignatureUI
Remarks

This property provides access to the digital signature functionality and configuration.

eSignature

Gets the electronic signature component of the side panel.

readonly eSignature: ESignatureUI;
Field Value
ESignatureUI
Remarks

This property provides access to the electronic signature functionality and configuration.

Properties

isVisible

The value indicating whether the side panel is visible.

get isVisible(): boolean;
set isVisible(value: boolean);
Parameters
value

The boolean value to set for visibility

Remarks

When setting this property to false, the panel will be unpinned and reset to show thumbnails.

isPinned

The value indicating whether the side panel is pinned open.

get isPinned(): boolean;
set isPinned(value: boolean);
Parameters
value

The boolean value to set for pinned state

Remarks

When pinned, the side panel remains visible even when not actively used. When unpinned, the panel will close automatically after inactivity.

activeSidePanelType

The active SidePanelType for the side panel.

get activeSidePanelType(): SidePanelType;
set activeSidePanelType(value: SidePanelType);
Parameters
value
SidePanelType

The SidePanelType to set as active

Property Value
SidePanelType
Remarks

This property determines which sub-panel is currently being displayed within the side panel, such as thumbnails or bookmarks.

Implements