react-pdf-builder/dist/components/pages/PageSizes.d.ts

Build beautiful PDF documents in React.

import { Page } from '@react-pdf/renderer';
declare const pageSizes: {
    '4A0': number[];
    '2A0': number[];
    A0: number[];
    A1: number[];
    A2: number[];
    A3: number[];
    A4: number[];
    A5: number[];
    A6: number[];
    A7: number[];
    A8: number[];
    A9: number[];
    A10: number[];
    B0: number[];
    B1: number[];
    B2: number[];
    B3: number[];
    B4: number[];
    B5: number[];
    B6: number[];
    B7: number[];
    B8: number[];
    B9: number[];
    B10: number[];
    C0: number[];
    C1: number[];
    C2: number[];
    C3: number[];
    C4: number[];
    C5: number[];
    C6: number[];
    C7: number[];
    C8: number[];
    C9: number[];
    C10: number[];
    RA0: number[];
    RA1: number[];
    RA2: number[];
    RA3: number[];
    RA4: number[];
    SRA0: number[];
    SRA1: number[];
    SRA2: number[];
    SRA3: number[];
    SRA4: number[];
    EXECUTIVE: number[];
    FOLIO: number[];
    LEGAL: number[];
    LETTER: number[];
    TABLOID: number[];
    ID1: number[];
};
export type PageSizeString = keyof typeof pageSizes;
/** Contains utilities for [page sizes](https://justinmahar.github.io/react-pdf-builder/?path=/docs/documentation-page-sizes--docs). */
export declare class PageSizes {
    static VALID_ORIENTATIONS: string[];
    /**
     * Get page orientation. Defaults to portrait
     *
     * @param {Object} page object
     * @returns {string} page orientation
     */
    static getOrientation: (page: Page) => import("@react-pdf/types").Orientation;
    /**
     * Return true if page is landscape
     *
     * @param {Object} page instance
     * @returns {boolean} is page landscape
     */
    static isLandscape: (page: Page) => boolean;
    static PAGE_SIZES: {
        '4A0': number[];
        '2A0': number[];
        A0: number[];
        A1: number[];
        A2: number[];
        A3: number[];
        A4: number[];
        A5: number[];
        A6: number[];
        A7: number[];
        A8: number[];
        A9: number[];
        A10: number[];
        B0: number[];
        B1: number[];
        B2: number[];
        B3: number[];
        B4: number[];
        B5: number[];
        B6: number[];
        B7: number[];
        B8: number[];
        B9: number[];
        B10: number[];
        C0: number[];
        C1: number[];
        C2: number[];
        C3: number[];
        C4: number[];
        C5: number[];
        C6: number[];
        C7: number[];
        C8: number[];
        C9: number[];
        C10: number[];
        RA0: number[];
        RA1: number[];
        RA2: number[];
        RA3: number[];
        RA4: number[];
        SRA0: number[];
        SRA1: number[];
        SRA2: number[];
        SRA3: number[];
        SRA4: number[];
        EXECUTIVE: number[];
        FOLIO: number[];
        LEGAL: number[];
        LETTER: number[];
        TABLOID: number[];
        ID1: number[];
    };
    /**
     * Parses scalar value in value and unit pairs
     *
     * @param {string} value scalar value
     * @returns {Object} parsed value
     */
    static parseValue: (value: string) => {
        value: number;
        unit: string;
    } | {
        value: string;
        unit: undefined;
    };
    /**
     * Transform given scalar value to 72dpi equivalent of size
     *
     * @param {string} value styles value
     * @param {number} inputDpi user defined dpi
     * @returns {Object} transformed value
     */
    static transformUnit: (value: string, inputDpi: number) => string | number;
    static transformUnits: ({ width, height }: any, dpi: number) => {
        width: string | number;
        height: string | number;
    };
    /**
     * Transforms array into size object
     *
     * @param {number[] | string[]} v array
     * @returns {{ width: number | string, height: number | string }} size object with width and height
     */
    static toSizeObject: (v: number[] | string[]) => {
        width: string | number;
        height: string | number;
    };
    /**
     * Flip size object
     *
     * @param {{ width: number, height: number }} v size object
     * @returns {{ width: number, height: number }} flipped size object
     */
    static flipSizeObject: (v: any) => {
        width: any;
        height: any;
    };
    /**
     * Returns size object from a given string
     *
     * @param {string} v page size string
     * @returns {{ width: number, height: number }} size object with width and height
     */
    static getStringSize: (v: PageSizeString) => {
        width: string | number;
        height: string | number;
    };
    /**
     * Returns size object from a single number
     *
     * @param {number|string} n page size number
     * @returns {{ width: number|string, height: number|string }} size object with width and height
     */
    static getNumberSize: (n: number | string) => {
        width: string | number;
        height: string | number;
    };
    /**
     * Return page size in an object { width, height }
     *
     * @param {Object} page instance
     * @returns {{ width: number, height: number }} size object with width and height
     */
    static getSize: (page: Page) => {
        width: any;
        height: any;
    };
}
export {};