Excel. Table class

Propiedades

autoFilter	Representa el `AutoFilter` objeto de la tabla.
columns	Representa una colección de todas las columnas de la tabla.
context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
highlightFirstColumn	Especifica si la primera columna contiene formato especial.
highlightLastColumn	Especifica si la última columna contiene formato especial.
id	Devuelve un valor que identifica de forma única la tabla de un libro determinado. El valor del identificador permanece igual, incluso cuando se cambia el nombre de la tabla.
legacyId	Devuelve un identificador numérico.
name	Nombre de la tabla. El nombre del conjunto de la tabla debe seguir las instrucciones especificadas en el artículo Cambiar nombre de una tabla de Excel .
rows	Representa una colección de todas las filas de la tabla.
showBandedColumns	Especifica si las columnas muestran formatos en bandas en los que las columnas impares se resaltan de forma diferente a las pares, para facilitar la lectura de la tabla.
showBandedRows	Especifica si las filas muestran formatos en banda en los que las filas impares se resaltan de forma diferente a las pares, para facilitar la lectura de la tabla.
showFilterButton	Especifica si los botones de filtro están visibles en la parte superior de cada encabezado de columna. Esta configuración solo se permite si la tabla contiene una fila de encabezado.
showHeaders	Especifica si la fila de encabezado está visible. Este valor puede establecerse para que muestre o quite la fila de encabezado.
showTotals	Especifica si la fila total está visible. Este valor puede establecerse para que muestre o quite la fila de totales.
sort	Representa la ordenación de la tabla.
style	Valor constante que representa el estilo de tabla. Los valores posibles son: "TableStyleLight1" a "TableStyleLight21", "TableStyleMedium1" a "TableStyleMedium28", "TableStyleDark1" a "TableStyleDark11". También puede especificarse un estilo personalizado definido por el usuario presente en el libro.
tableStyle	Estilo aplicado a la tabla.
worksheet	Hoja de cálculo que contiene la tabla actual.

Métodos

clearFilters()	Borra todos los filtros aplicados actualmente en la tabla.
clearStyle()	Cambia la tabla para usar el estilo de tabla predeterminado.
convertToRange()	Convierte la tabla en un rango de celdas normal. Se conservan todos los datos.
delete()	Elimina la tabla.
getDataBodyRange()	Obtiene el objeto de rango asociado al cuerpo de datos de la tabla.
getHeaderRowRange()	Obtiene el objeto de intervalo asociado a la fila de encabezado de la tabla.
getRange()	Obtiene el objeto de rango asociado a toda la tabla.
getTotalRowRange()	Obtiene el objeto de intervalo asociado a la fila de totales de la tabla.
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.
reapplyFilters()	Vuelve a aplicar todos los filtros aplicados actualmente en la tabla.
resize(newRange)	Cambie el tamaño de la tabla al nuevo intervalo. El nuevo intervalo debe superponerse con el intervalo de tabla original y los encabezados (o la parte superior de la tabla) deben estar en la misma fila.
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.
setStyle(style)	Establece el estilo aplicado a la tabla.
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.stringify`a su vez, llama al `toJSON` método del objeto que se le pasa). Mientras que el objeto Excel.Table original es un objeto de API, el `toJSON` método devuelve un objeto JavaScript sin formato (escrito como `Excel.Interfaces.TableData`) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

Eventos

onChanged	Se produce cuando los datos de las celdas cambian en una tabla específica.
onFiltered	Se produce cuando se aplica un filtro en una tabla específica.
onSelectionChanged	Se produce cuando la selección cambia en una tabla específica.

Detalles de las propiedades

autoFilter

Representa el AutoFilter objeto de la tabla.

readonly autoFilter: Excel.AutoFilter;

Valor de propiedad

Excel.AutoFilter

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

columns

Representa una colección de todas las columnas de la tabla.

readonly columns: Excel.TableColumnCollection;

Valor de propiedad

Excel.TableColumnCollection

Comentarios

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

highlightFirstColumn

Especifica si la primera columna contiene formato especial.

highlightFirstColumn: boolean;

Valor de propiedad

boolean

Comentarios

highlightLastColumn

Especifica si la última columna contiene formato especial.

highlightLastColumn: boolean;

Valor de propiedad

boolean

Comentarios

id

Devuelve un valor que identifica de forma única la tabla de un libro determinado. El valor del identificador permanece igual, incluso cuando se cambia el nombre de la tabla.

readonly id: string;

Valor de propiedad

string

Comentarios

legacyId

Devuelve un identificador numérico.

readonly legacyId: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.8 ]

name

Nombre de la tabla.

El nombre del conjunto de la tabla debe seguir las instrucciones especificadas en el artículo Cambiar nombre de una tabla de Excel .

name: string;

Valor de propiedad

string

Comentarios

rows

Representa una colección de todas las filas de la tabla.

readonly rows: Excel.TableRowCollection;

Valor de propiedad

Excel.TableRowCollection

Comentarios

showBandedColumns

Especifica si las columnas muestran formatos en bandas en los que las columnas impares se resaltan de forma diferente a las pares, para facilitar la lectura de la tabla.

showBandedColumns: boolean;

Valor de propiedad

boolean

Comentarios

showBandedRows

Especifica si las filas muestran formatos en banda en los que las filas impares se resaltan de forma diferente a las pares, para facilitar la lectura de la tabla.

showBandedRows: boolean;

Valor de propiedad

boolean

Comentarios

showFilterButton

Especifica si los botones de filtro están visibles en la parte superior de cada encabezado de columna. Esta configuración solo se permite si la tabla contiene una fila de encabezado.

showFilterButton: boolean;

Valor de propiedad

boolean

Comentarios

showHeaders

Especifica si la fila de encabezado está visible. Este valor puede establecerse para que muestre o quite la fila de encabezado.

showHeaders: boolean;

Valor de propiedad

boolean

Comentarios

showTotals

Especifica si la fila total está visible. Este valor puede establecerse para que muestre o quite la fila de totales.

showTotals: boolean;

Valor de propiedad

boolean

Comentarios

sort

Representa la ordenación de la tabla.

readonly sort: Excel.TableSort;

Valor de propiedad

Excel.TableSort

Comentarios

style

Valor constante que representa el estilo de tabla. Los valores posibles son: "TableStyleLight1" a "TableStyleLight21", "TableStyleMedium1" a "TableStyleMedium28", "TableStyleDark1" a "TableStyleDark11". También puede especificarse un estilo personalizado definido por el usuario presente en el libro.

style: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

Ejemplos

// Set table style.
await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    table.name = 'Table1-Renamed';
    table.showTotals = false;
    table.style = 'TableStyleMedium2';
    table.load('tableStyle');
    await context.sync();
    
    console.log(table.style);
});

tableStyle

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Estilo aplicado a la tabla.

readonly tableStyle: Excel.TableStyle;

Valor de propiedad

Excel.TableStyle

Comentarios

worksheet

Hoja de cálculo que contiene la tabla actual.

readonly worksheet: Excel.Worksheet;

Valor de propiedad

Excel.Worksheet

Comentarios

Detalles del método

clearFilters()

Borra todos los filtros aplicados actualmente en la tabla.

clearFilters(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

clearStyle()

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Cambia la tabla para usar el estilo de tabla predeterminado.

clearStyle(): void;

Devoluciones

void

Comentarios

convertToRange()

Convierte la tabla en un rango de celdas normal. Se conservan todos los datos.

convertToRange(): Excel.Range;

Devoluciones

Excel.Range

Comentarios

Ejemplos

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    table.convertToRange();
    await context.sync(); 
});

delete()

Elimina la tabla.

delete(): void;

Devoluciones

void

Comentarios

Ejemplos

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    table.delete();
    await context.sync(); 
});

getDataBodyRange()

Obtiene el objeto de rango asociado al cuerpo de datos de la tabla.

getDataBodyRange(): Excel.Range;

Devoluciones

Excel.Range

Comentarios

Ejemplos

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    const tableDataRange = table.getDataBodyRange();
    tableDataRange.load('address')
    await context.sync();
    
    console.log(tableDataRange.address);
});

getHeaderRowRange()

Obtiene el objeto de intervalo asociado a la fila de encabezado de la tabla.

getHeaderRowRange(): Excel.Range;

Devoluciones

Excel.Range

Comentarios

Ejemplos

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    const tableHeaderRange = table.getHeaderRowRange();
    tableHeaderRange.load('address');
    await context.sync();

    console.log(tableHeaderRange.address);
});

getRange()

Obtiene el objeto de rango asociado a toda la tabla.

getRange(): Excel.Range;

Devoluciones

Excel.Range

Comentarios

Ejemplos

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    const tableRange = table.getRange();
    tableRange.load('address');    
    await context.sync();
    
    console.log(tableRange.address);
});

getTotalRowRange()

Obtiene el objeto de intervalo asociado a la fila de totales de la tabla.

getTotalRowRange(): Excel.Range;

Devoluciones

Excel.Range

Comentarios

Ejemplos

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    const tableTotalsRange = table.getTotalRowRange();
    tableTotalsRange.load('address');    
    await context.sync();
    
    console.log(tableTotalsRange.address);
});

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.TableLoadOptions): Excel.Table;

Parámetros

options: Excel.Interfaces.TableLoadOptions

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

Devoluciones

Excel.Table

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

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.Table

Ejemplos

// Get a table by name.
await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    table.load('id')
    await context.sync();
    
    console.log(table.id);
});

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

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.Table

reapplyFilters()

Vuelve a aplicar todos los filtros aplicados actualmente en la tabla.

reapplyFilters(): void;

Devoluciones

void

Comentarios