Excel.Table class

Representa una tabla de Excel. Para obtener más información sobre el modelo de objetos de tabla, lea Trabajar con tablas mediante la API Excel JavaScript.

Extends

Comentarios

[Conjunto de API: ExcelApi 1.1 ]

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 con el Office proceso de la aplicación host.

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 el nombre de Excel tabla.

rows

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

showBandedColumns

Especifica si las columnas muestran un formato con bandas en el que las columnas impares se resaltan de forma diferente a incluso las columnas, para facilitar la lectura de la tabla.

showBandedRows

Especifica si las filas muestran un formato con bandas en el 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 través de "TableStyleLight21", "TableStyleMedium1" a través de "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 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 para proporcionar resultados más útiles cuando se pasa un objeto API a toJSON()``JSON.stringify(). (JSON.stringify, a su vez, llama toJSON al método del objeto que se pasa a él). Mientras que la Excel. El objeto Table es un objeto API, toJSON el método devuelve un objeto JavaScript sin formato (se escribe comoExcel.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

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

Comentarios

[Conjunto de API: ExcelApi 1.1 ]

context

Contexto de solicitud asociado al objeto. Esto conecta el proceso del complemento con el Office proceso de la aplicación host.

context: RequestContext;

Valor de propiedad

highlightFirstColumn

Especifica si la primera columna contiene formato especial.

highlightFirstColumn: boolean;

Valor de propiedad

boolean

Comentarios

[Conjunto de API: ExcelApi 1.3 ]

highlightLastColumn

Especifica si la última columna contiene formato especial.

highlightLastColumn: boolean;

Valor de propiedad

boolean

Comentarios

[Conjunto de API: ExcelApi 1.3 ]

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

[Conjunto de API: ExcelApi 1.1 ]

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 el nombre de Excel tabla.

name: string;

Valor de propiedad

string

Comentarios

[Conjunto de API: ExcelApi 1.1 ]

rows

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

readonly rows: Excel.TableRowCollection;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.1 ]

showBandedColumns

Especifica si las columnas muestran un formato con bandas en el que las columnas impares se resaltan de forma diferente a incluso las columnas, para facilitar la lectura de la tabla.

showBandedColumns: boolean;

Valor de propiedad

boolean

Comentarios

[Conjunto de API: ExcelApi 1.3 ]

showBandedRows

Especifica si las filas muestran un formato con bandas en el 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

[Conjunto de API: ExcelApi 1.3 ]

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

[Conjunto de API: ExcelApi 1.3 ]

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

[Conjunto de API: ExcelApi 1.1 ]

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

[Conjunto de API: ExcelApi 1.1 ]

sort

Representa la ordenación de la tabla.

readonly sort: Excel.TableSort;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.2 ]

style

Valor constante que representa el estilo de tabla. Los valores posibles son: "TableStyleLight1" a través de "TableStyleLight21", "TableStyleMedium1" a través de "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 1.1 ]

Ejemplos

// Set table style. 
Excel.run(function (ctx) { 
    var tableName = 'Table1';
    var table = ctx.workbook.tables.getItem(tableName);
    table.name = 'Table1-Renamed';
    table.showTotals = false;
    table.style = 'TableStyleMedium2';
    table.load('tableStyle');
    return ctx.sync().then(function() {
            console.log(table.style);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

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

Comentarios

[Conjunto de API: ExcelApi BETA (SOLO VISTA PREVIA) ]

worksheet

Hoja de cálculo que contiene la tabla actual.

readonly worksheet: Excel.Worksheet;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.2 ]

Detalles del método

clearFilters()

Borra todos los filtros aplicados actualmente en la tabla.

clearFilters(): void;

Devoluciones

void

Comentarios

[Conjunto de API: ExcelApi 1.2 ]

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

[Conjunto de API: ExcelApi BETA (SOLO VISTA PREVIA) ]

convertToRange()

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

convertToRange(): Excel.Range;

Devoluciones

Comentarios

[Conjunto de API: ExcelApi 1.2 ]

Ejemplos

Excel.run(function (ctx) { 
    var tableName = 'Table1';
    var table = ctx.workbook.tables.getItem(tableName);
    table.convertToRange();
    return ctx.sync(); 
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

delete()

Elimina la tabla.

delete(): void;

Devoluciones

void

Comentarios

[Conjunto de API: ExcelApi 1.1 ]

Ejemplos

Excel.run(function (ctx) { 
    var tableName = 'Table1';
    var table = ctx.workbook.tables.getItem(tableName);
    table.delete();
    return ctx.sync(); 
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getDataBodyRange()

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

getDataBodyRange(): Excel.Range;

Devoluciones

Comentarios

[Conjunto de API: ExcelApi 1.1 ]

Ejemplos

Excel.run(function (ctx) { 
    var tableName = 'Table1';
    var table = ctx.workbook.tables.getItem(tableName);
    var tableDataRange = table.getDataBodyRange();
    tableDataRange.load('address')
    return ctx.sync().then(function() {
            console.log(tableDataRange.address);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getHeaderRowRange()

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

getHeaderRowRange(): Excel.Range;

Devoluciones

Comentarios

[Conjunto de API: ExcelApi 1.1 ]

Ejemplos

Excel.run(function (ctx) { 
    var tableName = 'Table1';
    var table = ctx.workbook.tables.getItem(tableName);
    var tableHeaderRange = table.getHeaderRowRange();
    tableHeaderRange.load('address');
    return ctx.sync().then(function() {
        console.log(tableHeaderRange.address);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getRange()

Obtiene el objeto de rango asociado a toda la tabla.

getRange(): Excel.Range;

Devoluciones

Comentarios

[Conjunto de API: ExcelApi 1.1 ]

Ejemplos

Excel.run(function (ctx) { 
    var tableName = 'Table1';
    var table = ctx.workbook.tables.getItem(tableName);
    var tableRange = table.getRange();
    tableRange.load('address');    
    return ctx.sync().then(function() {
            console.log(tableRange.address);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getTotalRowRange()

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

getTotalRowRange(): Excel.Range;

Devoluciones

Comentarios

[Conjunto de API: ExcelApi 1.1 ]

Ejemplos

Excel.run(function (ctx) { 
    var tableName = 'Table1';
    var table = ctx.workbook.tables.getItem(tableName);
    var tableTotalsRange = table.getTotalRowRange();
    tableTotalsRange.load('address');    
    return ctx.sync().then(function() {
            console.log(tableTotalsRange.address);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

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 cargarán.

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

Parámetros

propertyNames

string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se cargarán.

Devoluciones

Ejemplos

// Get a table by name. 
Excel.run(function (ctx) { 
    var tableName = 'Table1';
    var table = ctx.workbook.tables.getItem(tableName);
    table.load('index')
    return ctx.sync().then(function() {
            console.log(table.index);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});
// Get a table by index.
Excel.run(function (ctx) { 
    var index = 0;
    var table = ctx.workbook.tables.getItemAt(0);
    table.load('id')
    return ctx.sync().then(function() {
            console.log(table.id);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

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 cargarán y es una cadena delimitada por comas que especifica las propiedades de navegación que propertyNamesAndPaths.expand se cargarán.

Devoluciones

reapplyFilters()

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

reapplyFilters(): void;

Devoluciones

void

Comentarios

[Conjunto de API: ExcelApi 1.2 ]

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.

resize(newRange: Range | string): void;

Parámetros

newRange

Excel.Range | string

El objeto de intervalo o la dirección de intervalo que se usará para determinar el nuevo tamaño de la tabla.

Devoluciones

void

Comentarios

[Conjunto de API: ExcelApi 1.13 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/46-table/resize-table.yaml
await Excel.run(async (context) => {
  // Retrieve the worksheet and a table on that worksheet.
  const sheet = context.workbook.worksheets.getItem("Sample");
  const expensesTable = sheet.tables.getItem("ExpensesTable");
  
  // Resize the table.
  expensesTable.resize("A1:D20");
  
  await context.sync();
});

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.TableUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parámetros

properties
Excel.Interfaces.TableUpdateData

Un objeto JavaScript con propiedades que se estructuran isomórficamente en 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, en función de un objeto cargado existente.

set(properties: Excel.Table): void;

Parámetros

properties
Excel.Table

Devoluciones

void

setStyle(style)

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.

Establece el estilo aplicado a la tabla.

setStyle(style: string | TableStyle | BuiltInTableStyle): void;

Parámetros

style

string | Excel.TableStyle | Excel.BuiltInTableStyle

Estilo que se aplicará a la tabla. Se InvalidArgumentException produce una cadena si se proporciona una cadena que no coincide con el nombre de ningún estilo.

Devoluciones

void

Comentarios

[Conjunto de API: ExcelApi BETA (SOLO VISTA PREVIA) ]

toJSON()

Invalida el método JavaScript para proporcionar resultados más útiles cuando se pasa un objeto API a toJSON()``JSON.stringify(). (JSON.stringify, a su vez, llama toJSON al método del objeto que se pasa a él). Mientras que la Excel. El objeto Table es un objeto API, toJSON el método devuelve un objeto JavaScript sin formato (se escribe comoExcel.Interfaces.TableData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Excel.Interfaces.TableData;

Devoluciones

Detalles del evento

onChanged

Se produce cuando los datos de las celdas cambian en una tabla específica.

readonly onChanged: OfficeExtension.EventHandlers<Excel.TableChangedEventArgs>;

Tipo de evento

Comentarios

[Conjunto de API: ExcelApi 1.7 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-table-changed.yaml
await Excel.run(async (context) => {
    let table = context.workbook.tables.getItemAt(0);
    table.onChanged.add(onChange);

    await context.sync();
    console.log("A handler has been registered for the onChanged event");
});

onFiltered

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.

Se produce cuando se aplica un filtro en una tabla específica.

readonly onFiltered: OfficeExtension.EventHandlers<Excel.TableFilteredEventArgs>;

Tipo de evento

Comentarios

[Conjunto de API: ExcelApi BETA (SOLO VISTA PREVIA) ]

onSelectionChanged

Se produce cuando la selección cambia en una tabla específica.

readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.TableSelectionChangedEventArgs>;

Tipo de evento

Comentarios

[Conjunto de API: ExcelApi 1.7 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-table-changed.yaml
await Excel.run(async (context) => {
    let table = context.workbook.tables.getItemAt(0);
    table.onSelectionChanged.add(onSelectionChange);

    await context.sync();
    console.log("A handler has been registered for table onSelectionChanged event");
});