Excel.PivotField class
Представляет поле сводных данных Excel.
- Extends
Комментарии
Используется
Свойства
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| id | Идентификатор поля сводных таблиц. |
| items | Возвращает элементы сводных таблиц, связанные с полем сводки. |
| name | Имя сводного поля. |
| show |
Определяет, следует ли отображать все элементы сводного поля. |
| subtotals | Промежуточные итоги сводного поля. |
Методы
| apply |
Устанавливает один или несколько текущих фильтров сводных фильтров поля и применяет их к полю. Если предоставленные фильтры недопустимы или не могут быть применены, создается исключение. |
| clear |
Удаляет все условия из всех фильтров поля. Это удалит любую активную фильтрацию в поле. |
| clear |
Удаляет все существующие условия из фильтра поля данного типа (если он применяется в данный момент). |
| clear |
Удаляет все существующие условия из фильтра поля данного типа (если он применяется в данный момент). |
| get |
Получает все фильтры, примененные к этому полю. |
| is |
Проверяет, есть ли в поле примененные фильтры. |
| is |
Проверяет, есть ли в поле примененные фильтры. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа. |
| set(properties) | Одновременно задает несколько свойств объекта на основе существующего загруженного объекта. |
| sort |
Сортирует сводное поле. Если указан параметр DataPivotHierarchy, то сортировка будет применяться на его основе, в ином случае сортировка будет основана на самом сводном поле. |
| sort |
Сортирует сводную таблицу по указанным значениям в определенной области. Область определяет, какие конкретные значения будут использоваться для сортировки при наличии нескольких значений из одной и той же DataPivotHierarchy. |
| sort |
Сортирует сводную таблицу по указанным значениям в определенной области. Область определяет, какие конкретные значения будут использоваться для сортировки при наличии нескольких значений из одной и той же DataPivotHierarchy. |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
id
Идентификатор поля сводных таблиц.
readonly id: string;Значение свойства
string
Комментарии
items
Возвращает элементы сводных таблиц, связанные с полем сводки.
readonly items: Excel.PivotItemCollection;Значение свойства
Комментарии
name
showAllItems
Определяет, следует ли отображать все элементы сводного поля.
showAllItems: boolean;Значение свойства
boolean
Комментарии
subtotals
Промежуточные итоги сводного поля.
subtotals: Excel.Subtotals;Значение свойства
Комментарии
Сведения о методе
applyFilter(filter)
Устанавливает один или несколько текущих фильтров сводных фильтров поля и применяет их к полю. Если предоставленные фильтры недопустимы или не могут быть применены, создается исключение.
applyFilter(filter: Excel.PivotFilters): void;Параметры
- filter
- Excel.PivotFilters
Настроенный специальный фильтр PivotFilter или интерфейс PivotFilter, содержащий несколько настроенных фильтров.
Возвращаемое значение
void
Комментарии
clearAllFilters()
Удаляет все условия из всех фильтров поля. Это удалит любую активную фильтрацию в поле.
clearAllFilters(): void;Возвращаемое значение
void
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotfilters.yaml
await Excel.run(async (context) => {
// Clear all the PivotFilters.
// Get the PivotTable.
const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
pivotTable.hierarchies.load("name");
await context.sync();
// Clear the filters on each PivotField.
pivotTable.hierarchies.items.forEach((hierarchy) => {
hierarchy.fields.getItem(hierarchy.name).clearAllFilters();
});
await context.sync();
});
clearFilter(filterType)
Удаляет все существующие условия из фильтра поля данного типа (если он применяется в данный момент).
clearFilter(filterType: Excel.PivotFilterType): void;Параметры
- filterType
- Excel.PivotFilterType
Тип фильтра, в поле которого очищаются все условия.
Возвращаемое значение
void
Комментарии
clearFilter(filterType)
Удаляет все существующие условия из фильтра поля данного типа (если он применяется в данный момент).
clearFilter(filterType: "Unknown" | "Value" | "Manual" | "Label" | "Date"): void;Параметры
- filterType
-
"Unknown" | "Value" | "Manual" | "Label" | "Date"
Тип фильтра, в поле которого очищаются все условия.
Возвращаемое значение
void
Комментарии
getFilters()
Получает все фильтры, примененные к этому полю.
getFilters(): OfficeExtension.ClientResult<Excel.PivotFilters>;Возвращаемое значение
интерфейс PivotFilters со всеми активными фильтрами.
Комментарии
isFiltered(filterType)
Проверяет, есть ли в поле примененные фильтры.
isFiltered(filterType?: Excel.PivotFilterType): OfficeExtension.ClientResult<boolean>;Параметры
- filterType
- Excel.PivotFilterType
Тип фильтра для проверки. Если тип не указан, этот метод будет проверка при применении какого-либо фильтра.
Возвращаемое значение
OfficeExtension.ClientResult<boolean>
True, если к полю применен фильтр типа filterType . Если filterType значение не указано, возвращается, true если в поле присутствуют примененные фильтры.
Комментарии
isFiltered(filterType)
Проверяет, есть ли в поле примененные фильтры.
isFiltered(filterType?: "Unknown" | "Value" | "Manual" | "Label" | "Date"): OfficeExtension.ClientResult<boolean>;Параметры
- filterType
-
"Unknown" | "Value" | "Manual" | "Label" | "Date"
Тип фильтра для проверки. Если тип не указан, этот метод будет проверка при применении какого-либо фильтра.
Возвращаемое значение
OfficeExtension.ClientResult<boolean>
True, если к полю применен фильтр типа filterType . Если filterType значение не указано, возвращается, true если в поле присутствуют примененные фильтры.
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.PivotFieldLoadOptions): Excel.PivotField;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.PivotField;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.PivotField;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties: Interfaces.PivotFieldUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Excel.Interfaces.PivotFieldUpdateData
Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.
Возвращаемое значение
void
set(properties)
Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
set(properties: Excel.PivotField): void;Параметры
- properties
- Excel.PivotField
Возвращаемое значение
void
sortByLabels(sortBy)
Сортирует сводное поле. Если указан параметр DataPivotHierarchy, то сортировка будет применяться на его основе, в ином случае сортировка будет основана на самом сводном поле.
sortByLabels(sortBy: SortBy): void;Параметры
- sortBy
- Excel.SortBy
Указывает, в каком порядке производится сортировка: по возрастанию или по убыванию.
Возвращаемое значение
void
Комментарии
sortByValues(sortBy, valuesHierarchy, pivotItemScope)
Сортирует сводную таблицу по указанным значениям в определенной области. Область определяет, какие конкретные значения будут использоваться для сортировки при наличии нескольких значений из одной и той же DataPivotHierarchy.
sortByValues(sortBy: Excel.SortBy, valuesHierarchy: Excel.DataPivotHierarchy, pivotItemScope?: Array<PivotItem | string>): void;Параметры
- sortBy
- Excel.SortBy
Указывает, в каком порядке производится сортировка: по возрастанию или по убыванию.
- valuesHierarchy
- Excel.DataPivotHierarchy
Определяет иерархию значений на оси данных, используемой для сортировки.
- pivotItemScope
-
Array<Excel.PivotItem | string>
Элементы, которые должны использоваться для областей сортировки. Это будут элементы, из которых состоит строка или столбец, по которым вы хотите выполнить сортировку. Если вместо элемента сводки используется строка, она представляет идентификатор элемента сводки. Если на оси для сортировки нет других элементов, кроме иерархии данных, эта область может быть пустой.
Возвращаемое значение
void
Комментарии
sortByValues(sortBy, valuesHierarchy, pivotItemScope)
Сортирует сводную таблицу по указанным значениям в определенной области. Область определяет, какие конкретные значения будут использоваться для сортировки при наличии нескольких значений из одной и той же DataPivotHierarchy.
sortByValues(sortBy: "Ascending" | "Descending", valuesHierarchy: Excel.DataPivotHierarchy, pivotItemScope?: Array<PivotItem | string>): void;Параметры
- sortBy
-
"Ascending" | "Descending"
Указывает, в каком порядке производится сортировка: по возрастанию или по убыванию.
- valuesHierarchy
- Excel.DataPivotHierarchy
Определяет иерархию значений на оси данных, используемой для сортировки.
- pivotItemScope
-
Array<Excel.PivotItem | string>
Элементы, которые должны использоваться для областей сортировки. Это будут элементы, из которых состоит строка или столбец, по которым вы хотите выполнить сортировку. Если вместо элемента сводки используется строка, она представляет идентификатор элемента сводки. Если на оси для сортировки нет других элементов, кроме иерархии данных, эта область может быть пустой.
Возвращаемое значение
void
Комментарии
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.PivotField объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.PivotFieldData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
toJSON(): Excel.Interfaces.PivotFieldData;