Excel.FilterPivotHierarchy class

Пакет:

excel

Представляет фильтр ExcelPivotHierarchy.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.8 ]

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
enableMultipleFilterItems	Определяет, следует ли разрешить несколько элементов фильтра.
fields	Возвращает сводные поля, связанные с FilterPivotHierarchy.
id	Идентификатор filterPivotHierarchy.
name	Имя FilterPivotHierarchy.
position	Положение FilterPivotHierarchy.

Методы

load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
setToDefault()	Сбрасывает FilterPivotHierarchy до значений по умолчанию.
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект Excel.FilterPivotHierarchy является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.FilterPivotHierarchyData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

Сведения о свойстве

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

Значение свойства

Excel.RequestContext

enableMultipleFilterItems

Определяет, следует ли разрешить несколько элементов фильтра.

enableMultipleFilterItems: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.8 ]

fields

Возвращает сводные поля, связанные с FilterPivotHierarchy.

readonly fields: Excel.PivotFieldCollection;

Значение свойства

Excel.PivotFieldCollection

Комментарии

[ Набор API: ExcelApi 1.8 ]

id

Идентификатор filterPivotHierarchy.

readonly id: string;

Значение свойства

string

Комментарии

[ Набор API: ExcelApi 1.8 ]

name

Имя FilterPivotHierarchy.

name: string;

Значение свойства

string

Комментарии

[ Набор API: ExcelApi 1.8 ]

position

Положение FilterPivotHierarchy.

position: number;

Значение свойства

number

Комментарии

[ Набор API: ExcelApi 1.8 ]

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

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Excel.Interfaces.FilterPivotHierarchyLoadOptions): Excel.FilterPivotHierarchy;

Параметры

options

Excel.Interfaces.FilterPivotHierarchyLoadOptions

Предоставляет параметры свойств загружаемого объекта.

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

Excel.FilterPivotHierarchy

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames?: string | string[]): Excel.FilterPivotHierarchy;

Параметры

propertyNames

string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

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

Excel.FilterPivotHierarchy

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.FilterPivotHierarchy;

Параметры

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

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

Excel.FilterPivotHierarchy

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties: Interfaces.FilterPivotHierarchyUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties

Excel.Interfaces.FilterPivotHierarchyUpdateData

Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .

options

OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.

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

void

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: Excel.FilterPivotHierarchy): void;

Параметры

properties

Excel.FilterPivotHierarchy

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

void

setToDefault()

Сбрасывает FilterPivotHierarchy до значений по умолчанию.

setToDefault(): void;

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

void

Комментарии

[ Набор API: ExcelApi 1.8 ]

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект Excel.FilterPivotHierarchy является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.FilterPivotHierarchyData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): Excel.Interfaces.FilterPivotHierarchyData;

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

Excel.Interfaces.FilterPivotHierarchyData