SheetXL - v1.0.2
    Preparing search index...

    Interface IPageBreak

    A manual page break.

    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 {
        delete(options?: ITransaction.OperationOptions): void;
        getCellAfterBreak(): ICellRange;
        getColumnIndex(): number;
        getRowIndex(): number;
    }
    Index
    delete getCellAfterBreak getColumnIndex getRowIndex

    • The column the break sits before, for a vertical break; the first column it spans, for a horizontal one.

      Returns number

    • The row the break sits before, for a horizontal break; the first row it spans, for a vertical one.

      Returns number

    Settings
    Member Visibility

    On This Page
    Methods