ExcelScript.PivotLayout interface

Paquete:

ExcelScript

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

Métodos

displayBlankLineAfterEachItem(display)	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 .
getAltTextDescription()	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.
getAltTextTitle()	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.
getAutoFormat()	Especifica si el formato se dará formato automáticamente cuando se actualice o cuando se muevan los campos.
getBodyAndTotalRange()	Devuelve el intervalo donde residen los valores de datos de tabla dinámica.
getColumnLabelRange()	Devuelve el intervalo donde residen las etiquetas de columna de la tabla dinámica.
getDataHierarchy(cell)	Obtiene la DataHierarchy que se usa para calcular el valor de un intervalo especificado en la tabla dinámica.
getEmptyCellText()	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.
getEnableFieldList()	Especifica si la lista de campos se puede mostrar en la interfaz de usuario.
getFillEmptyCells()	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.
getFilterAxisRange()	Devuelve el intervalo del área de filtro de la tabla dinámica.
getLayoutType()	Esta propiedad indica el PivotLayoutType de todos los campos de la tabla dinámica. Si los campos tienen diferentes estados, será null.
getPreserveFormatting()	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.
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.
getShowColumnGrandTotals()	Especifica si el informe de tabla dinámica muestra los totales generales de las columnas.
getShowFieldHeaders()	Especifica si la tabla dinámica muestra encabezados de campo (títulos de campo y listas desplegables de filtros).
getShowRowGrandTotals()	Especifica si el informe de tabla dinámica muestra los totales generales de las filas.
getSubtotalLocation()	Esta propiedad indica el SubtotalLocationType de todos los campos de la tabla dinámica. Si los campos tienen estados diferentes, será null.
repeatAllItemLabels(repeatLabels)	Establece el valor "repetir todas las etiquetas de elemento" en todos los campos de la tabla dinámica.
setAltTextDescription(altTextDescription)	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.
setAltTextTitle(altTextTitle)	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.
setAutoFormat(autoFormat)	Especifica si el formato se dará formato automáticamente cuando se actualice o cuando se muevan los campos.
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.
setEmptyCellText(emptyCellText)	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.
setEnableFieldList(enableFieldList)	Especifica si la lista de campos se puede mostrar en la interfaz de usuario.
setFillEmptyCells(fillEmptyCells)	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.
setLayoutType(layoutType)	Esta propiedad indica el PivotLayoutType de todos los campos de la tabla dinámica. Si los campos tienen diferentes estados, será null.
setPreserveFormatting(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.
setShowColumnGrandTotals(showColumnGrandTotals)	Especifica si el informe de tabla dinámica muestra los totales generales de las columnas.
setShowFieldHeaders(showFieldHeaders)	Especifica si la tabla dinámica muestra encabezados de campo (títulos de campo y listas desplegables de filtros).
setShowRowGrandTotals(showRowGrandTotals)	Especifica si el informe de tabla dinámica muestra los totales generales de las filas.
setSubtotalLocation(subtotalLocation)	Esta propiedad indica el SubtotalLocationType de todos los campos de la tabla dinámica. Si los campos tienen estados diferentes, será null.

Detalles del método

displayBlankLineAfterEachItem(display)

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

display

boolean

True activa la configuración de visualización de línea en blanco. False lo desactiva.

Devoluciones

void

getAltTextDescription()

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.

getAltTextDescription(): string;

Devoluciones

string

getAltTextTitle()

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.

getAltTextTitle(): string;

Devoluciones

string

getAutoFormat()

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

getAutoFormat(): boolean;

Devoluciones

boolean

getBodyAndTotalRange()

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

getBodyAndTotalRange(): Range;

Devoluciones

ExcelScript.Range

Ejemplos

/**
 * This sample finds the first PivotTable in the workbook and logs the values in the "Grand Total" cells.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first PivotTable in the workbook.
  let pivotTable = workbook.getPivotTables()[0];

  // Get the names of each data column in the PivotTable.
  let pivotColumnLabelRange = pivotTable.getLayout().getColumnLabelRange();

  // Get the range displaying the pivoted data.
  let pivotDataRange = pivotTable.getLayout().getBodyAndTotalRange();

  // Get the range with the "grand totals" for the PivotTable columns.
  let grandTotalRange = pivotDataRange.getLastRow();

  // Print each of the "Grand Totals" to the console.
  grandTotalRange.getValues()[0].forEach((column, columnIndex) => {
    console.log(`Grand total of ${pivotColumnLabelRange.getValues()[0][columnIndex]}: ${grandTotalRange.getValues()[0][columnIndex]}`);
    // Example log: "Grand total of Sum of Crates Sold Wholesale: 11000"
  });
}

getColumnLabelRange()

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

getColumnLabelRange(): Range;

Devoluciones

ExcelScript.Range

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): DataPivotHierarchy;

Parámetros

cell

ExcelScript.Range | string

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

Devoluciones

ExcelScript.DataPivotHierarchy

getEmptyCellText()

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.

getEmptyCellText(): string;

Devoluciones

string

getEnableFieldList()

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

getEnableFieldList(): boolean;

Devoluciones

boolean

getFillEmptyCells()

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.

getFillEmptyCells(): boolean;

Devoluciones

boolean

getFilterAxisRange()

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

getFilterAxisRange(): Range;

Devoluciones

ExcelScript.Range

getLayoutType()

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

getLayoutType(): PivotLayoutType;

Devoluciones

ExcelScript.PivotLayoutType

getPreserveFormatting()

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.

getPreserveFormatting(): boolean;

Devoluciones

boolean

getRange()

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

getRange(): Range;

Devoluciones

ExcelScript.Range

getRowLabelRange()

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

getRowLabelRange(): Range;

Devoluciones

ExcelScript.Range

getShowColumnGrandTotals()

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

getShowColumnGrandTotals(): boolean;

Devoluciones

boolean

getShowFieldHeaders()

Especifica si la tabla dinámica muestra encabezados de campo (títulos de campo y listas desplegables de filtros).

getShowFieldHeaders(): boolean;

Devoluciones

boolean

getShowRowGrandTotals()

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

getShowRowGrandTotals(): boolean;

Devoluciones

boolean

getSubtotalLocation()

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

getSubtotalLocation(): SubtotalLocationType;

Devoluciones

ExcelScript.SubtotalLocationType

repeatAllItemLabels(repeatLabels)

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

repeatAllItemLabels(repeatLabels: boolean): void;

Parámetros

repeatLabels

boolean

True activa la configuración de visualización de repetición de etiquetas. False lo desactiva.

Devoluciones

void

setAltTextDescription(altTextDescription)

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.

setAltTextDescription(altTextDescription: string): void;

Parámetros

altTextDescription

string

Devoluciones

void

setAltTextTitle(altTextTitle)

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.

setAltTextTitle(altTextTitle: string): void;

Parámetros

altTextTitle

string

Devoluciones

void

setAutoFormat(autoFormat)

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

setAutoFormat(autoFormat: boolean): void;

Parámetros

autoFormat

boolean

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: SortBy): void;

Parámetros

cell

ExcelScript.Range | string

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

sortBy

ExcelScript.SortBy

Dirección de la ordenación.

Devoluciones

void

setEmptyCellText(emptyCellText)

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.

setEmptyCellText(emptyCellText: string): void;

Parámetros

emptyCellText

string

Devoluciones

void

setEnableFieldList(enableFieldList)

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

setEnableFieldList(enableFieldList: boolean): void;

Parámetros

enableFieldList

boolean

Devoluciones

void

setFillEmptyCells(fillEmptyCells)

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.

setFillEmptyCells(fillEmptyCells: boolean): void;

Parámetros

fillEmptyCells

boolean

Devoluciones

void

setLayoutType(layoutType)

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

setLayoutType(layoutType: PivotLayoutType): void;

Parámetros

layoutType

ExcelScript.PivotLayoutType

Devoluciones

void

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

setPreserveFormatting(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.

setPreserveFormatting(preserveFormatting: boolean): void;

Parámetros

preserveFormatting

boolean

Devoluciones

void

setShowColumnGrandTotals(showColumnGrandTotals)

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

setShowColumnGrandTotals(showColumnGrandTotals: boolean): void;

Parámetros

showColumnGrandTotals

boolean

Devoluciones

void

setShowFieldHeaders(showFieldHeaders)

Especifica si la tabla dinámica muestra encabezados de campo (títulos de campo y listas desplegables de filtros).

setShowFieldHeaders(showFieldHeaders: boolean): void;

Parámetros

showFieldHeaders

boolean

Devoluciones

void

setShowRowGrandTotals(showRowGrandTotals)

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

setShowRowGrandTotals(showRowGrandTotals: boolean): void;

Parámetros

showRowGrandTotals

boolean

Devoluciones

void

setSubtotalLocation(subtotalLocation)

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

setSubtotalLocation(subtotalLocation: SubtotalLocationType): void;

Parámetros

subtotalLocation

ExcelScript.SubtotalLocationType

Devoluciones

void

Ejemplos

/**
 * This script displays group subtotals of the "Farms Sales" PivotTable.
 */
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();

  // Show all the subtotals at the bottom of each group.
  layout.setSubtotalLocation(ExcelScript.SubtotalLocationType.atBottom);
}