Excel.Table class

Especifica el texto alternativo de accesibilidad.

altTextDescription: string;

Valor de propiedad

Comentarios

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

Especifica un resumen de la tabla, como el que usan los lectores de pantalla.

altTextTitle: string;

Valor de propiedad

Comentarios

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

Representa el AutoFilter objeto de la tabla.

readonly autoFilter: Excel.AutoFilter;

Valor de propiedad

Comentarios

Conjunto de API: ExcelApi 1.9

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

Especifica un comentario asociado a la tabla.

comment: string;

Valor de propiedad

Comentarios

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

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

Especifica si la primera columna contiene formato especial.

highlightFirstColumn: boolean;

Valor de propiedad

Comentarios

Conjunto de API: ExcelApi 1.3

Especifica si la última columna contiene formato especial.

highlightLastColumn: boolean;

Valor de propiedad

Comentarios

Conjunto de API: ExcelApi 1.3

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

Comentarios

Conjunto de API: ExcelApi 1.1

Recupera si la tabla está actualmente activa.

readonly isActive: boolean;

Valor de propiedad

Comentarios

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

Devuelve un ID. numérico.

readonly legacyId: string;

Valor de propiedad

Comentarios

Conjunto de API: ExcelApi 1.8

Nombre de la tabla.

El nombre establecido de la tabla debe seguir las directrices especificadas en el artículo Cambiar el nombre de una tabla de Excel .

name: string;

Valor de propiedad

Comentarios

Conjunto de API: ExcelApi 1.1

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

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

showBandedColumns: boolean;

Valor de propiedad

Comentarios

Conjunto de API: ExcelApi 1.3

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

Comentarios

Conjunto de API: ExcelApi 1.3

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

Comentarios

Conjunto de API: ExcelApi 1.3

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

Comentarios

Conjunto de API: ExcelApi 1.1

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

showTotals: boolean;

Valor de propiedad

Comentarios

Conjunto de API: ExcelApi 1.1

Representa la ordenación de la tabla.

readonly sort: Excel.TableSort;

Valor de propiedad

Comentarios

Conjunto de API: ExcelApi 1.2

Recupera el tipo de origen de datos del que procede la tabla.

readonly source: Excel.TableSource | "External" | "Range" | "Xml" | "Query" | "Model";

Valor de propiedad

Comentarios

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

Valor constante que representa el estilo de la 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

Comentarios

Conjunto de API: ExcelApi 1.1

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

El estilo aplicado a la tabla.

readonly tableStyle: Excel.TableStyle;

Valor de propiedad

Comentarios

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

Hoja de cálculo que contiene la tabla actual.

readonly worksheet: Excel.Worksheet;

Valor de propiedad

Comentarios

Conjunto de API: ExcelApi 1.2

Borra todos los filtros aplicados actualmente en la tabla.

clearFilters(): void;

Devoluciones

Comentarios

Conjunto de API: ExcelApi 1.2

Cambia la tabla para usar el estilo de tabla predeterminado.

clearStyle(): void;

Devoluciones

Comentarios

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

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

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

Elimina la tabla.

delete(): void;

Devoluciones

Comentarios

Conjunto de API: ExcelApi 1.1

Ejemplos

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

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

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

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

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

Obtiene el objeto de rango asociado a toda la tabla.

getRange(): Excel.Range;

Devoluciones

Comentarios

Conjunto de API: ExcelApi 1.1

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

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

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

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

Devoluciones

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

Devoluciones

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

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

Devoluciones

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

reapplyFilters(): void;

Devoluciones

Comentarios

Conjunto de API: ExcelApi 1.2

Cambiar el tamaño de la tabla al nuevo rango. El nuevo rango debe superponerse con el rango 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

Devoluciones

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

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

Devoluciones

Establece varias propiedades en el objeto al mismo tiempo, basadas en un objeto cargado existente.

set(properties: Excel.Table): void;

Parámetros

Devoluciones

Establece el estilo aplicado a la tabla.

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

Parámetros

Devoluciones

Comentarios

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

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.Table es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.TableData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.

toJSON(): Excel.Interfaces.TableData;

Devoluciones

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

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

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

Tipo de evento

Comentarios

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

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