ExcelScript.PivotTable interface

Представляет сводную таблицу Excel. Чтобы узнать больше об объектной модели сводной таблицы, читайте работу со сводными таблицами с помощью API JavaScript для Excel.

Методы

addColumnHierarchy(pivotHierarchy)

Добавляет PivotHierarchy к текущей оси. Если иерархия присутствует в другом месте строки, столбца или оси фильтра, она будет удалена из этого расположения.

addDataHierarchy(pivotHierarchy)

Добавляет PivotHierarchy к текущей оси.

addFilterHierarchy(pivotHierarchy)

Добавляет PivotHierarchy к текущей оси. Если иерархия присутствует в другом месте строки, столбца или оси фильтра, она будет удалена из этого расположения.

addRowHierarchy(pivotHierarchy)

Добавляет PivotHierarchy к текущей оси. Если иерархия присутствует в другом месте строки, столбца или оси фильтра, она будет удалена из этого расположения.

delete()

Удаляет сводную таблицу.

getColumnHierarchies()

Иерархии сводных столбцов сводной таблицы.

getColumnHierarchy(name)

Получает RowColumnPivotHierarchy по имени. Если RowColumnPivotHierarchy не существует, возвращает пустой объект.

getDataHierarchies()

Иерархии сводных данных сводной таблицы.

getDataHierarchy(name)

Получает DataPivotHierarchy по имени. Если DataPivotHierarchy не существует, возвращает пустой объект.

getEnableDataValueEditing()

Указывает, позволяет ли Сводная таблица изменять значения в основном тексте данных пользователем.

getFilterHierarchies()

Иерархии сводных фильтров сводной таблицы.

getFilterHierarchy(name)

Получает FilterPivotHierarchy по имени. Если FilterPivotHierarchy не существует, возвращает пустой объект.

getHierarchies()

Иерархии сводного документа сводной таблицы.

getHierarchy(name)

Получает PivotHierarchy по имени. Если PivotHierarchy не существует, возвращает пустой объект.

getId()

Идентификатор сводной таблицы.

getLayout()

PivotLayout, описывающий макет и визуальную структуру сводной таблицы.

getName()

Имя сводной таблицы.

getRowHierarchies()

Иерархии сводных строк сводной таблицы.

getRowHierarchy(name)

Получает RowColumnPivotHierarchy по имени. Если RowColumnPivotHierarchy не существует, возвращает пустой объект.

getUseCustomSortLists()

Указывает, используются ли в сводной таблице настраиваемые списки при сортировке.

getWorksheet()

Лист, содержащий текущую сводную таблицу.

refresh()

Обновляет сводную таблицу.

removeColumnHierarchy(rowColumnPivotHierarchy)

Удаляет PivotHierarchy из текущей оси.

removeDataHierarchy(DataPivotHierarchy)

Удаляет PivotHierarchy из текущей оси.

removeFilterHierarchy(filterPivotHierarchy)

Удаляет PivotHierarchy из текущей оси.

removeRowHierarchy(rowColumnPivotHierarchy)

Удаляет PivotHierarchy из текущей оси.

setEnableDataValueEditing(enableDataValueEditing)

Указывает, позволяет ли Сводная таблица изменять значения в основном тексте данных пользователем.

setName(name)

Имя сводной таблицы.

setUseCustomSortLists(useCustomSortLists)

Указывает, используются ли в сводной таблице настраиваемые списки при сортировке.

Сведения о методе

addColumnHierarchy(pivotHierarchy)

Добавляет PivotHierarchy к текущей оси. Если иерархия присутствует в другом месте строки, столбца или оси фильтра, она будет удалена из этого расположения.

addColumnHierarchy(
            pivotHierarchy: PivotHierarchy
        ): RowColumnPivotHierarchy;

Параметры

pivotHierarchy
PivotHierarchy

Возвращаемое значение

addDataHierarchy(pivotHierarchy)

Добавляет PivotHierarchy к текущей оси.

addDataHierarchy(pivotHierarchy: PivotHierarchy): DataPivotHierarchy;

Параметры

pivotHierarchy
PivotHierarchy

Возвращаемое значение

addFilterHierarchy(pivotHierarchy)

Добавляет PivotHierarchy к текущей оси. Если иерархия присутствует в другом месте строки, столбца или оси фильтра, она будет удалена из этого расположения.

addFilterHierarchy(
            pivotHierarchy: PivotHierarchy
        ): FilterPivotHierarchy;

Параметры

pivotHierarchy
PivotHierarchy

Возвращаемое значение

addRowHierarchy(pivotHierarchy)

Добавляет PivotHierarchy к текущей оси. Если иерархия присутствует в другом месте строки, столбца или оси фильтра, она будет удалена из этого расположения.

addRowHierarchy(
            pivotHierarchy: PivotHierarchy
        ): RowColumnPivotHierarchy;

Параметры

pivotHierarchy
PivotHierarchy

Возвращаемое значение

delete()

Удаляет сводную таблицу.

delete(): void;

Возвращаемое значение

void

getColumnHierarchies()

Иерархии сводных столбцов сводной таблицы.

getColumnHierarchies(): RowColumnPivotHierarchy[];

Возвращаемое значение

getColumnHierarchy(name)

Получает RowColumnPivotHierarchy по имени. Если RowColumnPivotHierarchy не существует, возвращает пустой объект.

getColumnHierarchy(name: string): RowColumnPivotHierarchy | undefined;

Параметры

name
string

Имя извлекаемого RowColumnPivotHierarchy.

Возвращаемое значение

getDataHierarchies()

Иерархии сводных данных сводной таблицы.

getDataHierarchies(): DataPivotHierarchy[];

Возвращаемое значение

getDataHierarchy(name)

Получает DataPivotHierarchy по имени. Если DataPivotHierarchy не существует, возвращает пустой объект.

getDataHierarchy(name: string): DataPivotHierarchy | undefined;

Параметры

name
string

Имя извлекаемого DataPivotHierarchy.

Возвращаемое значение

DataPivotHierarchy | undefined

getEnableDataValueEditing()

Указывает, позволяет ли Сводная таблица изменять значения в основном тексте данных пользователем.

getEnableDataValueEditing(): boolean;

Возвращаемое значение

boolean

getFilterHierarchies()

Иерархии сводных фильтров сводной таблицы.

getFilterHierarchies(): FilterPivotHierarchy[];

Возвращаемое значение

getFilterHierarchy(name)

Получает FilterPivotHierarchy по имени. Если FilterPivotHierarchy не существует, возвращает пустой объект.

getFilterHierarchy(name: string): FilterPivotHierarchy | undefined;

Параметры

name
string

Имя извлекаемого FilterPivotHierarchy.

Возвращаемое значение

FilterPivotHierarchy | undefined

getHierarchies()

Иерархии сводного документа сводной таблицы.

getHierarchies(): PivotHierarchy[];

Возвращаемое значение

getHierarchy(name)

Получает PivotHierarchy по имени. Если PivotHierarchy не существует, возвращает пустой объект.

getHierarchy(name: string): PivotHierarchy | undefined;

Параметры

name
string

Имя извлекаемого PivotHierarchy.

Возвращаемое значение

PivotHierarchy | undefined

getId()

Идентификатор сводной таблицы.

getId(): string;

Возвращаемое значение

string

getLayout()

PivotLayout, описывающий макет и визуальную структуру сводной таблицы.

getLayout(): PivotLayout;

Возвращаемое значение

getName()

Имя сводной таблицы.

getName(): string;

Возвращаемое значение

string

getRowHierarchies()

Иерархии сводных строк сводной таблицы.

getRowHierarchies(): RowColumnPivotHierarchy[];

Возвращаемое значение

getRowHierarchy(name)

Получает RowColumnPivotHierarchy по имени. Если RowColumnPivotHierarchy не существует, возвращает пустой объект.

getRowHierarchy(name: string): RowColumnPivotHierarchy | undefined;

Параметры

name
string

Имя извлекаемого RowColumnPivotHierarchy.

Возвращаемое значение

getUseCustomSortLists()

Указывает, используются ли в сводной таблице настраиваемые списки при сортировке.

getUseCustomSortLists(): boolean;

Возвращаемое значение

boolean

getWorksheet()

Лист, содержащий текущую сводную таблицу.

getWorksheet(): Worksheet;

Возвращаемое значение

refresh()

Обновляет сводную таблицу.

refresh(): void;

Возвращаемое значение

void

removeColumnHierarchy(rowColumnPivotHierarchy)

Удаляет PivotHierarchy из текущей оси.

removeColumnHierarchy(
            rowColumnPivotHierarchy: RowColumnPivotHierarchy
        ): void;

Параметры

rowColumnPivotHierarchy
RowColumnPivotHierarchy

Возвращаемое значение

void

removeDataHierarchy(DataPivotHierarchy)

Удаляет PivotHierarchy из текущей оси.

removeDataHierarchy(DataPivotHierarchy: DataPivotHierarchy): void;

Параметры

DataPivotHierarchy
DataPivotHierarchy

Возвращаемое значение

void

removeFilterHierarchy(filterPivotHierarchy)

Удаляет PivotHierarchy из текущей оси.

removeFilterHierarchy(filterPivotHierarchy: FilterPivotHierarchy): void;

Параметры

filterPivotHierarchy
FilterPivotHierarchy

Возвращаемое значение

void

removeRowHierarchy(rowColumnPivotHierarchy)

Удаляет PivotHierarchy из текущей оси.

removeRowHierarchy(
            rowColumnPivotHierarchy: RowColumnPivotHierarchy
        ): void;

Параметры

rowColumnPivotHierarchy
RowColumnPivotHierarchy

Возвращаемое значение

void

setEnableDataValueEditing(enableDataValueEditing)

Указывает, позволяет ли Сводная таблица изменять значения в основном тексте данных пользователем.

setEnableDataValueEditing(enableDataValueEditing: boolean): void;

Параметры

enableDataValueEditing
boolean

Возвращаемое значение

void

setName(name)

Имя сводной таблицы.

setName(name: string): void;

Параметры

name
string

Возвращаемое значение

void

setUseCustomSortLists(useCustomSortLists)

Указывает, используются ли в сводной таблице настраиваемые списки при сортировке.

setUseCustomSortLists(useCustomSortLists: boolean): void;

Параметры

useCustomSortLists
boolean

Возвращаемое значение

void