Interface IValuesField

Where a table's values sit among the fields of an axis, with two or more of them.

Remarks

A view of the table. While a table has fewer than two values they sit nowhere, and the table keeps the axis and the place for the next.

interface IValuesField {
    isIPivotValuesField: true;
    getAxis(): IPivotTable.Axis | null;
    getName(): string;
    getPivotTable(): IPivotTable;
    getPosition(): number | null;
    setAxis(
        axis: IPivotTable.Axis | null,
        position?: number,
        options?: ITransaction.OperationOptions,
    ): Promise<void>;
    setName(
        name: string,
        options?: ITransaction.OperationOptions,
    ): Promise<void>;
    setPosition(
        position: number,
        options?: ITransaction.OperationOptions,
    ): Promise<void>;
}

Index

Properties

isIPivotValuesField

Methods

getAxis getName getPivotTable getPosition setAxis setName setPosition

Properties

`Readonly`isIPivotValuesField

isIPivotValuesField: true

For runtime type checking.

Methods

getAxis

getAxis(): IPivotTable.Axis | null

Returns the axis the values are on; null once they have gone.

Returns IPivotTable.Axis | null

getName

getName(): string

Returns its caption.

Returns string

getPivotTable

getPivotTable(): IPivotTable

Returns the table it belongs to.

Returns IPivotTable

getPosition

getPosition(): number | null

Returns its place among the fields of its axis, counted from 1; null once the values have gone.

Returns number | null

setAxis

setAxis(
    axis: IPivotTable.Axis | null,
    position?: number,
    options?: ITransaction.OperationOptions,
): Promise<void>
Moves the values to the rows or the columns, as one step that can be undone; null deletes every value.
Parameters
- axis: IPivotTable.Axis | null
- Optionalposition: number
  Its place, counted from 1, among the axis's fields; absent, after the last, and nothing when it is on axis.
- Optionaloptions: ITransaction.OperationOptions
Returns Promise<void>

Throws
ExpectedError For the page axis, the values, or a position not on the axis.

setName

setName(name: string, options?: ITransaction.OperationOptions): Promise<void>
Changes its caption, which no field or value of the table can have, without regard to case.
Parameters
- name: string
- Optionaloptions: ITransaction.OperationOptions
Returns Promise<void>

Throws
ExpectedError For a caption taken.

setPosition

setPosition(
position: number,
options?: ITransaction.OperationOptions,
): Promise<void>
Moves it along its axis, as one step that can be undone.
Parameters
- position: number
  Its place, counted from 1.
- Optionaloptions: ITransaction.OperationOptions
Returns Promise<void>

Throws
ExpectedError For a position not on the axis, or once the values have gone.