SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface IPivotTable

    Interface for working with a pivot table — a summary of source data laid out on a sheet.

    Read-only for now: the table is carried as it was read and written back unchanged, which also means its location does not follow rows and columns that are inserted or deleted. IPivotTable.getXML is the read-only view of that markup.

    interface IPivotTable {
        isIPivotTable: true;
        getName(): string;
        getSheet(): ISheet;
        getXML(): string | null;
    }
    Index
    isIPivotTable
    getName getSheet getXML
    isIPivotTable: true

    For runtime type checking.

    • Returns the name of the pivot table.

      Returns string

      Unique within the workbook, as Excel keeps it.

    • Returns the sheet the pivot table is laid out on.

      Returns ISheet

    • Returns the pivot table's own markup, or null if none was captured.

      Returns string | null

      Read-only, and the one escape hatch for what the table does not model yet: it is the <pivotTableDefinition> the table was read from, not its cache. It will be removed when the table is modeled.

    Settings
    Member Visibility

    On This Page
    Properties
    Methods