Excel.PivotLayout class

A descrição de texto alternativo da Tabela Dinâmica.

O texto Alt fornece representações alternativas, baseadas em texto, das informações contidas na Tabela Dinâmica. Essas informações são úteis para pessoas com deficiência visual ou cognitiva que podem não ser capazes de ver ou entender a tabela. Um título pode ser lido para uma pessoa com deficiência e é usado para determinar se ela deseja ouvir a descrição do conteúdo.

altTextDescription: string;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.13]

O título de texto alt da Tabela Dinâmica.

O texto Alt fornece representações alternativas, baseadas em texto, das informações contidas na Tabela Dinâmica. Essas informações são úteis para pessoas com deficiência visual ou cognitiva que podem não ser capazes de ver ou entender a tabela. Um título pode ser lido para uma pessoa com deficiência e é usado para determinar se ela deseja ouvir a descrição do conteúdo.

altTextTitle: string;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.13]

Especifica se a formatação será formatada automaticamente quando for atualizada ou quando os campos forem movidos.

autoFormat: boolean;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.9]

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

O texto que é preenchido automaticamente em qualquer célula vazia na Tabela Dinâmica se fillEmptyCells == true. Observe que esse valor persiste se fillEmptyCells for definido como false, e que a configuração desse valor não define essa propriedade como true. Por padrão, esta é uma cadeia de caracteres vazia.

emptyCellText: string;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.13]

Especifica se a lista de campos pode ser exibida na interface do usuário.

enableFieldList: boolean;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.10]

Especifica se as células vazias na Tabela Dinâmica devem ser preenchidas com o emptyCellText. O padrão é false. Observe que o valor de emptyCellText persists quando essa propriedade é definida como false.

fillEmptyCells: boolean;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.13]

Essa propriedade indica o PivotLayoutType de todos os campos da Tabela Dinâmica. Se os campos têm diferentes estados, ele será nulo.

layoutType: Excel.PivotLayoutType | "Compact" | "Tabular" | "Outline";

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.8]

Especifica se a formatação é preservada quando o relatório é atualizado ou recalculado por operações como dinamização, classificação ou alteração de itens de campo de página.

preserveFormatting: boolean;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.9]

Especifica se o relatório de Tabela Dinâmica mostra totais gerais para colunas.

showColumnGrandTotals: boolean;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.8]

Especifica se a Tabela Dinâmica exibe cabeçalhos de campo (legendas de campo e menus suspensos de filtro).

showFieldHeaders: boolean;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.13]

Especifica se o relatório de Tabela Dinâmica mostra totais gerais para linhas.

showRowGrandTotals: boolean;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.8]

Esta propriedade indica a SubtotalLocationType de todos os campos na Tabela Dinâmica. Se os campos tiverem estados diferentes, será null.

subtotalLocation: Excel.SubtotalLocationType | "AtTop" | "AtBottom" | "Off";

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.8]

Define se uma linha em branco deve ou não ser exibida após cada item. Isso é definido no nível global da Tabela Dinâmica e aplicado a Campos Dinâmicos individuais. Esta função substitui a configuração de todos os campos na Tabela Dinâmica pelo valor de display parâmetro.

displayBlankLineAfterEachItem(display: boolean): void;

Parâmetros

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.13]

Retorna o intervalo onde residem os rótulos de coluna da Tabela Dinâmica.

getColumnLabelRange(): Excel.Range;

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.8]

Retorna o intervalo onde residem os valores de dados da tabela dinâmica.

getDataBodyRange(): Excel.Range;

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.8]

Obtém o DataHierarchy que é usado para calcular o valor em um intervalo especificado dentro da Tabela dinâmica.

getDataHierarchy(cell: Range | string): Excel.DataPivotHierarchy;

Parâmetros

Retornos

O objeto DataPivotHierarchy usado para calcular o valor na célula especificada.

Comentários

[Conjunto de apis: ExcelApi 1.9]

Retorna o intervalo de área de filtro da Tabela Dinâmica.

getFilterAxisRange(): Excel.Range;

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.8]

Obtém os Itens dinâmicos de um eixo que compõem o valor em um intervalo especificado dentro da Tabela dinâmica.

getPivotItems(axis: Excel.PivotAxis, cell: Range | string): Excel.PivotItemCollection;

Parâmetros

Retornos

Um PivotItemCollection dos Itens Dinâmicos usados para calcular os valores na linha especificada.

Comentários

[Conjunto de apis: ExcelApi 1.9]

Obtém os Itens dinâmicos de um eixo que compõem o valor em um intervalo especificado dentro da Tabela dinâmica.

getPivotItems(axis: "Unknown" | "Row" | "Column" | "Data" | "Filter", cell: Range | string): Excel.PivotItemCollection;

Parâmetros

Retornos

Um PivotItemCollection dos Itens Dinâmicos usados para calcular os valores na linha especificada.

Comentários

[Conjunto de apis: ExcelApi 1.9]

Retorna o intervalo em que a Tabela Dinâmica existe, excluindo a área de filtro.

getRange(): Excel.Range;

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.8]

Retorna o intervalo onde residem os rótulos de linha da Tabela Dinâmica.

getRowLabelRange(): Excel.Range;

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.8]

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.PivotLayoutLoadOptions): Excel.PivotLayout;

Parâmetros

Retornos

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.PivotLayout;

Parâmetros

Retornos

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.PivotLayout;

Parâmetros

Retornos

Define a configuração "repetir todos os rótulos de item" em todos os campos da Tabela Dinâmica.

repeatAllItemLabels(repeatLabels: boolean): void;

Parâmetros

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.13]

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.PivotLayoutUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

Retornos

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

set(properties: Excel.PivotLayout): void;

Parâmetros

Retornos

Define a Tabela Dinâmica para classificar automaticamente usando a célula especificada para selecionar automaticamente todos os critérios e contextos necessários. Funciona de maneira idêntica à aplicação de uma autoclassificação da interface do usuário.

setAutoSortOnCell(cell: Range | string, sortBy: Excel.SortBy): void;

Parâmetros

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.9]

Define a Tabela Dinâmica para classificar automaticamente usando a célula especificada para selecionar automaticamente todos os critérios e contextos necessários. Funciona de maneira idêntica à aplicação de uma autoclassificação da interface do usuário.

setAutoSortOnCell(cell: Range | string, sortBy: "Ascending" | "Descending"): void;

Parâmetros

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.9]

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Excel.PivotLayout é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.PivotLayoutData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.PivotLayoutData;

Retornos