Excel.PivotLayout class

Paquete:

excel

Representa el diseño visual de la tabla dinámica.

Extends

OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApi 1.8 ]

Propiedades

autoFormat	Especifica si el formato se dará formato automáticamente cuando se actualice o cuando se muevan los campos.
context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
enableFieldList	Especifica si la lista de campos se puede mostrar en la interfaz de usuario.
layoutType	Esta propiedad indica el PivotLayoutType de todos los campos de la tabla dinámica. Si los campos tienen diferentes estados, será null.
preserveFormatting	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.
showColumnGrandTotals	Especifica si el informe de tabla dinámica muestra los totales generales de las columnas.
showRowGrandTotals	Especifica si el informe de tabla dinámica muestra los totales generales de las filas.
subtotalLocation	Esta propiedad indica el SubtotalLocationType de todos los campos de la tabla dinámica. Si los campos tienen estados diferentes, será null.

Métodos

getColumnLabelRange()	Devuelve el intervalo donde residen las etiquetas de columna de la tabla dinámica.
getDataBodyRange()	Devuelve el intervalo donde residen los valores de datos de tabla dinámica.
getDataHierarchy(cell)	Obtiene la DataHierarchy que se usa para calcular el valor de un intervalo especificado en la tabla dinámica.
getFilterAxisRange()	Devuelve el intervalo del área de filtro de la tabla dinámica.
getPivotItems(axis, cell)	Obtiene los elementos dinámicos de un eje que componen el valor de un intervalo especificado en la tabla dinámica.
getPivotItems(axisString, cell)	Obtiene los elementos dinámicos de un eje que componen el valor de un intervalo especificado en la tabla dinámica.
getRange()	Devuelve el intervalo en el que existe la tabla dinámica, excluyendo el área de filtro.
getRowLabelRange()	Devuelve el intervalo donde residen las etiquetas de fila de la tabla dinámica.
load(options)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
set(properties, options)	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)	Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.
setAutoSortOnCell(cell, sortBy)	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, sortByString)	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.
toJSON()	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.

Detalles de las propiedades

autoFormat

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

autoFormat: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

context

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

Excel.RequestContext

enableFieldList

Especifica si la lista de campos se puede mostrar en la interfaz de usuario.

enableFieldList: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.10 ]

layoutType

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

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

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

preserveFormatting

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

boolean

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

showColumnGrandTotals

Especifica si el informe de tabla dinámica muestra los totales generales de las columnas.

showColumnGrandTotals: boolean;

Valor de propiedad

boolean

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

showRowGrandTotals

Especifica si el informe de tabla dinámica muestra los totales generales de las filas.

showRowGrandTotals: boolean;

Valor de propiedad

boolean

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

subtotalLocation

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

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

Comentarios

[ Conjunto de API: ExcelApi 1.8 ]

Detalles del método

getColumnLabelRange()

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

getColumnLabelRange(): Excel.Range;

Devoluciones

Excel.Range

Comentarios

[ Conjunto de API: ExcelApi 1.8 ]

getDataBodyRange()

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

getDataBodyRange(): Excel.Range;

Devoluciones

Excel.Range

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

getDataHierarchy(cell)

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

cell

Excel.Range | string

Una sola celda dentro del cuerpo de datos de la tabla dinámica.

Devoluciones

Excel.DataPivotHierarchy

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

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

getFilterAxisRange()

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

getFilterAxisRange(): Excel.Range;

Devoluciones

Excel.Range

Comentarios

[ Conjunto de API: ExcelApi 1.8 ]

getPivotItems(axis, cell)

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

axis

Excel.PivotAxis

Eje desde el que se van a obtener los objetos PivotItem. Debe ser "row" o "column".

cell

Excel.Range | string

Una sola celda dentro del cuerpo de datos de la tabla dinámica.

Devoluciones

Excel.PivotItemCollection

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

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

getPivotItems(axisString, cell)

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

axisString

"Unknown" | "Row" | "Column" | "Data" | "Filter"

Eje desde el que se van a obtener los objetos PivotItem. Debe ser "row" o "column".

cell

Excel.Range | string

Una sola celda dentro del cuerpo de datos de la tabla dinámica.

Devoluciones

Excel.PivotItemCollection

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

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

getRange()

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

getRange(): Excel.Range;

Devoluciones

Excel.Range

Comentarios

[ Conjunto de API: ExcelApi 1.8 ]

getRowLabelRange()

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

getRowLabelRange(): Excel.Range;

Devoluciones

Excel.Range

Comentarios

[ Conjunto de API: ExcelApi 1.8 ]

load(options)

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

options

Excel.Interfaces.PivotLayoutLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

Excel.PivotLayout

load(propertyNames)

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

propertyNames

string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

Excel.PivotLayout

load(propertyNamesAndPaths)

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

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

Excel.PivotLayout

set(properties, options)

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

properties

Excel.Interfaces.PivotLayoutUpdateData

Objeto JavaScript con propiedades estructuradas isomórficamente con las propiedades del objeto al que se llama al método.

options

OfficeExtension.UpdateOptions

Proporciona una opción para suprimir errores si el objeto properties intenta establecer propiedades de solo lectura.

Devoluciones

void

set(properties)

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

set(properties: Excel.PivotLayout): void;

Parámetros

properties

Excel.PivotLayout

Devoluciones

void

setAutoSortOnCell(cell, sortBy)

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

cell

Excel.Range | string

Una sola celda para usar obtener los criterios de para aplicar el autoort.

sortBy

Excel.SortBy

Dirección de la ordenación.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

setAutoSortOnCell(cell, sortByString)

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

cell

Excel.Range | string

Una sola celda para usar obtener los criterios de para aplicar el autoort.

sortByString

"Ascending" | "Descending"

Dirección de la ordenación.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

toJSON()

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

Excel.Interfaces.PivotLayoutData