ExcelScript.PivotLayout interface

Pacote:

ExcelScript

Representa o layout visual da Tabela Dinâmica.

Comentários

Usada por

• ExcelScript.PivotTable: getLayout

Métodos

displayBlankLineAfterEachItem(display)	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.
getAltTextDescription()	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.
getAltTextTitle()	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.
getAutoFormat()	Especifica se a formatação será formatada automaticamente quando for atualizada ou quando os campos forem 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.
getEmptyCellText()	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.
getEnableFieldList()	Especifica se a lista de campos pode ser exibida na interface do usuário.
getFillEmptyCells()	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.
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, classificaçã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 totais gerais para colunas.
getShowFieldHeaders()	Especifica se a Tabela Dinâmica exibe cabeçalhos de campo (legendas de campo e menus suspensos de filtro).
getShowRowGrandTotals()	Especifica se o relatório de Tabela Dinâmica mostra totais gerais para linhas.
getSubtotalLocation()	Esta propriedade indica a SubtotalLocationType de todos os campos na Tabela Dinâmica. Se os campos tiverem estados diferentes, será null.
repeatAllItemLabels(repeatLabels)	Define a configuração "repetir todos os rótulos de item" em todos os campos da Tabela Dinâmica.
setAltTextDescription(altTextDescription)	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.
setAltTextTitle(altTextTitle)	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.
setAutoFormat(autoFormat)	Especifica se a formatação será formatada automaticamente quando for atualizada ou quando os campos forem 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.
setEmptyCellText(emptyCellText)	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.
setEnableFieldList(enableFieldList)	Especifica se a lista de campos pode ser exibida na interface do usuário.
setFillEmptyCells(fillEmptyCells)	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.
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, classificação ou alteração de itens de campo de página.
setShowColumnGrandTotals(showColumnGrandTotals)	Especifica se o relatório de Tabela Dinâmica mostra totais gerais para colunas.
setShowFieldHeaders(showFieldHeaders)	Especifica se a Tabela Dinâmica exibe cabeçalhos de campo (legendas de campo e menus suspensos de filtro).
setShowRowGrandTotals(showRowGrandTotals)	Especifica se o relatório de Tabela Dinâmica mostra totais gerais para linhas.
setSubtotalLocation(subtotalLocation)	Esta propriedade indica a SubtotalLocationType de todos os campos na Tabela Dinâmica. Se os campos tiverem estados diferentes, será null.

Detalhes do método

displayBlankLineAfterEachItem(display)

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

display

boolean

True ativa a configuração de exibição de linha em branco. False a desativa.

Retornos

void

getAltTextDescription()

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.

getAltTextDescription(): string;

Retornos

string

getAltTextTitle()

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.

getAltTextTitle(): string;

Retornos

string

getAutoFormat()

Especifica se a formatação será formatada automaticamente quando for atualizada ou quando os campos forem 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 dentro do corpo de dados da Tabela Dinâmica.

Retornos

ExcelScript.DataPivotHierarchy

getEmptyCellText()

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.

getEmptyCellText(): string;

Retornos

string

getEnableFieldList()

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

getEnableFieldList(): boolean;

Retornos

boolean

getFillEmptyCells()

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.

getFillEmptyCells(): 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, classificaçã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 totais gerais para colunas.

getShowColumnGrandTotals(): boolean;

Retornos

boolean

getShowFieldHeaders()

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

getShowFieldHeaders(): boolean;

Retornos

boolean

getShowRowGrandTotals()

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

getShowRowGrandTotals(): boolean;

Retornos

boolean

getSubtotalLocation()

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

getSubtotalLocation(): SubtotalLocationType;

Retornos

ExcelScript.SubtotalLocationType

repeatAllItemLabels(repeatLabels)

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

repeatLabels

boolean

True ativa a configuração de exibição de repetição de rótulo. False a desativa.

Retornos

void

setAltTextDescription(altTextDescription)

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.

setAltTextDescription(altTextDescription: string): void;

Parâmetros

altTextDescription

string

Retornos

void

setAltTextTitle(altTextTitle)

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.

setAltTextTitle(altTextTitle: string): void;

Parâmetros

altTextTitle

string

Retornos

void

setAutoFormat(autoFormat)

Especifica se a formatação será formatada automaticamente quando for atualizada ou quando os campos forem 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 ser usada obtém os critérios para aplicar a classificação automática.

sortBy

ExcelScript.SortBy

A direção da classificação.

Retornos

void

Exemplos

/**
* This script shows how to use setAutoSortOnCell to automatically sort
* a PivotTable's row labels based on values in a specific data column.
*/
function main(workbook: ExcelScript.Workbook) {
  // Get the "Farm Pivot" PivotTable.
  const pivotTable = workbook.getPivotTable("Farm Pivot");
  const sheet = pivotTable.getWorksheet();

  // Get the PivotTable's layout object.
  const layout = pivotTable.getLayout();

  // Pick a cell in the PivotTable's data area to sort by.
  const sortCell1 = sheet.getRange("N6");
  layout.setAutoSortOnCell(sortCell1, ExcelScript.SortBy.descending);
}

setEmptyCellText(emptyCellText)

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.

setEmptyCellText(emptyCellText: string): void;

Parâmetros

emptyCellText

string

Retornos

void

setEnableFieldList(enableFieldList)

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

setEnableFieldList(enableFieldList: boolean): void;

Parâmetros

enableFieldList

boolean

Retornos

void

setFillEmptyCells(fillEmptyCells)

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.

setFillEmptyCells(fillEmptyCells: boolean): void;

Parâmetros

fillEmptyCells

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, classificaçã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 totais gerais para colunas.

setShowColumnGrandTotals(showColumnGrandTotals: boolean): void;

Parâmetros

showColumnGrandTotals

boolean

Retornos

void

setShowFieldHeaders(showFieldHeaders)

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

setShowFieldHeaders(showFieldHeaders: boolean): void;

Parâmetros

showFieldHeaders

boolean

Retornos

void

setShowRowGrandTotals(showRowGrandTotals)

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

setShowRowGrandTotals(showRowGrandTotals: boolean): void;

Parâmetros

showRowGrandTotals

boolean

Retornos

void

setSubtotalLocation(subtotalLocation)

Esta propriedade indica a 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);
}