Excel.PivotLayout class

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.

altTextDescription: string;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.13 ]

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 the alt text for the displayed PivotTable.
  const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
  const pivotLayout = pivotTable.layout;

  pivotLayout.altTextTitle = "Farm Sales PivotTable";
  pivotLayout.altTextDescription = "A summary of fruit sales. It is pivoted on farm name, and fruit type. The aggregated data is both the sums of crates sold at the farms and the sums of crates sold wholesale.";
  console.log("Adding alt text. Check the PivotTable settings to see the changes.");

  await context.sync();
});

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.

altTextTitle: string;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.13 ]

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

autoFormat: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

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.

emptyCellText: string;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.13 ]

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 a default value for an empty cell in the PivotTable. This doesn't include cells left blank by the layout.
  const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
  const pivotLayout = pivotTable.layout;

  pivotLayout.emptyCellText = "--";

  // Set the text alignment to match the rest of the PivotTable.
  pivotLayout.getDataBodyRange().format.horizontalAlignment = Excel.HorizontalAlignment.right;
  await context.sync();
});

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

enableFieldList: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

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.

fillEmptyCells: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.13 ]

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) => {
  // Toggle whether empty cells are filled with a default value.
  const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
  const pivotLayout = pivotTable.layout;

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

  let fillToSet = !pivotLayout.fillEmptyCells;
  console.log(`Filling empty cells? - ${fillToSet}`);

  pivotLayout.fillEmptyCells = fillToSet;
  await context.sync();
});

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

O estilo aplicado à tabela dinâmica.

readonly pivotStyle: Excel.PivotTableStyle;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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

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

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

showColumnGrandTotals: boolean;

Valor da propriedade

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

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

showFieldHeaders: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.13 ]

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 field headers on and off for the row and column hierarchies.
  const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
  const pivotLayout = pivotTable.layout;
  pivotLayout.load("showFieldHeaders");
  await context.sync();

  let showHeaders = !pivotLayout.showFieldHeaders;
  console.log(`Show field headers? - ${showHeaders}`);
  pivotLayout.showFieldHeaders = showHeaders;
  await context.sync();
});

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

showRowGrandTotals: boolean;

Valor da propriedade

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

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

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

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

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.13 ]

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) => {
  // Add a blank row after each PivotItem in the row hierarchy.
  const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
  const pivotLayout = pivotTable.layout;

  pivotLayout.displayBlankLineAfterEachItem(true);
  console.log("Setting `PivotLayout.displayBlankLineAfterEachItem` to true.");

  await context.sync();
});

Obtém uma célula exclusiva na tabela dinâmica com base em uma hierarquia de dados, bem como os itens de linha e coluna de suas respectivas hierarquias. A célula retornada é a interseção da linha e coluna fornecidas que contém os dados da hierarquia especificada. Este método é o inverso de chamar getPivotItems e getDataHierarchy numa célula específica.

getCell(dataHierarchy: DataPivotHierarchy | string, rowItems: Array<PivotItem | string>, columnItems: Array<PivotItem | string>): Excel.Range;

Parâmetros

Retornos

Um intervalo que especifica uma única célula que contém o valor especificado.

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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

getColumnLabelRange(): Excel.Range;

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

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

getDataBodyRange(): Excel.Range;

Retornos

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

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 utilizado para calcular o valor na célula especificada.

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

getFilterAxisRange(): Excel.Range;

Retornos

Comentários

[ Conjunto de API: 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

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

Comentários

[ Conjunto de API: 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(axisString: "Unknown" | "Row" | "Column" | "Data" | "Filter", cell: Range | string): Excel.PivotItemCollection;

Parâmetros

Retornos

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

Comentários

[ Conjunto de API: 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 API: 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 API: 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 definição "repetir todas as etiquetas de itens" em todos os campos na Tabela Dinâmica.

repeatAllItemLabels(repeatLabels: boolean): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.13 ]

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) => {
  // Repeat the PivotItem labels for each row used by another level of the row hierarchy.
  const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
  const pivotLayout = pivotTable.layout;

  pivotLayout.repeatAllItemLabels(true);
  console.log("Setting `PivotLayout.repeatAllItemLabels` to true.");

  await context.sync();
});

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

Retornos

Define várias propriedades no objeto ao mesmo tempo, com base num 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 API: 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, sortByString: "Ascending" | "Descending"): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Define o estilo aplicado à tabela dinâmica.

setStyle(style: string | PivotTableStyle | BuiltInPivotTableStyle): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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 Excel.PivotLayout original é 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