Excel.PivotTableStyleCollection class
Representa uma coleção de estilos de Tabela Dinâmica.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.10 ]
Propriedades
| context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
| items | Obtém os itens filhos carregados nesta coleção. |
Métodos
| add(name, make |
Cria um em branco |
| get |
Obtém o número de estilos de PivotTable na coleção. |
| get |
Obtém o estilo de Tabela Dinâmica padrão para o escopo do objeto pai. |
| get |
Obtém um |
| get |
Obtém um |
| load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| set |
Define o estilo de Tabela Dinâmica padrão para uso no escopo do objeto pai. |
| toJSON() | Substitui o método JavaScript |
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
items
Obtém os itens filhos carregados nesta coleção.
readonly items: Excel.PivotTableStyle[];Valor da propriedade
Detalhes do método
add(name, makeUniqueName)
Cria um em branco PivotTableStyle com o nome especificado.
add(name: string, makeUniqueName?: boolean): Excel.PivotTableStyle;Parâmetros
- name
-
string
O nome exclusivo para o novo estilo de Tabela Dinâmica. Gerará um InvalidArgument erro se o nome já estiver em uso.
- makeUniqueName
-
boolean
Opcional. Padrão para false. Se true, adicionará números ao nome para torná-lo exclusivo, se necessário.
Retornos
O recém-criado PivotTableStyle.
Comentários
getCount()
Obtém o número de estilos de PivotTable na coleção.
getCount(): OfficeExtension.ClientResult<number>;Retornos
OfficeExtension.ClientResult<number>
Comentários
getDefault()
Obtém o estilo de Tabela Dinâmica padrão para o escopo do objeto pai.
getDefault(): Excel.PivotTableStyle;Retornos
O PivotTableStyle objeto que é o estilo atual de Tabela Dinâmica padrão.
Comentários
getItem(name)
Obtém um PivotTableStyle por nome.
getItem(name: string): Excel.PivotTableStyle;Parâmetros
- name
-
string
Nome do estilo tabela dinâmica a ser recuperado.
Retornos
O PivotTableStyle objeto cujo nome corresponde à entrada.
Comentários
getItemOrNullObject(name)
Obtém um PivotTableStyle por nome. Se o PivotTableStyle não existir, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.
getItemOrNullObject(name: string): Excel.PivotTableStyle;Parâmetros
- name
-
string
Nome do estilo tabela dinâmica a ser recuperado.
Retornos
O PivotTableStyle objeto cujo nome corresponde à entrada.
Comentários
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.PivotTableStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotTableStyleCollection;Parâmetros
- options
-
Excel.Interfaces.PivotTableStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
Fornece opções para quais propriedades do objeto carregar.
Retornos
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.PivotTableStyleCollection;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
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?: OfficeExtension.LoadOption): Excel.PivotTableStyleCollection;Parâmetros
- propertyNamesAndPaths
- OfficeExtension.LoadOption
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
setDefault(newDefaultStyle)
Define o estilo de Tabela Dinâmica padrão para uso no escopo do objeto pai.
setDefault(newDefaultStyle: PivotTableStyle | string): void;Parâmetros
- newDefaultStyle
-
Excel.PivotTableStyle | string
O PivotTableStyle objeto, ou nome do PivotTableStyle objeto, que deve ser o novo padrão.
Retornos
void
Comentários
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.) Considerando que o objeto original Excel.PivotTableStyleCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.PivotTableStyleCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.
toJSON(): Excel.Interfaces.PivotTableStyleCollectionData;Retornos
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de