SheetXL - v1.0.2
    Preparing search index...

    Interface JSON

    JSON representation of a pivot table.

    interface JSON {
        autoFitColumns?: false;
        cacheId: number;
        columnFields?: number[];
        columnGrandTotals?: false;
        columnHeaderCaption?: string;
        columnLines?: PivotLineJSON[];
        conditionalFormats?: PivotConditionalFormatJSON[];
        dataFields?: DataFieldJSON[];
        emptyCaption?: string;
        errorCaption?: string;
        fields?: PivotFieldJSON[];
        filters?: PivotFilterJSON[];
        form?: PivotForm;
        formats?: PivotFormatJSON[];
        grandTotalCaption?: string;
        header?: PivotHeaderJSON;
        hiddenDrillIndicators?: true;
        hiddenFieldHeaders?: true;
        indent?: number;
        location: string;
        multipleFiltersPerField?: true;
        name?: string;
        pageFields?: PageFieldJSON[];
        pageOverThenDown?: true;
        pageWrap?: number;
        part?: IEmbeddedPart.JSON;
        preserveFormatting?: false;
        rest?: string;
        rowFields?: number[];
        rowGrandTotals?: false;
        rowHeaderCaption?: string;
        rowLines?: PivotLineJSON[];
        showEmpty?: false;
        showError?: true;
        style?: PivotStyleJSON;
        valuesCaption?: string;
        valuesOnRows?: true;
        valuesPosition?: number;
    }
    Index
    autoFitColumns? cacheId columnFields? columnGrandTotals? columnHeaderCaption? columnLines? conditionalFormats? dataFields? emptyCaption? errorCaption? fields? filters? form? formats? grandTotalCaption? header? hiddenDrillIndicators? hiddenFieldHeaders? indent? location multipleFiltersPerField? name? pageFields? pageOverThenDown? pageWrap? part? preserveFormatting? rest? rowFields? rowGrandTotals? rowHeaderCaption? rowLines? showEmpty? showError? style? valuesCaption? valuesOnRows? valuesPosition?
    autoFitColumns?: false

    false: a layout leaves the columns' widths alone; absent, it fits the columns the table covers.

    cacheId: number
    columnFields?: number[]

    The fields on the column axis, outermost first, by index; -2 is where the values sit.

    columnGrandTotals?: false

    Shown unless false.

    columnHeaderCaption?: string

    The caption over the column labels in compact form; absent, Column Labels.

    columnLines?: PivotLineJSON[]

    The lines of the columns as last laid out, left to right; absent, not laid out.

    conditionalFormats?: PivotConditionalFormatJSON[]

    The table's conditional formats: which sheet rule applies where in the table.

    dataFields?: DataFieldJSON[]
    emptyCaption?: string

    Shown in a crossing no record falls in, unless showEmpty is false.

    errorCaption?: string

    Shown in place of an error value when showError is true.

    fields?: PivotFieldJSON[]

    One per field of the cache, in the cache's order.

    A table is modeled when its markup holds nothing the model does not type yet on the elements it reads (OLAP hierarchies, item properties, extensions on a field or data field other than Excel's own repeat labels and show-values-as); it is then written from the model once it has no part.

    filters?: PivotFilterJSON[]

    The label, value and date filters, in the order they apply.

    form?: PivotForm

    The layout of fields added to the table and of the values; absent, compact. Each field keeps its own (PivotFieldJSON.form).

    formats?: PivotFormatJSON[]

    The formats a user put on parts of the table, in the order they apply.

    grandTotalCaption?: string

    The caption of the grand totals; absent, Grand Total.

    header?: PivotHeaderJSON

    Where the laid-out parts start; absent, not laid out.

    hiddenDrillIndicators?: true

    The items' expand/collapse buttons are hidden; absent, shown.

    hiddenFieldHeaders?: true

    The field captions and their buttons are hidden; absent, shown.

    indent?: number

    How far each level of a compact row field is indented, in characters past the first; absent, 0.

    location: string

    The cells the table's body is laid out on, as an A1 range (A3:C20): where it is anchored. Its page fields sit above it.

    multipleFiltersPerField?: true

    A field takes more than one filter; absent, a new filter on a field replaces its last.

    name?: string
    pageFields?: PageFieldJSON[]
    pageOverThenDown?: true

    The page fields run across, then down; absent, down, then across.

    pageWrap?: number

    How many page fields sit in a row (or a column) before the next; absent, 0, no wrap.

    part?: IEmbeddedPart.JSON
    preserveFormatting?: false

    false: a refresh drops the formats a user put on the table's cells; absent, they follow their areas.

    rest?: string

    The definition's markup with what is modeled taken out: anything not typed yet.

    rowFields?: number[]

    The fields on the row axis, outermost first, by index; -2 is where the values sit.

    rowGrandTotals?: false

    Shown unless false.

    rowHeaderCaption?: string

    The caption over the row labels in compact form; absent, Row Labels.

    rowLines?: PivotLineJSON[]

    The lines of the rows as last laid out, top to bottom; absent, not laid out.

    showEmpty?: false

    false: a crossing no record falls in shows 0 rather than emptyCaption.

    showError?: true

    An error value shows as errorCaption.

    style?: PivotStyleJSON

    The table style and which of its parts show; absent, no style.

    valuesCaption?: string

    The caption of the values field; absent, Values.

    valuesOnRows?: true

    The values are laid out down the rows, or are to be with a second; their position is -2 in rowFields.

    valuesPosition?: number

    Below two values, where a second puts them among the fields of their axis, counted from 0; absent, after the last.

    Settings
    Member Visibility

    On This Page
    Properties