@qrcommunication/gigapdf-lib — SDK API reference - v0.110.3
    Preparing search index...

    Class GigaPdfEditor

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    doc: GigaPdfDoc | null = null
    count: number = 0
    current: number = 1
    cssScale: number
    renderScale: number
    fitMode: "page" | "none" | "width" = "none"

    Active auto-fit mode; re-applied on resize and page change.

    urls: (string | null)[] = []
    sizes: ({ w: number; h: number } | null)[] = []
    root: HTMLElement
    pages: HTMLElement
    pageEls: (HTMLElement | null)[] = []

    Accessors

    • get pendingEdits(): number

      Edits drawn but not yet baked into the PDF.

      Returns number

    • get pageCount(): number

      Number of pages currently open.

      Returns number

    • get currentPage(): number

      The page currently in view (1-based).

      Returns number

    • get zoom(): number

      Current CSS zoom multiplier (1 = 100%).

      Returns number

    Methods

    • Delete the currently selected element.

      Returns void

    • Discard all un-applied edits.

      Returns void

    • Bake every pending edit into the PDF, then re-render the affected pages.

      Returns number

    • Set page margins (default unit: millimetres).

      Parameters

      • m: Partial<Record<Side, number>>
      • unit: "mm" | "pt" = "mm"

      Returns void

    • Current margins in the requested unit (millimetres by default).

      Parameters

      • unit: "mm" | "pt" = "mm"

      Returns Record<Side, number>

    • Show or hide the rulers and margin guides.

      Parameters

      • on: boolean

      Returns void

    • The current document as PDF bytes (including any applied edits).

      Returns Uint8Array

    • The page's width / height in PDF points (raster pixels ÷ render scale).

      Parameters

      • page: number

      Returns number

    • Re-raster a page after its content changed (drops the cached image).

      Parameters

      • page: number

      Returns void

    • Scroll/jump to page (clamped to range).

      Parameters

      • page: number

      Returns void

    • Set an explicit zoom multiplier (cancels any auto-fit mode).

      Parameters

      • scale: number

      Returns void