ComPDFKit Web SDK
    Preparing search index...

    Interface Layer

    Layer (OCG), corresponding to getLayerTree / setLayerNodeDict

    interface Layer {
        children?: Layer[];
        defaultVisible?: boolean;
        exportState?: LayerUsage;
        locked?: boolean;
        name: string;
        obj?: string;
        printState?: LayerUsage;
        RBGroup?: boolean;
        visible?: boolean;
    }
    Index
    children?: Layer[]

    Child layers.

    defaultVisible?: boolean

    Default visibility in the file (visible is the current display state, changing it does not write the file)

    exportState?: LayerUsage

    Export usage: always, never, or only when visible (written to the file when changed).

    locked?: boolean

    Whether the layer is locked, meaning users should not change its visibility.

    name: string

    Layer name, or the text of a label row.

    obj?: string

    Unique identifier of the layer in the file; not set when the entry is only a label.

    printState?: LayerUsage

    Print / export usage: always / never / only when visible (written to the file when changed)

    RBGroup?: boolean

    Child layers are a radio group (/RBGroups in the file): only one can be on

    visible?: boolean

    Label rows (string labels in /Order, text only) have no visible or obj (labels are recognized by having neither)