Excel.PivotTable class

Especifica si la tabla dinámica permite la aplicación de varios pivotfilters en un campo dinámico determinado de la tabla.

allowMultipleFiltersPerField: boolean;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.12 ]

Las jerarquías dinámicas de columna de la tabla dinámica.

readonly columnHierarchies: Excel.RowColumnPivotHierarchyCollection;

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-create-and-modify.yaml

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

    // Check if the PivotTable already has a column.
    const column = pivotTable.columnHierarchies.getItemOrNullObject("Farm");
    column.load("id");
    await context.sync();

    if (column.isNullObject) {
        // Adding the farm column to the column hierarchy automatically removes it from the row hierarchy.
        pivotTable.columnHierarchies.add(pivotTable.hierarchies.getItem("Farm"));
    } else {
        pivotTable.columnHierarchies.remove(column);
    }

    await context.sync();
});

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

Las jerarquías dinámicas de datos de la tabla dinámica.

readonly dataHierarchies: Excel.DataPivotHierarchyCollection;

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-create-and-modify.yaml

await Excel.run(async (context) => {
    const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
    pivotTable.dataHierarchies.add(pivotTable.hierarchies.getItem("Crates Sold at Farm"));
    pivotTable.dataHierarchies.add(pivotTable.hierarchies.getItem("Crates Sold Wholesale"));

    await context.sync();
});

Especifica si la tabla dinámica permite que el usuario edite los valores del cuerpo de datos.

enableDataValueEditing: boolean;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Las jerarquías dinámicas de filtro de la tabla dinámica.

readonly filterHierarchies: Excel.FilterPivotHierarchyCollection;

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-filters-and-summaries.yaml

async function filter(functionType: Excel.AggregationFunction) {
    await Excel.run(async (context) => {
        const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
        const filters = pivotTable.filterHierarchies;
        const filter = filters.getItemOrNullObject("Classification");
        filter.load();
        await context.sync();

        // Add the Classification hierarchy to the filter, if it's not already there.
        if (filter.isNullObject) {
            filters.add(pivotTable.hierarchies.getItem("Classification"));
            await context.sync();
        }
    });
}

Las jerarquías dinámicas de la tabla dinámica.

readonly hierarchies: Excel.PivotHierarchyCollection;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.8 ]

Identificador de la tabla dinámica.

readonly id: string;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.5 ]

El PivotLayout que describe el diseño y la estructura visual de la tabla dinámica.

readonly layout: Excel.PivotLayout;

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-create-and-modify.yaml

await Excel.run(async (context) => {
    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);
});

Nombre la tabla dinámica.

name: string;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.3 ]

Especifica si la tabla dinámica se actualiza cuando se abre el libro. Corresponde a la configuración "Actualizar al cargar" en la interfaz de usuario.

refreshOnOpen: boolean;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.13 ]

Las jerarquías dinámicas de fila de la tabla dinámica.

readonly rowHierarchies: Excel.RowColumnPivotHierarchyCollection;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.8 ]

Especifica si la tabla dinámica usa listas personalizadas al ordenar.

useCustomSortLists: boolean;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

La hoja de cálculo que contiene la tabla dinámica actual.

readonly worksheet: Excel.Worksheet;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.3 ]

Elimina la tabla dinámica.

delete(): void;

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-create-and-modify.yaml

await Excel.run(async (context) => {
    context.workbook.worksheets.getItem("Pivot").pivotTables.getItem("Farm Sales").delete();

    await context.sync();
});

Devuelve la representación de cadena del origen de datos para la tabla dinámica. Este método admite actualmente representaciones de cadena para objetos de tabla y rango. De lo contrario, devuelve una cadena vacía.

getDataSourceString(): OfficeExtension.ClientResult<string>;

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.15 ]

Ejemplos

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

// This function logs information about the data source of a PivotTable.
await Excel.run(async (context) => {
  const worksheet = context.workbook.worksheets.getItem("TotalPivot");
  const pivotTable = worksheet.pivotTables.getItem("All Farm Sales");

  // Retrieve the type and string representation of the data source of the PivotTable.
  const pivotTableDataSourceType = pivotTable.getDataSourceType();
  const pivotTableDataSourceString = pivotTable.getDataSourceString();
  await context.sync();

  // Log the data source information.
  console.log("Data source: " + pivotTableDataSourceString.value);
  console.log("Source type: " + pivotTableDataSourceType.value);
});

Obtiene el tipo del origen de datos de la tabla dinámica.

getDataSourceType(): OfficeExtension.ClientResult<Excel.DataSourceType>;

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.15 ]

Ejemplos

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

// This function logs information about the data source of a PivotTable.
await Excel.run(async (context) => {
  const worksheet = context.workbook.worksheets.getItem("TotalPivot");
  const pivotTable = worksheet.pivotTables.getItem("All Farm Sales");

  // Retrieve the type and string representation of the data source of the PivotTable.
  const pivotTableDataSourceType = pivotTable.getDataSourceType();
  const pivotTableDataSourceString = pivotTable.getDataSourceString();
  await context.sync();

  // Log the data source information.
  console.log("Data source: " + pivotTableDataSourceString.value);
  console.log("Source type: " + pivotTableDataSourceType.value);
});

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

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

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

Parámetros

Devoluciones

Actualiza la tabla dinámica.

refresh(): void;

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.3 ]

Ejemplos

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

// This function refreshes the "Farm Sales" PivotTable,
// which updates the PivotTable with changes made to the source table.
await Excel.run(async (context) => {
  const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
  pivotTable.refresh();
  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.PivotTableUpdateData, 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.PivotTable): void;

Parámetros

Devoluciones

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 Excel.PivotTable original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.PivotTableData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Excel.Interfaces.PivotTableData;

Devoluciones