Excel.FilterPivotHierarchy class

Pacote:

excel

Representa a FilterPivotHierarchy do Excel.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

Propriedades

context	O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
enableMultipleFilterItems	Determina se deseja permitir vários itens de filtro.
fields	Retorna PivotFields associados a FilterPivotHierarchy.
id	ID da FilterPivotHierarchy.
name	Nome do FilterPivotHierarchy.
position	Posição do FilterPivotHierarchy.

Métodos

load(options)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNames)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
set(properties, options)	Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.
set(properties)	Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.
setToDefault()	Redefina a FilterPivotHierarchy para os valores padrão.
toJSON()	Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.FilterPivotHierarchy é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.FilterPivotHierarchyData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

Detalhes da propriedade

context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

Excel.RequestContext

enableMultipleFilterItems

Determina se deseja permitir vários itens de filtro.

enableMultipleFilterItems: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

fields

Retorna PivotFields associados a FilterPivotHierarchy.

readonly fields: Excel.PivotFieldCollection;

Valor da propriedade

Excel.PivotFieldCollection

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

id

ID da FilterPivotHierarchy.

readonly id: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

name

Nome do FilterPivotHierarchy.

name: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

position

Posição do FilterPivotHierarchy.

position: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

Detalhes do método

load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

options

Excel.Interfaces.FilterPivotHierarchyLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

Excel.FilterPivotHierarchy

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

propertyNames

string | string[]

Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

Retornos

Excel.FilterPivotHierarchy

load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

propertyNamesAndPaths

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

propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.

Retornos

Excel.FilterPivotHierarchy

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.

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

Parâmetros

properties

Excel.Interfaces.FilterPivotHierarchyUpdateData

Um objeto JavaScript com propriedades que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.

options

OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.

set(properties: Excel.FilterPivotHierarchy): void;

Parâmetros

properties

Excel.FilterPivotHierarchy

Retornos

void

setToDefault()

Redefina a FilterPivotHierarchy para os valores padrão.

setToDefault(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.FilterPivotHierarchy é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.FilterPivotHierarchyData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Excel.Interfaces.FilterPivotHierarchyData;

Retornos

Excel.Interfaces.FilterPivotHierarchyData