happypdf / PDFOptionalContentGroup

Type Alias: PDFOptionalContentGroup

type PDFOptionalContentGroup = {
  name: string;
  ref: PDFRef;
  visible: boolean;
};

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

A document optional content group (OCG), commonly called a PDF "layer".

Properties

name

name: string;

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

Human-readable layer name (/Name). Empty when missing.

---

ref

ref: PDFRef;

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

Indirect reference of the OCG dictionary.

---

visible

visible: boolean;

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

Whether the layer is on in the default configuration (/OCProperties /D).