ExcelScript.PivotLayout interface

Pacote:

ExcelScript

Representa o esquema visual da Tabela Dinâmica.

Métodos

displayBlankLineAfterEachItem(display)	Define se pretende ou não apresentar uma linha em branco após cada item. Esta definição é definida ao nível global da Tabela Dinâmica e aplicada a Campos Dinâmicos individuais. Esta função substitui a definição de todos os campos na Tabela Dinâmica pelo valor do display parâmetro .
getAltTextDescription()	A descrição do texto alternativo da Tabela Dinâmica. O texto alternativo fornece representações alternativas baseadas em texto das informações contidas na Tabela Dinâmica. Estas informações são úteis para pessoas com deficiências visuais ou cognitivas que podem não conseguir ver ou compreender a tabela. Um título pode ser lido para uma pessoa portadora de deficiência e é utilizado para determinar se pretende ouvir a descrição do conteúdo.
getAltTextTitle()	O título do texto alternativo da Tabela Dinâmica. O texto alternativo fornece representações alternativas baseadas em texto das informações contidas na Tabela Dinâmica. Estas informações são úteis para pessoas com deficiências visuais ou cognitivas que podem não conseguir ver ou compreender a tabela. Um título pode ser lido para uma pessoa portadora de deficiência e é utilizado para determinar se pretende ouvir a descrição do conteúdo.
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.
getEmptyCellText()	O texto que é preenchido automaticamente em qualquer célula vazia na tabela dinâmica se fillEmptyCells == true. Tenha em atenção que este valor persiste se fillEmptyCells estiver definido como falsee que definir este valor não define essa propriedade como true. Por predefinição, esta é uma cadeia vazia.
getEnableFieldList()	Especifica se a lista de campos pode ser apresentada na IU.
getFillEmptyCells()	Especifica se as células vazias na tabela dinâmica devem ser preenchidas com o emptyCellText. A predefinição é false. Tenha em atenção que o valor de emptyCellText persiste quando esta propriedade está 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, 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.
getShowFieldHeaders()	Especifica se a Tabela Dinâmica apresenta cabeçalhos de campo (legendas de campo e listas pendentes de filtro).
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.
repeatAllItemLabels(repeatLabels)	Define a definição "repetir todas as etiquetas de itens" em todos os campos na Tabela Dinâmica.
setAltTextDescription(altTextDescription)	A descrição do texto alternativo da Tabela Dinâmica. O texto alternativo fornece representações alternativas baseadas em texto das informações contidas na Tabela Dinâmica. Estas informações são úteis para pessoas com deficiências visuais ou cognitivas que podem não conseguir ver ou compreender a tabela. Um título pode ser lido para uma pessoa portadora de deficiência e é utilizado para determinar se pretende ouvir a descrição do conteúdo.
setAltTextTitle(altTextTitle)	O título do texto alternativo da Tabela Dinâmica. O texto alternativo fornece representações alternativas baseadas em texto das informações contidas na Tabela Dinâmica. Estas informações são úteis para pessoas com deficiências visuais ou cognitivas que podem não conseguir ver ou compreender a tabela. Um título pode ser lido para uma pessoa portadora de deficiência e é utilizado para determinar se pretende ouvir a descrição do conteúdo.
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.
setEmptyCellText(emptyCellText)	O texto que é preenchido automaticamente em qualquer célula vazia na tabela dinâmica se fillEmptyCells == true. Tenha em atenção que este valor persiste se fillEmptyCells estiver definido como falsee que definir este valor não define essa propriedade como true. Por predefinição, esta é uma cadeia vazia.
setEnableFieldList(enableFieldList)	Especifica se a lista de campos pode ser apresentada na IU.
setFillEmptyCells(fillEmptyCells)	Especifica se as células vazias na tabela dinâmica devem ser preenchidas com o emptyCellText. A predefinição é false. Tenha em atenção que o valor de emptyCellText persiste quando esta propriedade está 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, 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.
setShowFieldHeaders(showFieldHeaders)	Especifica se a Tabela Dinâmica apresenta cabeçalhos de campo (legendas de campo e listas pendentes de filtro).
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

displayBlankLineAfterEachItem(display)

Define se pretende ou não apresentar uma linha em branco após cada item. Esta definição é definida ao nível global da Tabela Dinâmica e aplicada a Campos Dinâmicos individuais. Esta função substitui a definição de todos os campos na Tabela Dinâmica pelo valor do display parâmetro .

displayBlankLineAfterEachItem(display: boolean): void;

Parâmetros

display

boolean

True ativa a definição de visualização de linha em branco. Falso desliga-o.

Retornos

void

getAltTextDescription()

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

O texto alternativo fornece representações alternativas baseadas em texto das informações contidas na Tabela Dinâmica. Estas informações são úteis para pessoas com deficiências visuais ou cognitivas que podem não conseguir ver ou compreender a tabela. Um título pode ser lido para uma pessoa portadora de deficiência e é utilizado para determinar se pretende ouvir a descrição do conteúdo.

getAltTextDescription(): string;

Retornos

string

getAltTextTitle()

O título do texto alternativo da Tabela Dinâmica.

O texto alternativo fornece representações alternativas baseadas em texto das informações contidas na Tabela Dinâmica. Estas informações são úteis para pessoas com deficiências visuais ou cognitivas que podem não conseguir ver ou compreender a tabela. Um título pode ser lido para uma pessoa portadora de deficiência e é utilizado para determinar se pretende ouvir a descrição do conteúdo.

getAltTextTitle(): string;

Retornos

string

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

getEmptyCellText()

O texto que é preenchido automaticamente em qualquer célula vazia na tabela dinâmica se fillEmptyCells == true. Tenha em atenção que este valor persiste se fillEmptyCells estiver definido como falsee que definir este valor não define essa propriedade como true. Por predefinição, esta é uma cadeia vazia.

getEmptyCellText(): string;

Retornos

string

getEnableFieldList()

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

getEnableFieldList(): boolean;

Retornos

boolean

getFillEmptyCells()

Especifica se as células vazias na tabela dinâmica devem ser preenchidas com o emptyCellText. A predefinição é false. Tenha em atenção que o valor de emptyCellText persiste quando esta propriedade está 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, 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

getShowFieldHeaders()

Especifica se a Tabela Dinâmica apresenta cabeçalhos de campo (legendas de campo e listas pendentes de filtro).

getShowFieldHeaders(): 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

repeatAllItemLabels(repeatLabels)

Define a definição "repetir todas as etiquetas de itens" em todos os campos na Tabela Dinâmica.

repeatAllItemLabels(repeatLabels: boolean): void;

Parâmetros

repeatLabels

boolean

True ativa a definição de apresentação de repetição de etiquetas. Falso desliga-o.

Retornos

void

setAltTextDescription(altTextDescription)

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

O texto alternativo fornece representações alternativas baseadas em texto das informações contidas na Tabela Dinâmica. Estas informações são úteis para pessoas com deficiências visuais ou cognitivas que podem não conseguir ver ou compreender a tabela. Um título pode ser lido para uma pessoa portadora de deficiência e é utilizado para determinar se pretende ouvir a descrição do conteúdo.

setAltTextDescription(altTextDescription: string): void;

Parâmetros

altTextDescription

string

Retornos

void

setAltTextTitle(altTextTitle)

O título do texto alternativo da Tabela Dinâmica.

O texto alternativo fornece representações alternativas baseadas em texto das informações contidas na Tabela Dinâmica. Estas informações são úteis para pessoas com deficiências visuais ou cognitivas que podem não conseguir ver ou compreender a tabela. Um título pode ser lido para uma pessoa portadora de deficiência e é utilizado para determinar se pretende 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 é 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

setEmptyCellText(emptyCellText)

O texto que é preenchido automaticamente em qualquer célula vazia na tabela dinâmica se fillEmptyCells == true. Tenha em atenção que este valor persiste se fillEmptyCells estiver definido como falsee que definir este valor não define essa propriedade como true. Por predefinição, esta é uma cadeia vazia.

setEmptyCellText(emptyCellText: string): void;

Parâmetros

emptyCellText

string

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

setFillEmptyCells(fillEmptyCells)

Especifica se as células vazias na tabela dinâmica devem ser preenchidas com o emptyCellText. A predefinição é false. Tenha em atenção que o valor de emptyCellText persiste quando esta propriedade está 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, 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

setShowFieldHeaders(showFieldHeaders)

Especifica se a Tabela Dinâmica apresenta cabeçalhos de campo (legendas de campo e listas pendentes de filtro).

setShowFieldHeaders(showFieldHeaders: boolean): void;

Parâmetros

showFieldHeaders

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);
}