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

    Interface PageTransition

    A presentation transition + auto-advance for a page (ISO 32000-1 §12.4.4), passed to GigaPdfDoc.setPageTransition. style picks the effect; the remaining fields are optional and only the ones that apply to the chosen style are written (dimension/motion for split, direction/ scale/flyAreaOpaque for fly, …). displayDuration is the page's /Dur auto-advance time and is independent of the transition itself.

    interface PageTransition {
        style:
            | "push"
            | "split"
            | "blinds"
            | "box"
            | "wipe"
            | "dissolve"
            | "glitter"
            | "fly"
            | "cover"
            | "uncover"
            | "fade"
            | "replace";
        duration?: number;
        dimension?: PageTransitionDimension;
        motion?: PageTransitionMotion;
        direction?: PageTransitionDirection;
        scale?: number;
        flyAreaOpaque?: boolean;
        displayDuration?: number;
    }
    Index

    Properties

    style duration? dimension? motion? direction? scale? flyAreaOpaque? displayDuration?

    Properties

    style:
        | "push"
        | "split"
        | "blinds"
        | "box"
        | "wipe"
        | "dissolve"
        | "glitter"
        | "fly"
        | "cover"
        | "uncover"
        | "fade"
        | "replace"

    The transition style (/S).

    duration?: number

    /D — the transition effect duration in seconds (viewer default: 1).

    dimension?: PageTransitionDimension

    /Dm — orientation; split/blinds only.

    motion?: PageTransitionMotion

    /M — motion direction; split/box only.

    direction?: PageTransitionDirection

    /Di — sweep direction; wipe/glitter/fly/cover/uncover/push.

    scale?: number

    /SS — starting/ending scale for fly (PDF 1.5; default 1.0).

    flyAreaOpaque?: boolean

    /B — whether the fly area is rectangular + opaque (PDF 1.5; default false).

    displayDuration?: number

    /Dur — the page's display time in seconds before auto-advancing.

    Settings

    Member Visibility

    On This Page

    Properties