Excel.PivotField class
Representa o Excel PivotField.
- Extends
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. |
| id | ID do PivotField. |
| items | Retorna os PivotItems associados ao PivotField. |
| name | Nome do PivotField. |
| show |
Determina se deseja mostrar todos os itens de PivotField. |
| subtotals | Subtotais de PivotField. |
Métodos
| apply |
Define um ou mais dos PivotFilters atuais do campo e aplica-os ao campo. Se os filtros fornecidos forem inválidos ou não puderem ser aplicados, uma exceção será gerada. |
| clear |
Limpa todos os critérios de todos os filtros do campo. Isso remove qualquer filtragem ativa no campo. |
| clear |
Limpa todos os critérios existentes do filtro do campo do tipo determinado (se um for aplicado no momento). |
| clear |
Limpa todos os critérios existentes do filtro do campo do tipo determinado (se um for aplicado no momento). |
| get |
Obtém todos os filtros atualmente aplicados no campo. |
| is |
Verifica se há filtros aplicados no campo. |
| is |
Verifica se há filtros aplicados no campo. |
| 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(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. |
| sort |
Classifica o PivotField. Se um DataPivotHierarchy for especificado, a classificação será aplicada com base nele, se a classificação não for baseada no campo PivotField. |
| sort |
Classifica o Campo dinâmico por valores especificados em um determinado escopo. O escopo define quais valores específicos serão usados para classificar quando houver vários valores da mesma DataPivotHierarchy. |
| sort |
Classifica o Campo dinâmico por valores especificados em um determinado escopo. O escopo define quais valores específicos serão usados para classificar quando houver vários valores da mesma DataPivotHierarchy. |
| 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
id
ID do PivotField.
readonly id: string;Valor da propriedade
string
Comentários
items
Retorna os PivotItems associados ao PivotField.
readonly items: Excel.PivotItemCollection;Valor da propriedade
Comentários
name
Nome do PivotField.
name: string;Valor da propriedade
string
Comentários
showAllItems
Determina se deseja mostrar todos os itens de PivotField.
showAllItems: boolean;Valor da propriedade
boolean
Comentários
subtotals
Subtotais de PivotField.
subtotals: Excel.Subtotals;Valor da propriedade
Comentários
Detalhes do método
applyFilter(filter)
Define um ou mais dos PivotFilters atuais do campo e aplica-os ao campo. Se os filtros fornecidos forem inválidos ou não puderem ser aplicados, uma exceção será gerada.
applyFilter(filter: Excel.PivotFilters): void;Parâmetros
- filter
- Excel.PivotFilters
Um PivotFilter específico configurado ou uma interface PivotFilters contendo vários filtros configurados.
Retornos
void
Comentários
clearAllFilters()
Limpa todos os critérios de todos os filtros do campo. Isso remove qualquer filtragem ativa no campo.
clearAllFilters(): void;Retornos
void
Comentários
[ Conjunto de API: ExcelApi 1.12 ]
Exemplos
// 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)
Limpa todos os critérios existentes do filtro do campo do tipo determinado (se um for aplicado no momento).
clearFilter(filterType: Excel.PivotFilterType): void;Parâmetros
- filterType
- Excel.PivotFilterType
O tipo de filtro no campo do qual limpar todos os critérios.
Retornos
void
Comentários
clearFilter(filterTypeString)
Limpa todos os critérios existentes do filtro do campo do tipo determinado (se um for aplicado no momento).
clearFilter(filterTypeString: "Unknown" | "Value" | "Manual" | "Label" | "Date"): void;Parâmetros
- filterTypeString
-
"Unknown" | "Value" | "Manual" | "Label" | "Date"
O tipo de filtro no campo do qual limpar todos os critérios.
Retornos
void
Comentários
getFilters()
Obtém todos os filtros atualmente aplicados no campo.
getFilters(): OfficeExtension.ClientResult<Excel.PivotFilters>;Retornos
Uma interface PivotFilters com todos os filtros ativos.
Comentários
isFiltered(filterType)
Verifica se há filtros aplicados no campo.
isFiltered(filterType?: Excel.PivotFilterType): OfficeExtension.ClientResult<boolean>;Parâmetros
- filterType
- Excel.PivotFilterType
O tipo de filtro a ser verificado. Se nenhum tipo for fornecido, esse método verificará se algum filtro é aplicado.
Retornos
OfficeExtension.ClientResult<boolean>
True se o campo tiver um filtro de tipo filterType aplicado. Se filterType não for especificado, true será retornado se o campo tiver filtros aplicados.
Comentários
isFiltered(filterTypeString)
Verifica se há filtros aplicados no campo.
isFiltered(filterTypeString?: "Unknown" | "Value" | "Manual" | "Label" | "Date"): OfficeExtension.ClientResult<boolean>;Parâmetros
- filterTypeString
-
"Unknown" | "Value" | "Manual" | "Label" | "Date"
O tipo de filtro a ser verificado. Se nenhum tipo for fornecido, esse método verificará se algum filtro é aplicado.
Retornos
OfficeExtension.ClientResult<boolean>
True se o campo tiver um filtro de tipo filterType aplicado. Se filterType não for especificado, true será retornado se o campo tiver filtros aplicados.
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.PivotFieldLoadOptions): Excel.PivotField;Parâmetros
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.PivotField;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?: {
select?: string;
expand?: string;
}): Excel.PivotField;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
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.PivotFieldUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
- properties
- Excel.Interfaces.PivotFieldUpdateData
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.PivotField): void;Parâmetros
- properties
- Excel.PivotField
Retornos
void
sortByLabels(sortBy)
Classifica o PivotField. Se um DataPivotHierarchy for especificado, a classificação será aplicada com base nele, se a classificação não for baseada no campo PivotField.
sortByLabels(sortBy: SortBy): void;Parâmetros
- sortBy
- Excel.SortBy
Especifica se a classificação é feita em ordem crescente ou decrescente.
Retornos
void
Comentários
sortByValues(sortBy, valuesHierarchy, pivotItemScope)
Classifica o Campo dinâmico por valores especificados em um determinado escopo. O escopo define quais valores específicos serão usados para classificar quando houver vários valores da mesma DataPivotHierarchy.
sortByValues(sortBy: Excel.SortBy, valuesHierarchy: Excel.DataPivotHierarchy, pivotItemScope?: Array<PivotItem | string>): void;Parâmetros
- sortBy
- Excel.SortBy
Especifica se a classificação é feita em ordem crescente ou decrescente.
- valuesHierarchy
- Excel.DataPivotHierarchy
Especifica a hierarquia de valores no eixo de dados a ser usado para classificação.
- pivotItemScope
-
Array<Excel.PivotItem | string>
Os itens que devem ser usados para o escopo da classificação. Estes serão os itens que compõem a linha ou coluna que você deseja classificar. Se uma cadeia de caracteres for usada em vez de um PivotItem, a cadeia de caracteres representará a ID do PivotItem. Se não houver outros itens além da hierarquia de dados no eixo em que você deseja classificar, isso poderá estar vazio.
Retornos
void
Comentários
sortByValues(sortByString, valuesHierarchy, pivotItemScope)
Classifica o Campo dinâmico por valores especificados em um determinado escopo. O escopo define quais valores específicos serão usados para classificar quando houver vários valores da mesma DataPivotHierarchy.
sortByValues(sortByString: "Ascending" | "Descending", valuesHierarchy: Excel.DataPivotHierarchy, pivotItemScope?: Array<PivotItem | string>): void;Parâmetros
- sortByString
-
"Ascending" | "Descending"
Especifica se a classificação é feita em ordem crescente ou decrescente.
- valuesHierarchy
- Excel.DataPivotHierarchy
Especifica a hierarquia de valores no eixo de dados a ser usado para classificação.
- pivotItemScope
-
Array<Excel.PivotItem | string>
Os itens que devem ser usados para o escopo da classificação. Estes serão os itens que compõem a linha ou coluna que você deseja classificar. Se uma cadeia de caracteres for usada em vez de um PivotItem, a cadeia de caracteres representará a ID do PivotItem. Se não houver outros itens além da hierarquia de dados no eixo em que você deseja classificar, isso poderá estar vazio.
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.) Enquanto o objeto Excel.PivotField original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.PivotFieldData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.
toJSON(): Excel.Interfaces.PivotFieldData;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