Excel.PivotField class
Представляет сводное поле Excel.
- Extends
Комментарии
Свойства
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| id | Идентификатор сводного поля. |
| items | Возвращает PivotItems, связанные со сводным полем. |
| name | Имя сводного поля. |
| show |
Определяет, следует ли отображать все элементы сводного поля. |
| subtotals | Промежуточные итоги сводного поля. |
Методы
| apply |
Задает один или несколько текущих PivotFilters поля и применяет их к полю. Если предоставленные фильтры недопустимы или не могут быть применены, возникает исключение. |
| 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
Возвращает PivotItems, связанные со сводным полем.
readonly items: Excel.PivotItemCollection;Значение свойства
Комментарии
name
showAllItems
Определяет, следует ли отображать все элементы сводного поля.
showAllItems: boolean;Значение свойства
boolean
Комментарии
subtotals
Промежуточные итоги сводного поля.
subtotals: Excel.Subtotals;Значение свойства
Комментарии
Сведения о методе
applyFilter(filter)
Задает один или несколько текущих PivotFilters поля и применяет их к полю. Если предоставленные фильтры недопустимы или не могут быть применены, возникает исключение.
applyFilter(filter: Excel.PivotFilters): void;Параметры
- filter
- Excel.PivotFilters
Настроенный определенный PivotFilter или интерфейс PivotFilters, содержащий несколько настроенных фильтров.
Возвращаемое значение
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(filterTypeString)
Очищает все существующие критерии из фильтра поля заданного типа (если он применяется в данный момент).
clearFilter(filterTypeString: "Unknown" | "Value" | "Manual" | "Label" | "Date"): void;Параметры
- filterTypeString
-
"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(filterTypeString)
Проверяет наличие примененных фильтров к полю.
isFiltered(filterTypeString?: "Unknown" | "Value" | "Manual" | "Label" | "Date"): OfficeExtension.ClientResult<boolean>;Параметры
- filterTypeString
-
"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
Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.
Возвращаемое значение
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>
Элементы, которые должны использоваться для области сортировки. Это будут элементы, составляющие строку или столбец, по которым требуется отсортировать. Если вместо PivotItem используется строка, строка представляет идентификатор PivotItem. Если на оси, по которой требуется отсортировать, нет элементов, кроме иерархии данных, это может быть пустым.
Возвращаемое значение
void
Комментарии
sortByValues(sortByString, valuesHierarchy, pivotItemScope)
Сортирует сводную таблицу по указанным значениям в определенной области. Область определяет, какие конкретные значения будут использоваться для сортировки при наличии нескольких значений из одной и той же DataPivotHierarchy.
sortByValues(sortByString: "Ascending" | "Descending", valuesHierarchy: Excel.DataPivotHierarchy, pivotItemScope?: Array<PivotItem | string>): void;Параметры
- sortByString
-
"Ascending" | "Descending"
Указывает, выполняется ли сортировка по возрастанию или убыванию.
- valuesHierarchy
- Excel.DataPivotHierarchy
Указывает иерархию значений на оси данных, которая будет использоваться для сортировки.
- pivotItemScope
-
Array<Excel.PivotItem | string>
Элементы, которые должны использоваться для области сортировки. Это будут элементы, составляющие строку или столбец, по которым требуется отсортировать. Если вместо PivotItem используется строка, строка представляет идентификатор PivotItem. Если на оси, по которой требуется отсортировать, нет элементов, кроме иерархии данных, это может быть пустым.
Возвращаемое значение
void
Комментарии
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект Excel.PivotField является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.PivotFieldData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
toJSON(): Excel.Interfaces.PivotFieldData;Возвращаемое значение
Office Add-ins