Excel.Table class

Représente un tableau Excel. Pour en savoir plus sur le modèle objet tableau, lisez Utiliser des tableaux à l’aide de l Excel API JavaScript.

[Ensemble d’API : ExcelApi 1.1]

Extends

Propriétés

autoFilter

Représente AutoFilter l’objet du tableau.

[Ensemble d’API : ExcelApi 1.9]

columns

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

[Ensemble d’API : ExcelApi 1.1]

context

Contexte de demande associé à l’objet. Cette opération connecte le processus du Office processus de l’application hôte.

highlightFirstColumn

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

[Ensemble d’API : ExcelApi 1.3]

highlightLastColumn

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

[Ensemble d’API : ExcelApi 1.3]

id

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

[Ensemble d’API : ExcelApi 1.1]

legacyId

Renvoie un ID numérique.

[Ensemble d’API : ExcelApi 1.8]

name

Nom du tableau.

Le nom de jeu de la table doit suivre les instructions spécifiées dans l’article Renommer Excel table.

[Ensemble d’API : ExcelApi 1.1]

rows

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

[Ensemble d’API : ExcelApi 1.1]

showBandedColumns

Spécifie si les colonnes indiquent une mise en forme à bandes dans laquelle les colonnes impaires sont mises en surbrillante différemment des colonnes impaires, pour faciliter la lecture du tableau.

[Ensemble d’API : ExcelApi 1.3]

showBandedRows

Spécifie si les lignes indiquent une mise en forme à bandes dans laquelle les lignes impaires sont mises en surbrillante différemment des lignes impaires, pour faciliter la lecture du tableau.

[Ensemble d’API : ExcelApi 1.3]

showFilterButton

Spécifie 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.

[Ensemble d’API : ExcelApi 1.3]

showHeaders

Spécifie 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.

[Ensemble d’API : ExcelApi 1.1]

showTotals

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

[Ensemble d’API : ExcelApi 1.1]

sort

Représente le tri du tableau.

[Ensemble d’API : ExcelApi 1.2]

style

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

[Ensemble d’API : ExcelApi 1.1]

tableStyle

Style appliqué au tableau.

[Ensemble d’API : ExcelApi BÊTA (PRÉVISUALISATION UNIQUEMENT)]

worksheet

Feuille de calcul contenant le tableau actif.

[Ensemble d’API : ExcelApi 1.2]

Méthodes

clearFilters()

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

[Ensemble d’API : ExcelApi 1.2]

clearStyle()

Modifie le tableau pour utiliser le style de tableau par défaut.

[Ensemble d’API : ExcelApi BÊTA (PRÉVISUALISATION UNIQUEMENT)]

convertToRange()

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

[Ensemble d’API : ExcelApi 1.2]

delete()

Supprime le tableau.

[Ensemble d’API : ExcelApi 1.1]

getDataBodyRange()

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

[Ensemble d’API : ExcelApi 1.1]

getHeaderRowRange()

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

[Ensemble d’API : ExcelApi 1.1]

getRange()

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

[Ensemble d’API : ExcelApi 1.1]

getTotalRowRange()

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

[Ensemble d’API : ExcelApi 1.1]

load(options)

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)

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)

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.

reapplyFilters()

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

[Ensemble d’API : ExcelApi 1.2]

resize(newRange)

Resize the table to the new range. La nouvelle plage doit se chevaucher avec la plage du tableau d’origine et les en-têtes (ou le haut du tableau) doivent se trouver sur la même ligne.

[Ensemble d’API : ExcelApiOnline 1.1]

set(properties, options)

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

set(properties)

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

setStyle(style)

Définit le style appliqué au tableau.

[Ensemble d’API : ExcelApi BÊTA (PRÉVISUALISATION UNIQUEMENT)]

toJSON()

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

Événements

onChanged

Se produit lorsque les données des cellules changent dans un tableau spécifique.

[Ensemble d’API : ExcelApi 1.7]

onFiltered

Se produit lorsqu’un filtre est appliqué à une table spécifique.

[Ensemble d’API : ExcelApi BÊTA (PRÉVISUALISATION UNIQUEMENT)]

onSelectionChanged

Se produit lorsque la sélection change dans un tableau spécifique.

[Ensemble d’API : ExcelApi 1.7]

Détails de la propriété

autoFilter

Représente AutoFilter l’objet du tableau.

[Ensemble d’API : ExcelApi 1.9]

readonly autoFilter: Excel.AutoFilter;

Valeur de propriété

columns

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

[Ensemble d’API : ExcelApi 1.1]

readonly columns: Excel.TableColumnCollection;

Valeur de propriété

context

Contexte de demande associé à l’objet. Cette opération connecte le processus du Office processus de l’application hôte.

context: RequestContext;

Valeur de propriété

highlightFirstColumn

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

[Ensemble d’API : ExcelApi 1.3]

highlightFirstColumn: boolean;

Valeur de propriété

boolean

highlightLastColumn

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

[Ensemble d’API : ExcelApi 1.3]

highlightLastColumn: boolean;

Valeur de propriété

boolean

id

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

[Ensemble d’API : ExcelApi 1.1]

readonly id: string;

Valeur de propriété

string

legacyId

Renvoie un ID numérique.

[Ensemble d’API : ExcelApi 1.8]

readonly legacyId: string;

Valeur de propriété

string

name

Nom du tableau.

Le nom de jeu de la table doit suivre les instructions spécifiées dans l’article Renommer Excel table.

[Ensemble d’API : ExcelApi 1.1]

name: string;

Valeur de propriété

string

rows

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

[Ensemble d’API : ExcelApi 1.1]

readonly rows: Excel.TableRowCollection;

Valeur de propriété

showBandedColumns

Spécifie si les colonnes indiquent une mise en forme à bandes dans laquelle les colonnes impaires sont mises en surbrillante différemment des colonnes impaires, pour faciliter la lecture du tableau.

[Ensemble d’API : ExcelApi 1.3]

showBandedColumns: boolean;

Valeur de propriété

boolean

showBandedRows

Spécifie si les lignes indiquent une mise en forme à bandes dans laquelle les lignes impaires sont mises en surbrillante différemment des lignes impaires, pour faciliter la lecture du tableau.

[Ensemble d’API : ExcelApi 1.3]

showBandedRows: boolean;

Valeur de propriété

boolean

showFilterButton

Spécifie 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.

[Ensemble d’API : ExcelApi 1.3]

showFilterButton: boolean;

Valeur de propriété

boolean

showHeaders

Spécifie 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.

[Ensemble d’API : ExcelApi 1.1]

showHeaders: boolean;

Valeur de propriété

boolean

showTotals

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

[Ensemble d’API : ExcelApi 1.1]

showTotals: boolean;

Valeur de propriété

boolean

sort

Représente le tri du tableau.

[Ensemble d’API : ExcelApi 1.2]

readonly sort: Excel.TableSort;

Valeur de propriété

style

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

[Ensemble d’API : ExcelApi 1.1]

style: string;

Valeur de propriété

string

Exemples

// 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

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Style appliqué au tableau.

[Ensemble d’API : ExcelApi BÊTA (PRÉVISUALISATION UNIQUEMENT)]

readonly tableStyle: Excel.TableStyle;

Valeur de propriété

worksheet

Feuille de calcul contenant le tableau actif.

[Ensemble d’API : ExcelApi 1.2]

readonly worksheet: Excel.Worksheet;

Valeur de propriété

Détails de la méthode

clearFilters()

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

[Ensemble d’API : ExcelApi 1.2]

clearFilters(): void;

Retours

void

clearStyle()

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Modifie le tableau pour utiliser le style de tableau par défaut.

[Ensemble d’API : ExcelApi BÊTA (PRÉVISUALISATION UNIQUEMENT)]

clearStyle(): void;

Retours

void

convertToRange()

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

[Ensemble d’API : ExcelApi 1.2]

convertToRange(): Excel.Range;

Retours

Exemples

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

Supprime le tableau.

[Ensemble d’API : ExcelApi 1.1]

delete(): void;

Retours

void

Exemples

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

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

[Ensemble d’API : ExcelApi 1.1]

getDataBodyRange(): Excel.Range;

Retours

Exemples

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

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

[Ensemble d’API : ExcelApi 1.1]

getHeaderRowRange(): Excel.Range;

Retours

Exemples

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

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

[Ensemble d’API : ExcelApi 1.1]

getRange(): Excel.Range;

Retours

Exemples

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

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

[Ensemble d’API : ExcelApi 1.1]

getTotalRowRange(): Excel.Range;

Retours

Exemples

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)

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

options
Excel.Interfaces.TableLoadOptions

Fournit des options pour lesquelles les propriétés de l’objet à charger.

Retours

load(propertyNames)

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

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes spécifiant les propriétés à charger.

Retours

Exemples

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

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

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et est une chaîne délimitée par des virgules qui spécifie les propriétés de propertyNamesAndPaths.expand navigation à charger.

Retours

reapplyFilters()

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

[Ensemble d’API : ExcelApi 1.2]

reapplyFilters(): void;

Retours

void

resize(newRange)

Resize the table to the new range. La nouvelle plage doit se chevaucher avec la plage du tableau d’origine et les en-têtes (ou le haut du tableau) doivent se trouver sur la même ligne.

[Ensemble d’API : ExcelApiOnline 1.1]

resize(newRange: Range | string): void;

Paramètres

newRange

Excel.Range | string

Objet de plage ou adresse de plage qui sera utilisé pour déterminer la nouvelle taille du tableau.

Retours

void

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/85-preview-apis/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)

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

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

Paramètres

properties
Excel.Interfaces.TableUpdateData

Objet JavaScript avec des propriétés structurées de manière isomorphe aux propriétés de l’objet sur lequel la méthode est appelée.

options
OfficeExtension.UpdateOptions

Fournit une option pour supprimer les erreurs si l’objet propriétés tente de définir des propriétés en lecture seule.

Retours

void

Remarques

Cette méthode possède la signature supplémentaire suivante :

set(properties: Excel.Table): void

set(properties)

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

set(properties: Excel.Table): void;

Paramètres

properties
Excel.Table

Retours

void

setStyle(style)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Définit le style appliqué au tableau.

[Ensemble d’API : ExcelApi BÊTA (PRÉVISUALISATION UNIQUEMENT)]

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

Paramètres

style

string | Excel.TableStyle | Excel.BuiltInTableStyle

Style à appliquer au tableau. Une chaîne est lancée si une chaîne fournie ne correspond au nom InvalidArgumentException d’aucun style.

Retours

void

toJSON()

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

toJSON(): Excel.Interfaces.TableData;

Retours

Détails de l'événement

onChanged

Se produit lorsque les données des cellules changent dans un tableau spécifique.

[Ensemble d’API : ExcelApi 1.7]

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

Type d'événement

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

onFiltered

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Se produit lorsqu’un filtre est appliqué à une table spécifique.

[Ensemble d’API : ExcelApi BÊTA (PRÉVISUALISATION UNIQUEMENT)]

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

Type d'événement

onSelectionChanged

Se produit lorsque la sélection change dans un tableau spécifique.

[Ensemble d’API : ExcelApi 1.7]

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

Type d'événement

範例

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