Excel.PivotField class
Representa o Campo Dinâmico do Excel.
- Extends
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. |
| id | ID do Campo Dinâmico. |
| items | Devolve osItems Dinâmicos associados ao Campo Dinâmico. |
| name | Nome do PivotField. |
| show |
Determina se deseja mostrar todos os itens de PivotField. |
| subtotals | Subtotais de PivotField. |
Métodos
| 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. 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. |
| 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 âmbito define os valores específicos que serão utilizados para ordenar quando existem múltiplos valores da mesma DataPivotHierarchy. |
| sort |
Classifica o Campo dinâmico por valores especificados em um determinado escopo. O âmbito define os valores específicos que serão utilizados para ordenar quando existem múltiplos valores da mesma DataPivotHierarchy. |
| toJSON() | Substitui o método JavaScript |
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
id
ID do Campo Dinâmico.
readonly id: string;Valor da propriedade
string
Comentários
items
Devolve osItems Dinâmicos associados ao Campo Dinâmico.
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
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 as propriedades do objeto a 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 delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
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 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
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.PivotFieldUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
- properties
- Excel.Interfaces.PivotFieldUpdateData
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.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 ordenação é feita por ordem ascendente ou descendente.
Retornos
void
Comentários
sortByValues(sortBy, valuesHierarchy, pivotItemScope)
Classifica o Campo dinâmico por valores especificados em um determinado escopo. O âmbito define os valores específicos que serão utilizados para ordenar quando existem múltiplos valores da mesma DataPivotHierarchy.
sortByValues(sortBy: Excel.SortBy, valuesHierarchy: Excel.DataPivotHierarchy, pivotItemScope?: Array<PivotItem | string>): void;Parâmetros
- sortBy
- Excel.SortBy
Especifica se a ordenação é feita por ordem ascendente ou descendente.
- valuesHierarchy
- Excel.DataPivotHierarchy
Especifica a hierarquia de valores no eixo de dados a utilizar para ordenação.
- pivotItemScope
-
Array<Excel.PivotItem | string>
Os itens que devem ser utilizados para o âmbito da ordenação. Estes serão os itens que compõem a linha ou coluna que pretende ordenar. Se for utilizada uma cadeia em vez de um PivotItem, a cadeia representa o ID doItem Dinâmico. Se não existirem outros itens além da hierarquia de dados no eixo que pretende ordenar, isto pode estar vazio.
Retornos
void
Comentários
sortByValues(sortByString, valuesHierarchy, pivotItemScope)
Classifica o Campo dinâmico por valores especificados em um determinado escopo. O âmbito define os valores específicos que serão utilizados para ordenar quando existem múltiplos valores da mesma DataPivotHierarchy.
sortByValues(sortByString: "Ascending" | "Descending", valuesHierarchy: Excel.DataPivotHierarchy, pivotItemScope?: Array<PivotItem | string>): void;Parâmetros
- sortByString
-
"Ascending" | "Descending"
Especifica se a ordenação é feita por ordem ascendente ou descendente.
- valuesHierarchy
- Excel.DataPivotHierarchy
Especifica a hierarquia de valores no eixo de dados a utilizar para ordenação.
- pivotItemScope
-
Array<Excel.PivotItem | string>
Os itens que devem ser utilizados para o âmbito da ordenação. Estes serão os itens que compõem a linha ou coluna que pretende ordenar. Se for utilizada uma cadeia em vez de um PivotItem, a cadeia representa o ID doItem Dinâmico. Se não existirem outros itens além da hierarquia de dados no eixo que pretende ordenar, isto pode 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 é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.PivotField é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.PivotFieldData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Excel.Interfaces.PivotFieldData;