SheetXL - v1.0.2
    Preparing search index...

    Interface IItem

    An item of a pivot field: a value of its cache field, as the table lists it.

    interface IItem {
        isIPivotItem: true;
        getField(): IPivotTable.IField;
        getName(): string;
        getPosition(): number | null;
        isExpanded(): boolean;
        isVisible(): boolean;
        setExpanded(
            expanded: boolean,
            options?: ITransaction.OperationOptions,
        ): Promise<void>;
        setName(
            name: string,
            options?: ITransaction.OperationOptions,
        ): Promise<void>;
        setPosition(
            position: number,
            options?: ITransaction.OperationOptions,
        ): Promise<void>;
        setVisible(
            visible: boolean,
            options?: ITransaction.OperationOptions,
        ): Promise<void>;
    }
    Index
    isIPivotItem
    getField getName getPosition isExpanded isVisible setExpanded setName setPosition setVisible
    isIPivotItem: true

    For runtime type checking.

    • Returns the item's caption: its own name in the table, else its value as text; (blank) for the blank item.

      Returns string

    • Returns the item's place among the items of its field that show, counted from 1; null for a hidden item, or when the field is off the table.

      Returns number | null

    • Returns whether the item's details show: false when it is collapsed.

      Returns boolean

    • Returns whether the item shows: false when it is hidden from the field.

      Returns boolean

    • Shows or hides the item's details, as one step that can be undone.

      Parameters

      Returns Promise<void>

      An item of the innermost field takes the setting, which shows nothing different, as in Excel.

      When the field is not a row or column field.

    • Renames the item in the table, as one step that can be undone; its value's own text restores the original.

      Parameters

      Returns Promise<void>

      The name is kept as given, spaces and all, and may be empty. Under a sort by label the field is sorted again, by the captions, as in Excel. GETPIVOTDATA finds the item by the caption or by its value, and IField.getItem by the caption alone.

      ExpectedError When another item of the field has the name, without regard to case.

    • Moves the item among the items of its field that show, as one step that can be undone.

      Parameters

      Returns Promise<void>

      The field's order is then by hand: a sort it had, by label or by value, ends, as in Excel, and the order holds through a refresh. The page pick, a sort by the item's line, a base item and the formats on the item follow it.

      ExpectedError For a hidden item or a field off the table, and for a position not among the items that show.

    • Shows or hides the item, as one step that can be undone.

      Parameters

      Returns Promise<void>

      When it is the last item showing.

    Settings
    Member Visibility

    On This Page
    Properties
    Methods