happypdf / OptionalContentProperties

Class: OptionalContentProperties

Defined in: src/core/interactive/OptionalContent.ts:50

High-level access to /OCProperties (optional content / layers). Visibility updates rewrite the default configuration (/D) /ON and /OFF arrays.

Methods

fromDict()

static fromDict(dict): OptionalContentProperties;

Defined in: src/core/interactive/OptionalContent.ts:51

Parameters

Parameter	Type
dict	PDFDict

Returns

OptionalContentProperties

---

getGroups()

getGroups(): PDFOptionalContentGroup[];

Defined in: src/core/interactive/OptionalContent.ts:61

List /OCGs with default visibility from /D.

Returns

PDFOptionalContentGroup[]

---

setVisibility()

setVisibility(updates): void;

Defined in: src/core/interactive/OptionalContent.ts:89

Set default visibility for the given groups (by name and/or ref).

Parameters

Parameter	Type
updates	OptionalContentVisibilityUpdate[]

Returns

void