@sheetxl/sdk 0.8.0-beta.10 → 0.8.0-beta.12

package/types/src/print/IPageLayout.d.ts

@@ -0,0 +1,635 @@
+import { ITransaction } from '../transaction';
+import { ICellRange, ICellRanges } from '../cellRange';
+import { IEmbeddedPart } from '../io/IEmbeddedPart';
+/**
+ * How a sheet is laid out on printed pages: paper, orientation, scale, margins, what is printed
+ * besides the cells, the headers and footers, the print area and the rows and columns repeated on
+ * every page.
+ *
+ * @remarks
+ * Shaped after Office Scripts' `PageLayout`, reached the same way ({@link IWorksheet.getPageLayout}).
+ * The manual page breaks are here too, with the rest of what decides the pages. Office Scripts has
+ * them on the worksheet, and so does {@link IWorksheet}: {@link IWorksheet.getHorizontalPageBreaks} and the
+ * others are the same breaks.
+ *
+ * Setters return the layout rather than `void`, so calls can be chained.
+ *
+ * SheetXL does not print; these settings are kept with the sheet and written to the file.
+ */
+export interface IPageLayout {
+    /**
+     * The orientation of the printed page.
+     *
+     * @defaultValue {@link IPageLayout.Orientation.Portrait}
+     */
+    getOrientation(): IPageLayout.Orientation;
+    /** @see {@link getOrientation} */
+    setOrientation(orientation: IPageLayout.Orientation, options?: ITransaction.OperationOptions): this;
+    /**
+     * The paper size, or `null` when the sheet uses a size that has no name here.
+     *
+     * @defaultValue {@link IPageLayout.PaperType.Letter}
+     *
+     * @remarks
+     * Files can name sizes beyond Office Scripts' list (printer-specific sizes, numbered 256 and up);
+     * {@link getPaperSizeCode} returns the size in every case.
+     */
+    getPaperSize(): IPageLayout.PaperType | null;
+    /**
+     * The paper size as the number the file stores it by: `1` letter, `9` A4, and so on. This is
+     * also the value of VBA's `PageSetup.PaperSize`.
+     */
+    getPaperSizeCode(): number;
+    /**
+     * Sets the paper size, by name or by the number the file stores it by.
+     */
+    setPaperSize(paperSize: IPageLayout.PaperType | number, options?: ITransaction.OperationOptions): this;
+    /**
+     * How the sheet is scaled: a percentage, or the number of pages to fit it to.
+     *
+     * @defaultValue `{ scale: 100 }`
+     *
+     * @remarks
+     * Exactly one form is returned. Fitting to pages returns both counts; `0` means as many pages as
+     * the content needs in that direction (Excel's "Automatic").
+     */
+    getZoom(): IPageLayout.ZoomOptions;
+    /**
+     * Scales the sheet to a percentage, or fits it to a number of pages.
+     *
+     * @throws `Error` If both a scale and a page count are given, or a value is out of range.
+     *
+     * @remarks
+     * Giving one page count keeps the other. Switching from one form to the other keeps the values
+     * of the form not in use, as Excel does.
+     */
+    setZoom(zoom: IPageLayout.ZoomOptions, options?: ITransaction.OperationOptions): this;
+    /**
+     * The top margin, in points.
+     *
+     * @defaultValue 54 (0.75 inch)
+     */
+    getTopMargin(): number;
+    /** @see {@link getTopMargin} */
+    setTopMargin(topMargin: number, options?: ITransaction.OperationOptions): this;
+    /**
+     * The bottom margin, in points.
+     *
+     * @defaultValue 54 (0.75 inch)
+     */
+    getBottomMargin(): number;
+    /** @see {@link getBottomMargin} */
+    setBottomMargin(bottomMargin: number, options?: ITransaction.OperationOptions): this;
+    /**
+     * The left margin, in points.
+     *
+     * @defaultValue 50.4 (0.7 inch)
+     */
+    getLeftMargin(): number;
+    /** @see {@link getLeftMargin} */
+    setLeftMargin(leftMargin: number, options?: ITransaction.OperationOptions): this;
+    /**
+     * The right margin, in points.
+     *
+     * @defaultValue 50.4 (0.7 inch)
+     */
+    getRightMargin(): number;
+    /** @see {@link getRightMargin} */
+    setRightMargin(rightMargin: number, options?: ITransaction.OperationOptions): this;
+    /**
+     * The distance from the top of the page to the header, in points.
+     *
+     * @defaultValue 21.6 (0.3 inch)
+     */
+    getHeaderMargin(): number;
+    /** @see {@link getHeaderMargin} */
+    setHeaderMargin(headerMargin: number, options?: ITransaction.OperationOptions): this;
+    /**
+     * The distance from the bottom of the page to the footer, in points.
+     *
+     * @defaultValue 21.6 (0.3 inch)
+     */
+    getFooterMargin(): number;
+    /** @see {@link getFooterMargin} */
+    setFooterMargin(footerMargin: number, options?: ITransaction.OperationOptions): this;
+    /**
+     * Sets several margins at once, in the unit given. Margins not given stay as they are.
+     *
+     * @throws `Error` If a margin is negative.
+     */
+    setPrintMargins(unit: IPageLayout.PrintMarginUnit, marginOptions: IPageLayout.MarginOptions, options?: ITransaction.OperationOptions): this;
+    /**
+     * Whether the printed area is centered horizontally on the page.
+     *
+     * @defaultValue false
+     */
+    getCenterHorizontally(): boolean;
+    /** @see {@link getCenterHorizontally} */
+    setCenterHorizontally(centerHorizontally: boolean, options?: ITransaction.OperationOptions): this;
+    /**
+     * Whether the printed area is centered vertically on the page.
+     *
+     * @defaultValue false
+     */
+    getCenterVertically(): boolean;
+    /** @see {@link getCenterVertically} */
+    setCenterVertically(centerVertically: boolean, options?: ITransaction.OperationOptions): this;
+    /**
+     * Whether the gridlines are printed.
+     *
+     * @defaultValue false
+     *
+     * @remarks
+     * Independent of whether they are shown on screen ({@link IWorksheetView.setShowRowGridlines}).
+     */
+    getPrintGridlines(): boolean;
+    /** @see {@link getPrintGridlines} */
+    setPrintGridlines(printGridlines: boolean, options?: ITransaction.OperationOptions): this;
+    /**
+     * Whether the row numbers and column letters are printed.
+     *
+     * @defaultValue false
+     */
+    getPrintHeadings(): boolean;
+    /** @see {@link getPrintHeadings} */
+    setPrintHeadings(printHeadings: boolean, options?: ITransaction.OperationOptions): this;
+    /**
+     * Whether the sheet prints in black and white.
+     *
+     * @defaultValue false
+     */
+    getBlackAndWhite(): boolean;
+    /** @see {@link getBlackAndWhite} */
+    setBlackAndWhite(blackAndWhite: boolean, options?: ITransaction.OperationOptions): this;
+    /**
+     * Whether the sheet prints in draft quality, without graphics.
+     *
+     * @defaultValue false
+     */
+    getDraftMode(): boolean;
+    /** @see {@link getDraftMode} */
+    setDraftMode(draftMode: boolean, options?: ITransaction.OperationOptions): this;
+    /**
+     * The number printed on the first page, or `""` when pages are numbered automatically.
+     *
+     * @defaultValue `""`
+     */
+    getFirstPageNumber(): number | '';
+    /**
+     * Sets the number printed on the first page; `""` or `null` numbers the pages automatically.
+     */
+    setFirstPageNumber(firstPageNumber: number | '' | null, options?: ITransaction.OperationOptions): this;
+    /**
+     * The order pages are numbered and printed in when the sheet spans pages both ways.
+     *
+     * @defaultValue {@link IPageLayout.PrintOrder.DownThenOver}
+     */
+    getPrintOrder(): IPageLayout.PrintOrder;
+    /** @see {@link getPrintOrder} */
+    setPrintOrder(printOrder: IPageLayout.PrintOrder, options?: ITransaction.OperationOptions): this;
+    /**
+     * Whether and where notes are printed.
+     *
+     * @defaultValue {@link IPageLayout.PrintComments.NoComments}
+     */
+    getPrintComments(): IPageLayout.PrintComments;
+    /** @see {@link getPrintComments} */
+    setPrintComments(printComments: IPageLayout.PrintComments, options?: ITransaction.OperationOptions): this;
+    /**
+     * How cells holding an error are printed.
+     *
+     * @defaultValue {@link IPageLayout.PrintErrorType.AsDisplayed}
+     */
+    getPrintErrors(): IPageLayout.PrintErrorType;
+    /** @see {@link getPrintErrors} */
+    setPrintErrors(printErrors: IPageLayout.PrintErrorType, options?: ITransaction.OperationOptions): this;
+    /**
+     * The headers and footers.
+     */
+    getHeadersFooters(): IPageLayout.IHeaderFooterGroup;
+    /**
+     * The ranges printed, or `null` when the whole used range prints.
+     *
+     * @remarks
+     * Office Scripts returns `undefined` here; this returns `null`.
+     *
+     * Kept as the sheet-scoped name `_xlnm.Print_Area` (see {@link IWorksheet.getNames}), so it follows
+     * rows and columns inserted and deleted the way any name does.
+     */
+    getPrintArea(): ICellRanges | null;
+    /**
+     * Sets the ranges printed. `null` or `""` clears the print area.
+     */
+    setPrintArea(printArea: ICellRanges.Address | null, options?: ITransaction.OperationOptions): this;
+    /**
+     * The rows repeated at the top of every page, or `null` when there are none.
+     *
+     * @remarks
+     * Office Scripts returns `undefined` here; this returns `null`.
+     *
+     * Kept, with {@link getPrintTitleColumns}, as the sheet-scoped name `_xlnm.Print_Titles`.
+     */
+    getPrintTitleRows(): ICellRange | null;
+    /**
+     * Sets the rows repeated at the top of every page, as entire rows (`'1:2'`). `null` or `""`
+     * clears them.
+     *
+     * @throws `Error` If the range is not one block of entire rows.
+     */
+    setPrintTitleRows(printTitleRows: ICellRange | string | null, options?: ITransaction.OperationOptions): this;
+    /**
+     * The columns repeated at the left of every page, or `null` when there are none.
+     *
+     * @remarks
+     * Office Scripts returns `undefined` here; this returns `null`.
+     */
+    getPrintTitleColumns(): ICellRange | null;
+    /**
+     * Sets the columns repeated at the left of every page, as entire columns (`'A:B'`). `null` or
+     * `""` clears them.
+     *
+     * @throws `Error` If the range is not one block of entire columns.
+     */
+    setPrintTitleColumns(printTitleColumns: ICellRange | string | null, options?: ITransaction.OperationOptions): this;
+    /**
+     * The manual page breaks before rows, in order.
+     *
+     * @remarks
+     * Breaks the print layout places by itself are not included.
+     */
+    getHorizontalPageBreaks(): IPageLayout.IPageBreak[];
+    /**
+     * The manual page breaks before columns, in order.
+     *
+     * @see {@link getHorizontalPageBreaks}
+     */
+    getVerticalPageBreaks(): IPageLayout.IPageBreak[];
+    /**
+     * Adds a page break before the top row of the range. A break already there is returned.
+     *
+     * @throws `Error` If the range starts on the first row, which no break can sit before.
+     */
+    addHorizontalPageBreak(pageBreakRange: ICellRange.Address, options?: ITransaction.OperationOptions): IPageLayout.IPageBreak;
+    /**
+     * Adds a page break before the left column of the range. A break already there is returned.
+     *
+     * @throws `Error` If the range starts on the first column, which no break can sit before.
+     */
+    addVerticalPageBreak(pageBreakRange: ICellRange.Address, options?: ITransaction.OperationOptions): IPageLayout.IPageBreak;
+    /**
+     * Removes every page break before a row.
+     */
+    removeAllHorizontalPageBreaks(options?: ITransaction.OperationOptions): this;
+    /**
+     * Removes every page break before a column.
+     */
+    removeAllVerticalPageBreaks(options?: ITransaction.OperationOptions): this;
+    /** For runtime type checking. */
+    readonly isIPageLayout: true;
+}
+/**
+ * {@inheritDoc IPageLayout}
+ * @see
+ * ### **Interface**
+ *
+ * {@link IPageLayout}
+ */
+export declare namespace IPageLayout {
+    /**
+     * The headers and footers of a sheet: one set for every page, or separate ones for the first
+     * page and for even pages.
+     *
+     * @remarks
+     * Shaped after Office Scripts' `HeaderFooterGroup`. Excel keeps one set for odd pages, which is
+     * also the set used for every page when even pages have none of their own, so
+     * {@link getDefaultForAllPages} and {@link getOddPages} return the same headers and footers.
+     */
+    interface IHeaderFooterGroup {
+        /**
+         * Which of the sets are used.
+         *
+         * @defaultValue {@link IPageLayout.HeaderFooterState.Default}
+         *
+         * @remarks
+         * Setting it does not clear the sets it stops using; they are kept, and used again when the
+         * state names them.
+         */
+        getState(): IPageLayout.HeaderFooterState;
+        /** @see {@link getState} */
+        setState(state: IPageLayout.HeaderFooterState, options?: ITransaction.OperationOptions): this;
+        /** The headers and footers used for every page the other sets do not cover. */
+        getDefaultForAllPages(): IHeaderFooter;
+        /** The headers and footers of odd pages. The same set as {@link getDefaultForAllPages}. */
+        getOddPages(): IHeaderFooter;
+        /** The headers and footers of even pages, used when the state includes odd and even pages. */
+        getEvenPages(): IHeaderFooter;
+        /** The headers and footers of the first page, used when the state includes the first page. */
+        getFirstPage(): IHeaderFooter;
+        /**
+         * Whether the headers and footers line up with the page's left and right margins.
+         *
+         * @defaultValue true
+         */
+        getUseSheetMargins(): boolean;
+        /** @see {@link getUseSheetMargins} */
+        setUseSheetMargins(useSheetMargins: boolean, options?: ITransaction.OperationOptions): this;
+        /**
+         * Whether the headers and footers scale with the sheet's print scale.
+         *
+         * @defaultValue true
+         */
+        getUseSheetScale(): boolean;
+        /** @see {@link getUseSheetScale} */
+        setUseSheetScale(useSheetScale: boolean, options?: ITransaction.OperationOptions): this;
+    }
+    /**
+     * One set of a header and a footer, each with a left, center and right section.
+     *
+     * @remarks
+     * Shaped after Office Scripts' `HeaderFooter`. Text uses Excel's codes: `&P` page number, `&N`
+     * page count, `&D` date, `&T` time, `&F` file name, `&A` sheet name, `&Z` file path, `&G` a
+     * picture, `&B` bold, `&I` italic, `&U` underline, `&"Font,Style"`, `&12` size, `&KFF0000` color,
+     * and `&&` for an ampersand.
+     *
+     * A header or footer is kept as one string, as Excel stores it, with `&L`, `&C` and `&R` marking
+     * where each section starts; {@link getHeader} returns it whole. Text before any section mark is
+     * the center section, and a section marked twice reads as its parts joined, which is how Excel
+     * reads them. A string is kept exactly as read until a section of it is set, when it is rebuilt in
+     * Excel's order: left, center, right.
+     */
+    interface IHeaderFooter {
+        /** The left section of the header. */
+        getLeftHeader(): string;
+        /** @see {@link getLeftHeader} */
+        setLeftHeader(leftHeader: string, options?: ITransaction.OperationOptions): this;
+        /** The center section of the header. */
+        getCenterHeader(): string;
+        /** @see {@link getCenterHeader} */
+        setCenterHeader(centerHeader: string, options?: ITransaction.OperationOptions): this;
+        /** The right section of the header. */
+        getRightHeader(): string;
+        /** @see {@link getRightHeader} */
+        setRightHeader(rightHeader: string, options?: ITransaction.OperationOptions): this;
+        /** The left section of the footer. */
+        getLeftFooter(): string;
+        /** @see {@link getLeftFooter} */
+        setLeftFooter(leftFooter: string, options?: ITransaction.OperationOptions): this;
+        /** The center section of the footer. */
+        getCenterFooter(): string;
+        /** @see {@link getCenterFooter} */
+        setCenterFooter(centerFooter: string, options?: ITransaction.OperationOptions): this;
+        /** The right section of the footer. */
+        getRightFooter(): string;
+        /** @see {@link getRightFooter} */
+        setRightFooter(rightFooter: string, options?: ITransaction.OperationOptions): this;
+        /**
+         * The whole header, sections and codes included (`&LPage &P&RDraft`); `""` when there is none.
+         *
+         * @remarks
+         * Office Scripts has no counterpart; it is the string Excel stores and openpyxl reads.
+         */
+        getHeader(): string;
+        /** Sets the whole header. `""` removes it. @see {@link getHeader} */
+        setHeader(header: string, options?: ITransaction.OperationOptions): this;
+        /** The whole footer. @see {@link getHeader} */
+        getFooter(): string;
+        /** Sets the whole footer. `""` removes it. @see {@link getHeader} */
+        setFooter(footer: string, options?: ITransaction.OperationOptions): this;
+    }
+    /**
+     * A manual page break.
+     *
+     * @remarks
+     * Shaped after Office Scripts' `PageBreak`. A break sits before a row (a horizontal break) or a
+     * column (a vertical one), and moves with that row or column: inserting rows above it moves it
+     * down, deleting rows above it moves it up, and deleting the row it sits before deletes it, as in
+     * Excel. Inserting or deleting cells that shift only part of a row leaves it where it is.
+     *
+     * The break is read when it is returned; it does not follow later edits. Ask the layout again.
+     */
+    interface IPageBreak {
+        /** The row the break sits before, for a horizontal break; the first row it spans, for a vertical one. */
+        getRowIndex(): number;
+        /** The column the break sits before, for a vertical break; the first column it spans, for a horizontal one. */
+        getColumnIndex(): number;
+        /** The first cell after the break. */
+        getCellAfterBreak(): ICellRange;
+        /** Removes the break. */
+        delete(options?: ITransaction.OperationOptions): void;
+    }
+    /** The orientation of a printed page. */
+    const Orientation: {
+        readonly Portrait: "portrait";
+        readonly Landscape: "landscape";
+    };
+    type Orientation = typeof Orientation[keyof typeof Orientation];
+    /**
+     * The paper sizes with a name, after Office Scripts' `PaperType`. Each is also a number in the
+     * file ({@link IPageLayout.getPaperSizeCode}).
+     */
+    const PaperType: {
+        readonly Letter: "letter";
+        readonly LetterSmall: "letterSmall";
+        readonly Tabloid: "tabloid";
+        readonly Ledger: "ledger";
+        readonly Legal: "legal";
+        readonly Statement: "statement";
+        readonly Executive: "executive";
+        readonly A3: "a3";
+        readonly A4: "a4";
+        readonly A4Small: "a4Small";
+        readonly A5: "a5";
+        readonly B4: "b4";
+        readonly B5: "b5";
+        readonly Folio: "folio";
+        readonly Quatro: "quatro";
+        readonly Paper10x14: "paper10x14";
+        readonly Paper11x17: "paper11x17";
+        readonly Note: "note";
+        readonly Envelope9: "envelope9";
+        readonly Envelope10: "envelope10";
+        readonly Envelope11: "envelope11";
+        readonly Envelope12: "envelope12";
+        readonly Envelope14: "envelope14";
+        readonly Csheet: "csheet";
+        readonly Dsheet: "dsheet";
+        readonly Esheet: "esheet";
+        readonly EnvelopeDL: "envelopeDL";
+        readonly EnvelopeC5: "envelopeC5";
+        readonly EnvelopeC3: "envelopeC3";
+        readonly EnvelopeC4: "envelopeC4";
+        readonly EnvelopeC6: "envelopeC6";
+        readonly EnvelopeC65: "envelopeC65";
+        readonly EnvelopeB4: "envelopeB4";
+        readonly EnvelopeB5: "envelopeB5";
+        readonly EnvelopeB6: "envelopeB6";
+        readonly EnvelopeItaly: "envelopeItaly";
+        readonly EnvelopeMonarch: "envelopeMonarch";
+        readonly EnvelopePersonal: "envelopePersonal";
+        readonly FanfoldUS: "fanfoldUS";
+        readonly FanfoldStdGerman: "fanfoldStdGerman";
+        readonly FanfoldLegalGerman: "fanfoldLegalGerman";
+    };
+    type PaperType = typeof PaperType[keyof typeof PaperType];
+    /** The order pages are printed in. */
+    const PrintOrder: {
+        /** Down the columns of pages first, then across. */
+        readonly DownThenOver: "downThenOver";
+        /** Across the rows of pages first, then down. */
+        readonly OverThenDown: "overThenDown";
+    };
+    type PrintOrder = typeof PrintOrder[keyof typeof PrintOrder];
+    /** Whether and where notes are printed. */
+    const PrintComments: {
+        readonly NoComments: "noComments";
+        /** Together, at the end of the sheet. */
+        readonly EndSheet: "endSheet";
+        /** Where they are shown on the sheet. */
+        readonly InPlace: "inPlace";
+    };
+    type PrintComments = typeof PrintComments[keyof typeof PrintComments];
+    /** How cells holding an error are printed. */
+    const PrintErrorType: {
+        readonly AsDisplayed: "asDisplayed";
+        readonly Blank: "blank";
+        readonly Dash: "dash";
+        /** As `#N/A`. */
+        readonly NotAvailable: "notAvailable";
+    };
+    type PrintErrorType = typeof PrintErrorType[keyof typeof PrintErrorType];
+    /** The unit {@link IPageLayout.setPrintMargins} reads margins in. */
+    const PrintMarginUnit: {
+        readonly Points: "points";
+        readonly Inches: "inches";
+        readonly Centimeters: "centimeters";
+    };
+    type PrintMarginUnit = typeof PrintMarginUnit[keyof typeof PrintMarginUnit];
+    /** Which sets of headers and footers are used. */
+    const HeaderFooterState: {
+        /** One set for every page. */
+        readonly Default: "default";
+        /** The first page's own, then one set for the rest. */
+        readonly FirstAndDefault: "firstAndDefault";
+        /** One set for odd pages and one for even pages. */
+        readonly OddAndEven: "oddAndEven";
+        /** The first page's own, then odd and even pages. */
+        readonly FirstOddAndEven: "firstOddAndEven";
+    };
+    type HeaderFooterState = typeof HeaderFooterState[keyof typeof HeaderFooterState];
+    /**
+     * How a sheet is scaled when printed. Either a scale, or one or both page counts.
+     */
+    interface ZoomOptions {
+        /** The print scale, a percentage from 10 to 400. */
+        scale?: number;
+        /** How many pages wide to fit the sheet to; `0` for as many as it needs. */
+        horizontalFitToPages?: number;
+        /** How many pages tall to fit the sheet to; `0` for as many as it needs. */
+        verticalFitToPages?: number;
+    }
+    /** Page margins, in the unit they are set in. */
+    interface MarginOptions {
+        top?: number;
+        bottom?: number;
+        left?: number;
+        right?: number;
+        header?: number;
+        footer?: number;
+    }
+    /** The page margins as JSON, in inches. */
+    interface MarginsJSON {
+        top: number;
+        bottom: number;
+        left: number;
+        right: number;
+        header: number;
+        footer: number;
+    }
+    /**
+     * The headers and footers as JSON. Each header and footer is the whole string, with its section
+     * and formatting codes, as Excel stores it.
+     */
+    interface HeaderFooterJSON {
+        oddHeader?: string;
+        oddFooter?: string;
+        evenHeader?: string;
+        evenFooter?: string;
+        firstHeader?: string;
+        firstFooter?: string;
+        /** Even pages use their own set. */
+        differentOddEven?: boolean;
+        /** The first page uses its own set. */
+        differentFirst?: boolean;
+        /** The headers and footers do not scale with the sheet. */
+        ignoreSheetScale?: boolean;
+        /** The headers and footers do not line up with the page margins. */
+        ignoreSheetMargins?: boolean;
+    }
+    /**
+     * A page break as JSON.
+     *
+     * @remarks
+     * `index` is the row (or column) the break sits before. `min` and `max` are the columns (or rows)
+     * it spans; Excel writes the whole sheet, or the print area's extent for a break made inside one.
+     */
+    interface BreakJSON {
+        index: number;
+        min?: number;
+        max?: number;
+        /** Placed by the print layout, not by the user. Kept, but not one of the sheet's page breaks. */
+        automatic?: boolean;
+        /** Placed by a pivot table. */
+        pivot?: boolean;
+    }
+    /**
+     * A JSON representation useful for persistence. An absent value is its default.
+     */
+    interface JSON {
+        orientation?: Orientation;
+        /** The paper size as the file numbers it. Absent, letter (`1`). */
+        paperSize?: number;
+        /** A paper size given as measurements (`'297mm'`) instead of {@link paperSize}. */
+        paperHeight?: string;
+        /** @see {@link paperHeight} */
+        paperWidth?: string;
+        /** Absent, 100. */
+        scale?: number;
+        /** Fit to {@link fitToWidth} by {@link fitToHeight} pages rather than print at {@link scale}. */
+        fitToPage?: boolean;
+        /** Absent, 1. */
+        fitToWidth?: number;
+        /** Absent, 1. */
+        fitToHeight?: number;
+        firstPageNumber?: number;
+        /** {@link firstPageNumber} is printed on the first page instead of automatic numbering. */
+        useFirstPageNumber?: boolean;
+        printOrder?: PrintOrder;
+        blackAndWhite?: boolean;
+        draftMode?: boolean;
+        printComments?: PrintComments;
+        printErrors?: PrintErrorType;
+        horizontalDpi?: number;
+        verticalDpi?: number;
+        copies?: number;
+        /** The printer's defaults are not used for the settings the sheet leaves out. */
+        ignorePrinterDefaults?: boolean;
+        /** Absent, Excel's defaults: 0.7 inch left and right, 0.75 top and bottom, 0.3 header and footer. */
+        margins?: MarginsJSON;
+        centerHorizontally?: boolean;
+        centerVertically?: boolean;
+        printGridlines?: boolean;
+        printHeadings?: boolean;
+        /** The automatic page breaks are not shown on the sheet. */
+        hideAutoPageBreaks?: boolean;
+        headerFooter?: HeaderFooterJSON;
+        /** Breaks before rows, in order. */
+        rowBreaks?: BreakJSON[];
+        /** Breaks before columns, in order. */
+        columnBreaks?: BreakJSON[];
+        /**
+         * The printer's own settings, as the file carried them. Opaque.
+         */
+        printerSettings?: IEmbeddedPart.JSON;
+    }
+}
+//# sourceMappingURL=IPageLayout.d.ts.map