ExcelScript.PivotLayout interface

Pacote:

ExcelScript

Representa o esquema visual da Tabela Dinâmica.

Métodos

getAutoFormat()	Especifica se a formatação será formatada automaticamente quando é atualizada ou quando os campos são movidos.
getBodyAndTotalRange()	Retorna o intervalo onde residem os valores de dados da tabela dinâmica.
getColumnLabelRange()	Retorna o intervalo onde residem os rótulos de coluna da Tabela Dinâmica.
getDataHierarchy(cell)	Obtém o DataHierarchy que é usado para calcular o valor em um intervalo especificado dentro da Tabela dinâmica.
getEnableFieldList()	Especifica se a lista de campos pode ser apresentada na IU.
getFilterAxisRange()	Retorna o intervalo de área de filtro da Tabela Dinâmica.
getLayoutType()	Essa propriedade indica o PivotLayoutType de todos os campos da Tabela Dinâmica. Se os campos têm diferentes estados, ele será nulo.
getPreserveFormatting()	Especifica se a formatação é preservada quando o relatório é atualizado ou recalculado por operações como dinamização, ordenação ou alteração de itens de campo de página.
getRange()	Retorna o intervalo em que a Tabela Dinâmica existe, excluindo a área de filtro.
getRowLabelRange()	Retorna o intervalo onde residem os rótulos de linha da Tabela Dinâmica.
getShowColumnGrandTotals()	Especifica se o relatório de tabela dinâmica mostra os totais gerais das colunas.
getShowRowGrandTotals()	Especifica se o relatório de tabela dinâmica mostra os totais gerais das linhas.
getSubtotalLocation()	Esta propriedade indica o SubtotalLocationType de todos os campos na tabela dinâmica. Se os campos tiverem estados diferentes, será null.
setAutoFormat(autoFormat)	Especifica se a formatação será formatada automaticamente quando é atualizada ou quando os campos são movidos.
setAutoSortOnCell(cell, sortBy)	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.
setEnableFieldList(enableFieldList)	Especifica se a lista de campos pode ser apresentada na IU.
setLayoutType(layoutType)	Essa propriedade indica o PivotLayoutType de todos os campos da Tabela Dinâmica. Se os campos têm diferentes estados, ele será nulo.
setPreserveFormatting(preserveFormatting)	Especifica se a formatação é preservada quando o relatório é atualizado ou recalculado por operações como dinamização, ordenação ou alteração de itens de campo de página.
setShowColumnGrandTotals(showColumnGrandTotals)	Especifica se o relatório de tabela dinâmica mostra os totais gerais das colunas.
setShowRowGrandTotals(showRowGrandTotals)	Especifica se o relatório de tabela dinâmica mostra os totais gerais das linhas.
setSubtotalLocation(subtotalLocation)	Esta propriedade indica o SubtotalLocationType de todos os campos na tabela dinâmica. Se os campos tiverem estados diferentes, será null.

Detalhes do método

getAutoFormat()

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

getAutoFormat(): boolean;

Retornos

boolean

getBodyAndTotalRange()

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

getBodyAndTotalRange(): Range;

Retornos

ExcelScript.Range

Exemplos

/**
 * This sample finds the first PivotTable in the workbook and logs the values in the "Grand Total" cells.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first PivotTable in the workbook.
  let pivotTable = workbook.getPivotTables()[0];

  // Get the names of each data column in the PivotTable.
  let pivotColumnLabelRange = pivotTable.getLayout().getColumnLabelRange();

  // Get the range displaying the pivoted data.
  let pivotDataRange = pivotTable.getLayout().getBodyAndTotalRange();

  // Get the range with the "grand totals" for the PivotTable columns.
  let grandTotalRange = pivotDataRange.getLastRow();

  // Print each of the "Grand Totals" to the console.
  grandTotalRange.getValues()[0].forEach((column, columnIndex) => {
    console.log(`Grand total of ${pivotColumnLabelRange.getValues()[0][columnIndex]}: ${grandTotalRange.getValues()[0][columnIndex]}`);
    // Example log: "Grand total of Sum of Crates Sold Wholesale: 11000"
  });
}

getColumnLabelRange()

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

getColumnLabelRange(): Range;

Retornos

ExcelScript.Range

getDataHierarchy(cell)

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

getDataHierarchy(cell: Range | string): DataPivotHierarchy;

Parâmetros

cell

ExcelScript.Range | string

Uma única célula no corpo de dados da tabela dinâmica.

Retornos

ExcelScript.DataPivotHierarchy

getEnableFieldList()

Especifica se a lista de campos pode ser apresentada na IU.

getEnableFieldList(): boolean;

Retornos

boolean

getFilterAxisRange()

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

getFilterAxisRange(): Range;

Retornos

ExcelScript.Range

getLayoutType()

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

getLayoutType(): PivotLayoutType;

Retornos

ExcelScript.PivotLayoutType

getPreserveFormatting()

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

getPreserveFormatting(): boolean;

Retornos

boolean

getRange()

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

getRange(): Range;

Retornos

ExcelScript.Range

getRowLabelRange()

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

getRowLabelRange(): Range;

Retornos

ExcelScript.Range

getShowColumnGrandTotals()

Especifica se o relatório de tabela dinâmica mostra os totais gerais das colunas.

getShowColumnGrandTotals(): boolean;

Retornos

boolean

getShowRowGrandTotals()

Especifica se o relatório de tabela dinâmica mostra os totais gerais das linhas.

getShowRowGrandTotals(): boolean;

Retornos

boolean

getSubtotalLocation()

Esta propriedade indica o SubtotalLocationType de todos os campos na tabela dinâmica. Se os campos tiverem estados diferentes, será null.

getSubtotalLocation(): SubtotalLocationType;

Retornos

ExcelScript.SubtotalLocationType

setAutoFormat(autoFormat)

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

setAutoFormat(autoFormat: boolean): void;

Parâmetros

autoFormat

boolean

Retornos

void

setAutoSortOnCell(cell, sortBy)

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: SortBy): void;

Parâmetros

cell

ExcelScript.Range | string

Uma única célula a utilizar obtém os critérios para aplicar a ordenação automática.

sortBy

ExcelScript.SortBy

A direção do tipo.

Retornos

void

setEnableFieldList(enableFieldList)

Especifica se a lista de campos pode ser apresentada na IU.

setEnableFieldList(enableFieldList: boolean): void;

Parâmetros

enableFieldList

boolean

Retornos

void

setLayoutType(layoutType)

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

setLayoutType(layoutType: PivotLayoutType): void;

Parâmetros

layoutType

ExcelScript.PivotLayoutType

Retornos

void

Exemplos

/**
 * This script sets the layout of the "Farms Sales" PivotTable to the "tabular"
 * setting. This places the fields from the Rows area in separate columns.
 */ 
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable named "Farm Sales".
  const pivot = workbook.getPivotTable("Farm Sales");

  // Get the PivotLayout object.
  const layout = pivot.getLayout();

  // Set the layout type to "tabular".
  layout.setLayoutType(ExcelScript.PivotLayoutType.tabular);
}

setPreserveFormatting(preserveFormatting)

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

setPreserveFormatting(preserveFormatting: boolean): void;

Parâmetros

preserveFormatting

boolean

Retornos

void

setShowColumnGrandTotals(showColumnGrandTotals)

Especifica se o relatório de tabela dinâmica mostra os totais gerais das colunas.

setShowColumnGrandTotals(showColumnGrandTotals: boolean): void;

Parâmetros

showColumnGrandTotals

boolean

Retornos

void

setShowRowGrandTotals(showRowGrandTotals)

Especifica se o relatório de tabela dinâmica mostra os totais gerais das linhas.

setShowRowGrandTotals(showRowGrandTotals: boolean): void;

Parâmetros

showRowGrandTotals

boolean

Retornos

void

setSubtotalLocation(subtotalLocation)

Esta propriedade indica o SubtotalLocationType de todos os campos na tabela dinâmica. Se os campos tiverem estados diferentes, será null.

setSubtotalLocation(subtotalLocation: SubtotalLocationType): void;

Parâmetros

subtotalLocation

ExcelScript.SubtotalLocationType

Retornos

void

Exemplos

/**
 * This script displays group subtotals of the "Farms Sales" PivotTable.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable named "Farm Sales".
  const pivot = workbook.getPivotTable("Farm Sales");

  // Get the PivotLayout object.
  const layout = pivot.getLayout();

  // Show all the subtotals at the bottom of each group.
  layout.setSubtotalLocation(ExcelScript.SubtotalLocationType.atBottom);
}