Excel.PivotLayout class

Descripción del texto alternativo de la tabla dinámica.

El texto alternativo proporciona representaciones alternativas basadas en texto de la información contenida en la tabla dinámica. Esta información es útil para las personas con discapacidades visuales o cognitivas que pueden no ser capaces de ver o comprender la tabla. Un título se puede leer a una persona con una discapacidad y se usa para determinar si desea escuchar la descripción del contenido.

altTextDescription: string;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.13 ]

Ejemplos

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

Título de texto alternativo de la tabla dinámica.

El texto alternativo proporciona representaciones alternativas basadas en texto de la información contenida en la tabla dinámica. Esta información es útil para las personas con discapacidades visuales o cognitivas que pueden no ser capaces de ver o comprender la tabla. Un título se puede leer a una persona con una discapacidad y se usa para determinar si desea escuchar la descripción del contenido.

altTextTitle: string;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.13 ]

Especifica si el formato se dará formato automáticamente cuando se actualice o cuando se muevan los campos.

autoFormat: boolean;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Texto que se rellena automáticamente en cualquier celda vacía de la tabla dinámica si fillEmptyCells == truees . Tenga en cuenta que este valor persiste si fillEmptyCells está establecido en falsey que al establecer este valor no se establece esa propiedad en true. De forma predeterminada, se trata de una cadena vacía.

emptyCellText: string;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.13 ]

Ejemplos

// 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 si la lista de campos se puede mostrar en la interfaz de usuario.

enableFieldList: boolean;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.10 ]

Especifica si las celdas vacías de la tabla dinámica deben rellenarse con .emptyCellText El valor predeterminado es false. Tenga en cuenta que el valor de emptyCellText persiste cuando esta propiedad está establecida en false.

fillEmptyCells: boolean;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.13 ]

Ejemplos

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

Esta propiedad indica el PivotLayoutType de todos los campos de la tabla dinámica. Si los campos tienen diferentes estados, será null.

layoutType: Excel.PivotLayoutType | "Compact" | "Tabular" | "Outline";

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.8 ]

Ejemplos

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

Estilo aplicado a la tabla dinámica.

readonly pivotStyle: Excel.PivotTableStyle;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

Especifica si el formato se conserva cuando el informe se actualiza o se vuelve a calcular mediante operaciones como la dinamización, la ordenación o el cambio de elementos de campo de página.

preserveFormatting: boolean;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Ejemplos

// 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 si el informe de tabla dinámica muestra los totales generales de las columnas.

showColumnGrandTotals: boolean;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.8 ]

Ejemplos

// 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 si la tabla dinámica muestra encabezados de campo (títulos de campo y listas desplegables de filtros).

showFieldHeaders: boolean;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.13 ]

Ejemplos

// 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 si el informe de tabla dinámica muestra los totales generales de las filas.

showRowGrandTotals: boolean;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.8 ]

Ejemplos

// 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 propiedad indica el SubtotalLocationType de todos los campos de la tabla dinámica. Si los campos tienen estados diferentes, será null.

subtotalLocation: Excel.SubtotalLocationType | "AtTop" | "AtBottom" | "Off";

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.8 ]

Establece si se va a mostrar una línea en blanco después de cada elemento. Se establece en el nivel global de la tabla dinámica y se aplica a campos dinámicos individuales. Esta función sobrescribe la configuración de todos los campos de la tabla dinámica en el valor del display parámetro .

displayBlankLineAfterEachItem(display: boolean): void;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.13 ]

Ejemplos

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

Obtiene una única celda de la tabla dinámica en función de una jerarquía de datos y de los elementos de fila y columna de sus respectivas jerarquías. La celda devuelta es la intersección de la fila y columna determinadas que contiene los datos de la jerarquía determinada. Este método es el inverso de la llamada getPivotItems y getDataHierarchy en una celda determinada.

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

Parámetros

Devoluciones

Intervalo que especifica una sola celda que contiene el valor especificado.

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

Devuelve el intervalo donde residen las etiquetas de columna de la tabla dinámica.

getColumnLabelRange(): Excel.Range;

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.8 ]

Devuelve el intervalo donde residen los valores de datos de tabla dinámica.

getDataBodyRange(): Excel.Range;

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.8 ]

Ejemplos

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

Obtiene la DataHierarchy que se usa para calcular el valor de un intervalo especificado en la tabla dinámica.

getDataHierarchy(cell: Range | string): Excel.DataPivotHierarchy;

Parámetros

Devoluciones

Objeto DataPivotHierarchy usado para calcular el valor de la celda especificada.

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Devuelve el intervalo del área de filtro de la tabla dinámica.

getFilterAxisRange(): Excel.Range;

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.8 ]

Obtiene los elementos dinámicos de un eje que componen el valor de un intervalo especificado en la tabla dinámica.

getPivotItems(axis: Excel.PivotAxis, cell: Range | string): Excel.PivotItemCollection;

Parámetros

Devoluciones

PivotItemCollection de los pivotItems que se usan para calcular los valores de la fila especificada.

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Obtiene los elementos dinámicos de un eje que componen el valor de un intervalo especificado en la tabla dinámica.

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

Parámetros

Devoluciones

PivotItemCollection de los pivotItems que se usan para calcular los valores de la fila especificada.

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Devuelve el intervalo en el que existe la tabla dinámica, excluyendo el área de filtro.

getRange(): Excel.Range;

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.8 ]

Devuelve el intervalo donde residen las etiquetas de fila de la tabla dinámica.

getRowLabelRange(): Excel.Range;

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.8 ]

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(options?: Excel.Interfaces.PivotLayoutLoadOptions): Excel.PivotLayout;

Parámetros

Devoluciones

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNames?: string | string[]): Excel.PivotLayout;

Parámetros

Devoluciones

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.PivotLayout;

Parámetros

Devoluciones

Establece el valor "repetir todas las etiquetas de elemento" en todos los campos de la tabla dinámica.

repeatAllItemLabels(repeatLabels: boolean): void;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.13 ]

Ejemplos

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

Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.

set(properties: Interfaces.PivotLayoutUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parámetros

Devoluciones

Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.

set(properties: Excel.PivotLayout): void;

Parámetros

Devoluciones

Establece la tabla dinámica para la ordenación automática mediante la celda especificada para seleccionar automáticamente el contexto y todos los criterios necesarios. Esto funciona igual que aplicar un Autoordenar desde la interfaz de usuario.

setAutoSortOnCell(cell: Range | string, sortBy: Excel.SortBy): void;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Establece la tabla dinámica para la ordenación automática mediante la celda especificada para seleccionar automáticamente el contexto y todos los criterios necesarios. Esto funciona igual que aplicar un Autoordenar desde la interfaz de usuario.

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

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Establece el estilo aplicado a la tabla dinámica.

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

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.PivotLayout es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.PivotLayoutData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Excel.Interfaces.PivotLayoutData;

Devoluciones