pdfOCConfig

Optional Content Configuration — ISO 32000-2 §8.11.4.

Module pdfOCConfig | Source packages/front/office/pdf/src/ocg/config.js | Deps pdfErrors, pdfParser | Worker-safe yes

Types the OC configuration dict referenced by /OCProperties /D (default config) or an entry of /OCProperties /Configs. Entries: /Name, /Creator, /BaseState (ON/OFF/Unchanged), /ON (refs forced visible), /OFF (refs forced hidden), /Locked (refs the user cannot toggle), /Intent (a name or array of names), /AS (auto-state — array of UsageApplication dicts), /Order (display tree for viewers, kept raw), /ListMode (AllPages/VisiblePages), /RBGroups (radio-button groups).

Resolve

const cfg = runtime.resolve('pdfOCConfig');
// Returns: { typeOCConfig, typeUsageApp }

API

Shape OCConfig

{
    name?, creator?,
    baseState?: 'ON' | 'OFF' | 'Unchanged',
    on?: PdfRef[], off?: PdfRef[], locked?: PdfRef[],
    intent?: string[],
    as?: UsageApplication[],
    order?: PdfNode[],                 // /Order items, kept raw
    listMode?: string,
    rbGroups?: PdfRef[][],
    raw, _extras
}

Shape UsageApplication

{ event?: string, ocgs?: PdfRef[], category?: string[], raw }

Examples

Default configuration

const cfg = runtime.resolve('pdfOCConfig');
const c = cfg.typeOCConfig(doc._raw.resolve(catalog.ocProperties.entries.D));
c.baseState;      // 'ON'
c.on;             // [ref, …] forced ON
c.rbGroups;       // mutually-exclusive groups

Applying UsageApplication entries

for (const uaDict of c.as ?? []) {
    const ua = cfg.typeUsageApp(uaDict);
    ua.event;       // 'View' | 'Print' | 'Export'
    ua.ocgs;        // refs this application applies to
    ua.category;    // ['Zoom', …]
}

Errors

See also

• pdfOCG · pdfCatalog