ExcelScript.PivotTable interface

Paquete:

ExcelScript

Representa una tabla dinámica de Excel.

Comentarios

Ejemplos

/**
 * This script creates a PivotTable from an existing table and adds it to a new worksheet.
 * This script assumes there is a table in the current worksheet with columns named "Type" and "Sales".
 */
function main(workbook: ExcelScript.Workbook) {
  // Create a PivotTable based on a table in the current worksheet.
  let sheet = workbook.getActiveWorksheet();
  let table = sheet.getTables()[0];

  // Add the PivotTable to a new worksheet.
  let newSheet = workbook.addWorksheet("Pivot");
  let pivotTable = newSheet.addPivotTable("My Pivot", table, "A1");

  // Add fields to the PivotTable to show "Sales" per "Type".
  pivotTable.addRowHierarchy(pivotTable.getHierarchy("Type"));
  pivotTable.addDataHierarchy(pivotTable.getHierarchy("Sales"));
}

Métodos

addColumnHierarchy(pivotHierarchy)	Agrega PivotHierarchy al eje actual. Si la jerarquía está presente en otra parte de la fila, la columna o el eje de filtro, se eliminará de esa ubicación.
addDataHierarchy(pivotHierarchy)	Agrega PivotHierarchy al eje actual.
addFilterHierarchy(pivotHierarchy)	Agrega PivotHierarchy al eje actual. Si la jerarquía está presente en otra parte de la fila, la columna o el eje de filtro, se eliminará de esa ubicación.
addRowHierarchy(pivotHierarchy)	Agrega PivotHierarchy al eje actual. Si la jerarquía está presente en otra parte de la fila, la columna o el eje de filtro, se eliminará de esa ubicación.
delete()	Elimina la tabla dinámica.
getAllowMultipleFiltersPerField()	Especifica si la tabla dinámica permite la aplicación de varios pivotfilters en un campo dinámico determinado de la tabla.
getColumnHierarchies()	Las jerarquías dinámicas de columna de la tabla dinámica.
getColumnHierarchy(name)	Obtiene una RowColumnPivotHierarchy por su nombre. Si rowColumnPivotHierarchy no existe, este método devuelve undefined.
getDataHierarchies()	Las jerarquías dinámicas de datos de la tabla dinámica.
getDataHierarchy(name)	Obtiene una DataPivotHierarchy por su nombre. Si dataPivotHierarchy no existe, este método devuelve undefined.
getEnableDataValueEditing()	Especifica si la tabla dinámica permite que el usuario edite los valores del cuerpo de datos.
getFilterHierarchies()	Las jerarquías dinámicas de filtro de la tabla dinámica.
getFilterHierarchy(name)	Obtiene una FilterPivotHierarchy por su nombre. Si filterPivotHierarchy no existe, este método devuelve undefined.
getHierarchies()	Las jerarquías dinámicas de la tabla dinámica.
getHierarchy(name)	Obtiene un PivotHierarchy por su nombre. Si pivotHierarchy no existe, este método devuelve undefined.
getId()	Identificador de la tabla dinámica.
getLayout()	El PivotLayout que describe el diseño y la estructura visual de la tabla dinámica.
getName()	Nombre la tabla dinámica.
getRowHierarchies()	Las jerarquías dinámicas de fila de la tabla dinámica.
getRowHierarchy(name)	Obtiene una RowColumnPivotHierarchy por su nombre. Si rowColumnPivotHierarchy no existe, este método devuelve undefined.
getUseCustomSortLists()	Especifica si la tabla dinámica usa listas personalizadas al ordenar.
getWorksheet()	La hoja de cálculo que contiene la tabla dinámica actual.
refresh()	Actualiza la tabla dinámica.
removeColumnHierarchy(rowColumnPivotHierarchy)	Elimina PivotHierarchy del eje actual.
removeDataHierarchy(DataPivotHierarchy)	Elimina PivotHierarchy del eje actual.
removeFilterHierarchy(filterPivotHierarchy)	Elimina PivotHierarchy del eje actual.
removeRowHierarchy(rowColumnPivotHierarchy)	Elimina PivotHierarchy del eje actual.
setAllowMultipleFiltersPerField(allowMultipleFiltersPerField)	Especifica si la tabla dinámica permite la aplicación de varios pivotfilters en un campo dinámico determinado de la tabla.
setEnableDataValueEditing(enableDataValueEditing)	Especifica si la tabla dinámica permite que el usuario edite los valores del cuerpo de datos.
setName(name)	Nombre la tabla dinámica.
setUseCustomSortLists(useCustomSortLists)	Especifica si la tabla dinámica usa listas personalizadas al ordenar.

Detalles del método

addColumnHierarchy(pivotHierarchy)

Agrega PivotHierarchy al eje actual. Si la jerarquía está presente en otra parte de la fila, la columna o el eje de filtro, se eliminará de esa ubicación.

addColumnHierarchy(
            pivotHierarchy: PivotHierarchy
        ): RowColumnPivotHierarchy;

Parámetros

pivotHierarchy

ExcelScript.PivotHierarchy

Devoluciones

ExcelScript.RowColumnPivotHierarchy

Ejemplos

/**
 * This script adds a row hierarchy to the PivotTable on the current worksheet.
 * This assumes the source data has columns named 
 * "Type", "Classification", and "Sales".
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable on the current worksheet.
  let sheet = workbook.getActiveWorksheet();
  let pivotTable = sheet.getPivotTables()[0];

  // Add the field "Type" to the PivotTable as a row hierarchy.
  pivotTable.addRowHierarchy(pivotTable.getHierarchy("Type"));

  // Add the field "Classification" to the PivotTable as a column hierarchy.
  pivotTable.addColumnHierarchy(pivotTable.getHierarchy("Classification"));

  // Add the field "Sales" to the PivotTable as a data hierarchy.
  // By default, this displays the sums of the values in "Sales" based on the "Type".
  pivotTable.addDataHierarchy(pivotTable.getHierarchy("Sales"));
}

addDataHierarchy(pivotHierarchy)

Agrega PivotHierarchy al eje actual.

addDataHierarchy(pivotHierarchy: PivotHierarchy): DataPivotHierarchy;

Parámetros

pivotHierarchy

ExcelScript.PivotHierarchy

Devoluciones

ExcelScript.DataPivotHierarchy

Ejemplos

/**
 * This script creates a PivotTable from an existing table and adds it to a new worksheet.
 * This script assumes there is a table in the current worksheet with columns named "Type" and "Sales".
 */
function main(workbook: ExcelScript.Workbook) {
  // Create a PivotTable based on a table in the current worksheet.
  let sheet = workbook.getActiveWorksheet();
  let table = sheet.getTables()[0];

  // Add the PivotTable to a new worksheet.
  let newSheet = workbook.addWorksheet("Pivot");
  let pivotTable = newSheet.addPivotTable("My Pivot", table, "A1");

  // Add fields to the PivotTable to show "Sales" per "Type".
  pivotTable.addRowHierarchy(pivotTable.getHierarchy("Type"));
  pivotTable.addDataHierarchy(pivotTable.getHierarchy("Sales"));
}

addFilterHierarchy(pivotHierarchy)

Agrega PivotHierarchy al eje actual. Si la jerarquía está presente en otra parte de la fila, la columna o el eje de filtro, se eliminará de esa ubicación.

addFilterHierarchy(
            pivotHierarchy: PivotHierarchy
        ): FilterPivotHierarchy;

Parámetros

pivotHierarchy

ExcelScript.PivotHierarchy

Devoluciones

ExcelScript.FilterPivotHierarchy

Ejemplos

/**
 * This script adds a manual filter to a PivotTable. 
 */
function main(workbook: ExcelScript.Workbook)
{
  // Get the first PivotTable in the workbook.
  const pivot = workbook.getPivotTables()[0];

  // Get the hierarchy to use as the filter.
  const location = pivot.getHierarchy("Location");

  // Use "Location" as the FilterHierarchy.
  pivot.addFilterHierarchy(location);

  // Select items for the filter.
  // Note that hierarchies and fields have a 1:1 relationship in Excel,
  // so `getFields()[0]` always gets the correct field.
  location.getFields()[0].applyFilter({
    manualFilter: {
      selectedItems: ["Seattle", "Chicago"]
    }
  });
}

addRowHierarchy(pivotHierarchy)

Agrega PivotHierarchy al eje actual. Si la jerarquía está presente en otra parte de la fila, la columna o el eje de filtro, se eliminará de esa ubicación.

addRowHierarchy(
            pivotHierarchy: PivotHierarchy
        ): RowColumnPivotHierarchy;

Parámetros

pivotHierarchy

ExcelScript.PivotHierarchy

Devoluciones

ExcelScript.RowColumnPivotHierarchy

Ejemplos

/**
 * This script creates a PivotTable from an existing table and adds it to a new worksheet.
 * This script assumes there is a table in the current worksheet with columns named "Type" and "Sales".
 */
function main(workbook: ExcelScript.Workbook) {
  // Create a PivotTable based on a table in the current worksheet.
  let sheet = workbook.getActiveWorksheet();
  let table = sheet.getTables()[0];

  // Add the PivotTable to a new worksheet.
  let newSheet = workbook.addWorksheet("Pivot");
  let pivotTable = newSheet.addPivotTable("My Pivot", table, "A1");

  // Add fields to the PivotTable to show "Sales" per "Type".
  pivotTable.addRowHierarchy(pivotTable.getHierarchy("Type"));
  pivotTable.addDataHierarchy(pivotTable.getHierarchy("Sales"));
}

delete()

Elimina la tabla dinámica.

delete(): void;

Devoluciones

void

getAllowMultipleFiltersPerField()

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

getAllowMultipleFiltersPerField(): boolean;

Devoluciones

boolean

getColumnHierarchies()

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

getColumnHierarchies(): RowColumnPivotHierarchy[];

Devoluciones

ExcelScript.RowColumnPivotHierarchy[]

getColumnHierarchy(name)

Obtiene una RowColumnPivotHierarchy por su nombre. Si rowColumnPivotHierarchy no existe, este método devuelve undefined.

getColumnHierarchy(name: string): RowColumnPivotHierarchy | undefined;

Parámetros

name

string

Nombre de rowColumnPivotHierarchy que se va a recuperar.

Devoluciones

ExcelScript.RowColumnPivotHierarchy | undefined

getDataHierarchies()

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

getDataHierarchies(): DataPivotHierarchy[];

Devoluciones

ExcelScript.DataPivotHierarchy[]

getDataHierarchy(name)

Obtiene una DataPivotHierarchy por su nombre. Si dataPivotHierarchy no existe, este método devuelve undefined.

getDataHierarchy(name: string): DataPivotHierarchy | undefined;

Parámetros

name

string

Nombre de dataPivotHierarchy que se va a recuperar.

Devoluciones

ExcelScript.DataPivotHierarchy | undefined

getEnableDataValueEditing()

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

getEnableDataValueEditing(): boolean;

Devoluciones

boolean

getFilterHierarchies()

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

getFilterHierarchies(): FilterPivotHierarchy[];

Devoluciones

ExcelScript.FilterPivotHierarchy[]

getFilterHierarchy(name)

Obtiene una FilterPivotHierarchy por su nombre. Si filterPivotHierarchy no existe, este método devuelve undefined.

getFilterHierarchy(name: string): FilterPivotHierarchy | undefined;

Parámetros

name

string

Nombre de filterPivotHierarchy que se va a recuperar.

Devoluciones

ExcelScript.FilterPivotHierarchy | undefined

getHierarchies()

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

getHierarchies(): PivotHierarchy[];

Devoluciones

ExcelScript.PivotHierarchy[]

getHierarchy(name)

Obtiene un PivotHierarchy por su nombre. Si pivotHierarchy no existe, este método devuelve undefined.

getHierarchy(name: string): PivotHierarchy | undefined;

Parámetros

name

string

Nombre de pivotHierarchy que se va a recuperar.

Devoluciones

ExcelScript.PivotHierarchy | undefined

getId()

Identificador de la tabla dinámica.

getId(): string;

Devoluciones

string

getLayout()

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

getLayout(): PivotLayout;

Devoluciones

ExcelScript.PivotLayout

Ejemplos

/**
 * This script sets the layout of the "Farms Sales" PivotTable to the "tabular"
 * setting. This places the fields from the Rows area in separate columns.
 */ 
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable named "Farm Sales".
  const pivot = workbook.getPivotTable("Farm Sales");

  // Get the PivotLayout object.
  const layout = pivot.getLayout();

  // Set the layout type to "tabular".
  layout.setLayoutType(ExcelScript.PivotLayoutType.tabular);
}

getName()

Nombre la tabla dinámica.

getName(): string;

Devoluciones

string

getRowHierarchies()

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

getRowHierarchies(): RowColumnPivotHierarchy[];

Devoluciones

ExcelScript.RowColumnPivotHierarchy[]

getRowHierarchy(name)

Obtiene una RowColumnPivotHierarchy por su nombre. Si rowColumnPivotHierarchy no existe, este método devuelve undefined.

getRowHierarchy(name: string): RowColumnPivotHierarchy | undefined;

Parámetros

name

string

Nombre de rowColumnPivotHierarchy que se va a recuperar.

Devoluciones

ExcelScript.RowColumnPivotHierarchy | undefined

Ejemplos

/**
 * This sample sorts the rows of a PivotTable.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get an existing PivotTable.
  const pivotTable = workbook.getPivotTable("Farm Sales");

  // Get the data hierarchy to use as the basis of the sort.
  const valueFieldToSortOn = pivotTable.getDataHierarchy("Sum of Crates Sold Wholesale");

  // Get the row to sort.
  const rowToSort = pivotTable.getRowHierarchy("Farm");

  // Sort the "Farm" row's only field by the values in "Sum of Crates Sold Wholesale".
  rowToSort.getFields()[0].sortByValues(ExcelScript.SortBy.descending, valueFieldToSortOn);
}

getUseCustomSortLists()

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

getUseCustomSortLists(): boolean;

Devoluciones

boolean

getWorksheet()

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

getWorksheet(): Worksheet;

Devoluciones

ExcelScript.Worksheet

refresh()

Actualiza la tabla dinámica.

refresh(): void;

Devoluciones

void

removeColumnHierarchy(rowColumnPivotHierarchy)

Elimina PivotHierarchy del eje actual.

removeColumnHierarchy(
            rowColumnPivotHierarchy: RowColumnPivotHierarchy
        ): void;

Parámetros

rowColumnPivotHierarchy

ExcelScript.RowColumnPivotHierarchy

Devoluciones

void

removeDataHierarchy(DataPivotHierarchy)

Elimina PivotHierarchy del eje actual.

removeDataHierarchy(DataPivotHierarchy: DataPivotHierarchy): void;

Parámetros

DataPivotHierarchy

ExcelScript.DataPivotHierarchy

Devoluciones

void

removeFilterHierarchy(filterPivotHierarchy)

Elimina PivotHierarchy del eje actual.

removeFilterHierarchy(filterPivotHierarchy: FilterPivotHierarchy): void;

Parámetros

filterPivotHierarchy

ExcelScript.FilterPivotHierarchy

Devoluciones

void

removeRowHierarchy(rowColumnPivotHierarchy)

Elimina PivotHierarchy del eje actual.

removeRowHierarchy(
            rowColumnPivotHierarchy: RowColumnPivotHierarchy
        ): void;

Parámetros

rowColumnPivotHierarchy

ExcelScript.RowColumnPivotHierarchy

Devoluciones

void

setAllowMultipleFiltersPerField(allowMultipleFiltersPerField)

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

setAllowMultipleFiltersPerField(
            allowMultipleFiltersPerField: boolean
        ): void;

Parámetros

allowMultipleFiltersPerField

boolean

Devoluciones

void

setEnableDataValueEditing(enableDataValueEditing)

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

setEnableDataValueEditing(enableDataValueEditing: boolean): void;

Parámetros

enableDataValueEditing

boolean

Devoluciones

void

setName(name)

Nombre la tabla dinámica.

setName(name: string): void;

Parámetros

name

string

Devoluciones

void

setUseCustomSortLists(useCustomSortLists)

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

setUseCustomSortLists(useCustomSortLists: boolean): void;

Parámetros

useCustomSortLists

boolean

Devoluciones

void