ExcelScript.TableSort interface

Paquet:

ExcelScript

Gère les opérations de tri sur Table les objets.

Méthodes

apply(fields, matchCase, method)	Effectue une opération de tri.
clear()	Efface le tri actuellement appliqué au tableau. Même si le classement du tableau n’est pas modifié, l’état des boutons d’en-tête est rétabli.
getFields()	Spécifie les conditions actuelles utilisées pour le dernier tri de la table.
getMatchCase()	Spécifie si la casse a un impact sur le dernier type de la table.
getMethod()	Représente la dernière méthode de classement des caractères chinois utilisée pour trier la table.
reapply()	Applique à nouveau les paramètres actuels de tri au tableau.

Détails de la méthode

apply(fields, matchCase, method)

Effectue une opération de tri.

apply(
            fields: SortField[],
            matchCase?: boolean,
            method?: SortMethod
        ): void;

Paramètres

fields

ExcelScript.SortField[]

Liste des conditions de tri.

matchCase

boolean

Optional. Indique si la casse influe sur le classement des chaînes.

method

ExcelScript.SortMethod

Optional. Méthode de classement utilisée pour les caractères chinois.

Retours

void

Exemples

/**
 * This sample creates a table from the current worksheet's used range, then sorts it based on the first column.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Create a table with the used cells.
  let usedRange = selectedSheet.getUsedRange();
  let newTable = selectedSheet.addTable(usedRange, true);

  // Sort the table using the first column.
  newTable.getSort().apply([{ key: 0, ascending: true }]);
}

clear()

Efface le tri actuellement appliqué au tableau. Même si le classement du tableau n’est pas modifié, l’état des boutons d’en-tête est rétabli.

clear(): void;

Retours

void

getFields()

Spécifie les conditions actuelles utilisées pour le dernier tri de la table.

getFields(): SortField[];

Retours

ExcelScript.SortField[]

getMatchCase()

Spécifie si la casse a un impact sur le dernier type de la table.

getMatchCase(): boolean;

Retours

boolean

getMethod()

Représente la dernière méthode de classement des caractères chinois utilisée pour trier la table.

getMethod(): SortMethod;

Retours

ExcelScript.SortMethod

reapply()

Applique à nouveau les paramètres actuels de tri au tableau.

reapply(): void;

Retours

void

Exemples

/**
 * This script reapplies all the current sorting criteria to existing tables.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get all the tables.
  const tables = workbook.getTables();

  // For each table, reapply that table's current sorting parameters.
  tables.forEach((table) => {
    const sort: ExcelScript.TableSort = table.getSort();
    sort.reapply();
  });
}