Excel.FilterPivotHierarchy class

Pacote:

excel

Representa o Excel FilterPivotHierarchy.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

Propriedades

context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
enableMultipleFilterItems	Determina se deseja permitir vários itens de filtro.
fields	Retorna PivotFields associados a FilterPivotHierarchy.
id	ID do 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. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.
set(properties)	Define várias propriedades no objeto ao mesmo tempo, com base em um 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 é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.FilterPivotHierarchy original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.FilterPivotHierarchyData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

Detalhes da propriedade

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host 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 do 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 quais propriedades do objeto 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 de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

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 de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.

Retornos

Excel.FilterPivotHierarchy

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas 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 estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.

options

OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto properties tentar definir quaisquer propriedades somente leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base em um 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 é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.FilterPivotHierarchy original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.FilterPivotHierarchyData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.FilterPivotHierarchyData;

Retornos

Excel.Interfaces.FilterPivotHierarchyData