Excel.Table class

Représente l’objet AutoFilter de la table.

readonly autoFilter: Excel.AutoFilter;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

Représente une collection de toutes les colonnes du tableau.

readonly columns: Excel.TableColumnCollection;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Indique si la première colonne contient une mise en forme spéciale.

highlightFirstColumn: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.3

Indique si la dernière colonne contient une mise en forme spéciale.

highlightLastColumn: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.3

Renvoie une valeur qui permet d’identifier le tableau dans un classeur donné. La valeur de l’identificateur reste identique, même lorsque le tableau est renommé.

readonly id: string;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

Renvoie un identifiant numérique.

readonly legacyId: string;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.8

Nom du tableau.

Le nom défini du tableau doit suivre les instructions spécifiées dans l’article Renommer un tableau Excel .

name: string;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/46-table/convert-range-to-table.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const expensesTable: Excel.Table = sheet.tables.add('A1:E7', true);
    expensesTable.name = "ExpensesTable";

    await context.sync();
});

Représente une collection de toutes les lignes du tableau.

readonly rows: Excel.TableRowCollection;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/46-table/add-rows-and-columns-to-a-table.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const expensesTable: Excel.Table = sheet.tables.getItem("ExpensesTable");

    expensesTable.rows.add(null, [
    ["1/16/2017", "THE PHONE COMPANY", "Communications", "$120"],
    ["1/20/2017", "NORTHWIND ELECTRIC CARS", "Transportation", "$142"],
    ["1/20/2017", "BEST FOR YOU ORGANICS COMPANY", "Groceries", "$27"]
    ]);

    sheet.getUsedRange().format.autofitColumns();
    sheet.getUsedRange().format.autofitRows();

    await context.sync();
});

Indique si les colonnes présentent une mise en forme à bandes dans laquelle les colonnes impaires sont mises en surbrillance différemment des colonnes paires, afin de faciliter la lecture de la table.

showBandedColumns: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.3

Spécifie si les lignes présentent une mise en forme à bandes dans laquelle les lignes impaires sont mises en surbrillance différemment des lignes paires, afin de faciliter la lecture de la table.

showBandedRows: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.3

Indique si les boutons de filtre sont visibles en haut de chaque en-tête de colonne. Ce paramètre est autorisé uniquement si le tableau contient une ligne d’en-tête.

showFilterButton: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.3

Indique si la ligne d’en-tête est visible. Cette valeur peut être définie de manière à afficher ou à masquer la ligne d’en-tête.

showHeaders: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

Indique si la ligne des totaux est visible. Cette valeur peut être définie de manière à afficher ou à masquer la ligne de total.

showTotals: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

Représente le tri du tableau.

readonly sort: Excel.TableSort;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.2

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/46-table/sort-data.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const expensesTable: Excel.Table = sheet.tables.getItem("ExpensesTable");

    // Sort the table by the "Amount" column.
    const sortFields = [
        {
        key: 3,
        ascending: false
        }
    ];
    expensesTable.sort.apply(sortFields);

    await context.sync();
});

Valeur constante qui représente le style de tableau. Les valeurs possibles sont : « TableStyleLight1 » à « TableStyleLight21 », « TableStyleMedium1 » à « TableStyleMedium28 », « TableStyleDark1 » à « TableStyleDark11 ». Vous pouvez également indiquer un style personnalisé présent dans le classeur.

style: string;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

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

Feuille de calcul contenant le tableau actif.

readonly worksheet: Excel.Worksheet;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.2

Supprime tous les filtres appliqués actuellement sur le tableau.

clearFilters(): void;

Retours

Remarques

Jeu d’API : ExcelApi 1.2

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/46-table/filter-data.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const expensesTable = sheet.tables.getItem("ExpensesTable");
    expensesTable.clearFilters();
    await context.sync();
   });

Convertit le tableau en plage normale de cellules. Toutes les données sont conservées.

convertToRange(): Excel.Range;

Retours

Remarques

Jeu d’API : ExcelApi 1.2

Exemples

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

Supprime le tableau.

delete(): void;

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

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

Obtient l’objet de plage associé au corps de données du tableau.

getDataBodyRange(): Excel.Range;

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

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

Obtient l’objet de plage associé à la ligne d’en-tête du tableau.

getHeaderRowRange(): Excel.Range;

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

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

Renvoie l’objet de plage associé à l’intégralité du tableau.

getRange(): Excel.Range;

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

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

Obtient l’objet de plage associé à la ligne de total du tableau.

getTotalRowRange(): Excel.Range;

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

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

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Excel.Interfaces.TableLoadOptions): Excel.Table;

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Excel.Table;

Paramètres

Retours

Exemples

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

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Table;

Paramètres

Retours

Applique de nouveau tous les filtres actuellement appliqués sur le tableau.

reapplyFilters(): void;

Retours

Remarques

Jeu d’API : ExcelApi 1.2

Redimensionner le tableau sur la nouvelle plage. La nouvelle plage doit chevaucher la plage de tableau d’origine et les en-têtes (ou le haut du tableau) doivent se trouver dans la même ligne.

resize(newRange: Range | string): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.13

Exemples

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

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

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

Paramètres

Retours

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Excel.Table): void;

Paramètres

Retours

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.Table est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.TableDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.TableData;

Retours

Se produit lorsque les données dans les cellules changent dans une table spécifique.

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

Type d’événement

Remarques

Jeu d’API : ExcelApi 1.7

Exemples

// 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 produit lorsque la sélection change sur une table spécifique.

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

Type d’événement

Remarques

Jeu d’API : ExcelApi 1.7

Exemples

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