Excel.PivotLayout class

Referência

Pacote:: excel

Representa o esquema visual da Tabela Dinâmica.

Extends: OfficeExtension.ClientObject

Comentários

Propriedades

autoFormat	Especifica se a formatação será formatada automaticamente quando é atualizada ou quando os campos são movidos.
context	O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
enableFieldList	Especifica se a lista de campos pode ser apresentada na IU.
layoutType	Essa propriedade indica o PivotLayoutType de todos os campos da Tabela Dinâmica. Se os campos têm diferentes estados, ele será nulo.
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.
showColumnGrandTotals	Especifica se o relatório de tabela dinâmica mostra os totais gerais das colunas.
showRowGrandTotals	Especifica se o relatório de tabela dinâmica mostra os totais gerais das linhas.
subtotalLocation	Esta propriedade indica o `SubtotalLocationType` de todos os campos na tabela dinâmica. Se os campos tiverem estados diferentes, será `null`.

Métodos

getColumnLabelRange()	Retorna o intervalo onde residem os rótulos de coluna da Tabela Dinâmica.
getDataBodyRange()	Retorna o intervalo onde residem os valores de dados 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.
getFilterAxisRange()	Retorna o intervalo de área de filtro da Tabela Dinâmica.
getPivotItems(axis, cell)	Obtém os Itens dinâmicos de um eixo que compõem o valor em um intervalo especificado dentro da Tabela dinâmica.
getPivotItems(axisString, cell)	Obtém os Itens dinâmicos de um eixo que compõem o valor em um intervalo especificado dentro da Tabela dinâmica.
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.
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(propertyNames)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
load(propertyNamesAndPaths)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
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.
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, sortByString)	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.
toJSON()	Substitui o método JavaScript `toJSON()` para fornecer uma saída mais útil quando um objeto de API é transmitido para `JSON.stringify()`. (`JSON.stringify`por sua vez, chama o `toJSON` método do objeto que lhe é transmitido.) Enquanto o objeto original `Excel.PivotLayout` é um objeto de API, o `toJSON` método devolve um objeto JavaScript simples (escrito como `Excel.Interfaces.PivotLayoutData`) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

Detalhes da propriedade

autoFormat

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

autoFormat: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

Excel.RequestContext

enableFieldList

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

enableFieldList: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

layoutType

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

Excel.PivotLayoutType | "Compact" | "Tabular" | "Outline"

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotlayout.yaml

await Excel.run(async (context) => {
  // Change the PivotLayout.type to a new type.
  const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
  pivotTable.layout.load("layoutType");
  await context.sync();

  // Cycle between the three layout types.
  if (pivotTable.layout.layoutType === "Compact") {
    pivotTable.layout.layoutType = "Outline";
  } else if (pivotTable.layout.layoutType === "Outline") {
    pivotTable.layout.layoutType = "Tabular";
  } else {
    pivotTable.layout.layoutType = "Compact";
  }

  await context.sync();
  console.log("Pivot layout is now " + pivotTable.layout.layoutType);
});

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.

preserveFormatting: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotlayout.yaml

await Excel.run(async (context) => {
  // Set whether the PivotTable keeps the established format after it is refreshed and recalculated.
  const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
  const pivotLayout = pivotTable.layout;

  pivotLayout.load("preserveFormatting");
  await context.sync();

  let preserveFormattingToSet = !pivotLayout.preserveFormatting;
  console.log(`Preserve the formatting PivotTable after a refresh? - ${preserveFormattingToSet}`);

  pivotLayout.preserveFormatting = preserveFormattingToSet;
  await context.sync();
});

showColumnGrandTotals

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

showColumnGrandTotals: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotlayout.yaml

await Excel.run(async (context) => {
  // Turn the grand totals on and off for the rows and columns.
  const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
  const pivotLayout = pivotTable.layout;

  pivotLayout.load(["showRowGrandTotals", "showColumnGrandTotals"]);
  await context.sync();

  let showColumnTotals = !pivotLayout.showColumnGrandTotals;
  let showRowTotals = !pivotLayout.showRowGrandTotals;
  console.log(`Show column grand totals? - ${showColumnTotals}`);
  console.log(`Show row grand totals? - ${showRowTotals}`);

  pivotLayout.showColumnGrandTotals = showColumnTotals;
  pivotLayout.showRowGrandTotals = showRowTotals;

  await context.sync();
});

showRowGrandTotals

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

showRowGrandTotals: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotlayout.yaml

await Excel.run(async (context) => {
  // Turn the grand totals on and off for the rows and columns.
  const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
  const pivotLayout = pivotTable.layout;

  pivotLayout.load(["showRowGrandTotals", "showColumnGrandTotals"]);
  await context.sync();

  let showColumnTotals = !pivotLayout.showColumnGrandTotals;
  let showRowTotals = !pivotLayout.showRowGrandTotals;
  console.log(`Show column grand totals? - ${showColumnTotals}`);
  console.log(`Show row grand totals? - ${showRowTotals}`);

  pivotLayout.showColumnGrandTotals = showColumnTotals;
  pivotLayout.showRowGrandTotals = showRowTotals;

  await context.sync();
});

subtotalLocation

Esta propriedade indica o 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

Excel.SubtotalLocationType | "AtTop" | "AtBottom" | "Off"

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

Detalhes do método

getColumnLabelRange()

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

getColumnLabelRange(): Excel.Range;

Retornos

Excel.Range

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

getDataBodyRange()

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

getDataBodyRange(): Excel.Range;

Retornos

Excel.Range

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-filters-and-summaries.yaml

await Excel.run(async (context) => {
    const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");

    // The layout controls the ranges used by the PivotTable.
    const range = pivotTable.layout.getDataBodyRange();

    // Get all the data hierarchy totals.
    const grandTotalRange = range.getLastRow();
    grandTotalRange.load("address");
    await context.sync();
    
    // Use the wholesale and farm sale totals to make a final sum.
    const masterTotalRange = context.workbook.worksheets.getActiveWorksheet().getRange("B27:C27");
    masterTotalRange.formulas = [["All Crates", "=SUM(" + grandTotalRange.address + ")"]];
    await context.sync();
});

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

Parâmetros

cell: Excel.Range | string

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

Retornos

Excel.DataPivotHierarchy

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

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

getFilterAxisRange()

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

getFilterAxisRange(): Excel.Range;

Retornos

Excel.Range

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

getPivotItems(axis, cell)

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

axis: Excel.PivotAxis

O eixo a partir do qual obter osItems Dinâmicos. Tem de ser "linha" ou "coluna".

cell: Excel.Range | string

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

Retornos

Excel.PivotItemCollection

Uma PivotItemCollection dosItems Dinâmicos que são utilizados para calcular os valores na linha especificada.

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

getPivotItems(axisString, cell)

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

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

Parâmetros

axisString: "Unknown" | "Row" | "Column" | "Data" | "Filter"

O eixo a partir do qual obter osItems Dinâmicos. Tem de ser "linha" ou "coluna".

cell: Excel.Range | string

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

Retornos

Excel.PivotItemCollection

Uma PivotItemCollection dosItems Dinâmicos que são utilizados para calcular os valores na linha especificada.

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

getRange()

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

getRange(): Excel.Range;

Retornos

Excel.Range

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

getRowLabelRange()

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

getRowLabelRange(): Excel.Range;

Retornos

Excel.Range

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

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

Parâmetros

options: Excel.Interfaces.PivotLayoutLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

Excel.PivotLayout

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

Parâmetros

propertyNames: string | string[]

Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

Retornos

Excel.PivotLayout

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

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

Excel.PivotLayout

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

Parâmetros

properties: Excel.Interfaces.PivotLayoutUpdateData

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

Parâmetros

properties: Excel.PivotLayout

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

Parâmetros

cell: Excel.Range | string

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

sortBy: Excel.SortBy

A direção do tipo.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

setAutoSortOnCell(cell, sortByString)

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

Parâmetros

cell: Excel.Range | string

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

sortByString: "Ascending" | "Descending"

A direção do tipo.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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.PivotLayout é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.PivotLayoutData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Excel.Interfaces.PivotLayoutData;

Retornos

Excel.Interfaces.PivotLayoutData

Compartilhar via

Excel.PivotLayout class

Comentários

Propriedades

Métodos

Detalhes da propriedade

autoFormat

Valor da propriedade

Comentários

context

Valor da propriedade

enableFieldList

Valor da propriedade

Comentários

layoutType

Valor da propriedade

Comentários

Exemplos

preserveFormatting

Valor da propriedade

Comentários

Exemplos

showColumnGrandTotals

Valor da propriedade

Comentários

Exemplos

showRowGrandTotals

Valor da propriedade

Comentários

Exemplos

subtotalLocation

Valor da propriedade

Comentários

Detalhes do método

getColumnLabelRange()

Retornos

Comentários

getDataBodyRange()

Retornos

Comentários

Exemplos

getDataHierarchy(cell)

Parâmetros

Retornos

Comentários

getFilterAxisRange()

Retornos

Comentários

getPivotItems(axis, cell)

Parâmetros

Retornos

Comentários

getPivotItems(axisString, cell)

Parâmetros

Retornos

Comentários

getRange()

Retornos

Comentários

getRowLabelRange()

Retornos

Comentários

load(options)

Parâmetros

Retornos

load(propertyNames)

Parâmetros

Retornos

load(propertyNamesAndPaths)

Parâmetros

Retornos

set(properties, options)

Parâmetros

Retornos

set(properties)

Parâmetros

Retornos

setAutoSortOnCell(cell, sortBy)

Parâmetros

Retornos