pdfrx_web
    Preparing search index...

    Interface PdfPageRenderOptions

    Options for PdfPage.render.

    The page is conceptually scaled to fullWidth x fullHeight pixels, and the x/y/width/height sub-rectangle of that scaled page is what gets rendered. All values are in pixels unless noted otherwise.

    interface PdfPageRenderOptions {
        annotationRenderingMode?: PdfAnnotationRenderingMode;
        backgroundColor?: number;
        cancellationToken?: PdfPageRenderCancellationToken;
        flags?: number;
        fullHeight?: number;
        fullWidth?: number;
        height?: number;
        rotationOverride?: PdfPageRotation;
        width?: number;
        x?: number;
        y?: number;
    }
    Index
    annotationRenderingMode? backgroundColor? cancellationToken? flags? fullHeight? fullWidth? height? rotationOverride? width? x? y?
    annotationRenderingMode?: PdfAnnotationRenderingMode

    Whether/how annotations are drawn. Default: 'annotationAndForms'.

    backgroundColor?: number

    32-bit ARGB background. Default: opaque white.

    cancellationToken?: PdfPageRenderCancellationToken

    Cancels the render while it is still queued, making it resolve to null. Create it with PdfPage.createCancellationToken.

    flags?: number

    Advanced: low-level renderer flags (FPDF_*).

    fullHeight?: number

    Height the whole page is scaled to (pixels). Default: page height in points.

    fullWidth?: number

    Width the whole page is scaled to (pixels). Default: page width in points.

    height?: number

    Height of the rendered region (pixels). Default: fullHeight.

    rotationOverride?: PdfPageRotation

    Absolute rotation override for this render (in addition to the page's own rotation).

    width?: number

    Width of the rendered region (pixels). Default: fullWidth.

    x?: number

    Left of the rendered region in the scaled page (pixels). Default: 0.

    y?: number

    Top of the rendered region in the scaled page (pixels). Default: 0.

    Settings
    Member Visibility

    On This Page
    Properties