Excel.PivotLayout class

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

Extends

Comentarios

[Conjunto de API: ExcelApi 1.8]

Propiedades

altTextDescription

La descripción 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 no pueden 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

Título 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 no pueden 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.

autoFormat

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

context

El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.

emptyCellText

El texto que se rellena automáticamente en cualquier celda vacía de la tabla dinámica si fillEmptyCells == true. Tenga en cuenta que este valor persiste si fillEmptyCells se establece enfalse , y que establecer este valor no establece esa propiedad en true. De forma predeterminada, se trata de una cadena vacía.

enableFieldList

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

fillEmptyCells

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

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 se conserva el formato cuando el informe se actualiza o se recalcula mediante operaciones como dinamizar, ordenar o cambiar elementos de campo de página.

showColumnGrandTotals

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

showFieldHeaders

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

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, este será null.

Métodos

displayBlankLineAfterEachItem(display)

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

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(axis, 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.

repeatAllItemLabels(repeatLabels)

Establece la opción "repetir todas las etiquetas de artículos" en todos los campos de la tabla dinámica.

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 API del mismo tipo.

set(properties)

Establece varias propiedades en el objeto al mismo tiempo, basadas en 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, 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.

toJSON()

Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.PivotLayout es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.PivotLayoutData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.

Detalles de las propiedades

altTextDescription

La descripción 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 no pueden 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

string

Comentarios

[Conjunto de API: ExcelApi 1.13]

altTextTitle

Título 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 no pueden 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

string

Comentarios

[Conjunto de API: ExcelApi 1.13]

autoFormat

Especifica si el formato recibirá 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

El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

emptyCellText

El texto que se rellena automáticamente en cualquier celda vacía de la tabla dinámica si fillEmptyCells == true. Tenga en cuenta que este valor persiste si fillEmptyCells se establece enfalse , y que establecer este valor no establece esa propiedad en true. De forma predeterminada, se trata de una cadena vacía.

emptyCellText: string;

Valor de propiedad

string

Comentarios

[Conjunto de API: ExcelApi 1.13]

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]

fillEmptyCells

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

fillEmptyCells: boolean;

Valor de propiedad

boolean

Comentarios

[Conjunto de API: ExcelApi 1.13]

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]

preserveFormatting

Especifica si se conserva el formato cuando el informe se actualiza o se recalcula mediante operaciones como dinamizar, ordenar o cambiar elementos de campo de página.

preserveFormatting: boolean;

Valor de propiedad

boolean

Comentarios

[Conjunto de API: ExcelApi 1.9]

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]

showFieldHeaders

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

showFieldHeaders: boolean;

Valor de propiedad

boolean

Comentarios

[Conjunto de API: ExcelApi 1.13]

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]

subtotalLocation

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

displayBlankLineAfterEachItem(display)

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

displayBlankLineAfterEachItem(display: boolean): void;

Parámetros

display

boolean

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

Devoluciones

void

Comentarios

[Conjunto de API: ExcelApi 1.13]

getColumnLabelRange()

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]

getDataBodyRange()

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

getDataBodyRange(): Excel.Range;

Devoluciones

Comentarios

[Conjunto de API: ExcelApi 1.8]

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

El objeto DataPivotHierarchy utilizado 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

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

El eje desde el que se obtienen los elementos dinámicos. Debe ser "fila" o "columna".

cell

Excel.Range | string

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

Devoluciones

Elemento dinámico que consta de los elementos dinámicos que se usan para calcular los valores de la fila especificada.

Comentarios

[Conjunto de API: ExcelApi 1.9]

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: "Unknown" | "Row" | "Column" | "Data" | "Filter", cell: Range | string): Excel.PivotItemCollection;

Parámetros

axis

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

El eje desde el que se obtienen los elementos dinámicos. Debe ser "fila" o "columna".

cell

Excel.Range | string

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

Devoluciones

Elemento dinámico que consta de los elementos dinámicos 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

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

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

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

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

repeatAllItemLabels(repeatLabels)

Establece la opción "repetir todas las etiquetas de artículos" en todos los campos de la tabla dinámica.

repeatAllItemLabels(repeatLabels: boolean): void;

Parámetros

repeatLabels

boolean

Verdadero activa el ajuste de la pantalla de repetición de etiquetas. False lo desactiva.

Devoluciones

void

Comentarios

[Conjunto de API: ExcelApi 1.13]

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 API del mismo tipo.

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

Parámetros

properties
Excel.Interfaces.PivotLayoutUpdateData

Un objeto JavaScript con propiedades que están estructuradas isomorfamente a las propiedades del objeto en el 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, basadas en 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 obtener los criterios de aplicación de la ordenación automática.

sortBy
Excel.SortBy

Dirección de la ordenación.

Devoluciones

void

Comentarios

[Conjunto de API: ExcelApi 1.9]

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: "Ascending" | "Descending"): void;

Parámetros

cell

Excel.Range | string

Una sola celda para obtener los criterios de aplicación de la ordenación automática.

sortBy

"Ascending" | "Descending"

Dirección de la ordenación.

Devoluciones

void

Comentarios

[Conjunto de API: ExcelApi 1.9]

toJSON()

Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.PivotLayout es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.PivotLayoutData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.

toJSON(): Excel.Interfaces.PivotLayoutData;

Devoluciones