ExcelScript.TableSort interface

パッケージ:

ExcelScript

Table オブジェクトに対する並べ替え操作を管理します。

メソッド

apply(fields, matchCase, method)	並べ替え操作を実行します。
clear()	テーブルに現在設定されている並べ替えをクリアします。 これにより表の順序が変更されることはありませんが、ヘッダーのボタンの状態がクリアされます。
getFields()	テーブルの最後の並べ替えに使用される現在の条件を指定します。
getMatchCase()	大文字と小文字がテーブルの最後の並べ替えに影響するかどうかを指定します。
getMethod()	テーブルの並べ替えに最後に使用した中国語の文字順序付けメソッドを表します。
reapply()	テーブルに、現在の並べ替えパラメーターを再適用します。

メソッドの詳細

apply(fields, matchCase, method)

並べ替え操作を実行します。

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

パラメーター

fields

ExcelScript.SortField[]

並べ替えに使用する条件の一覧。

matchCase

boolean

省略可能。 大文字小文字の区別が文字列の順序に影響を与えるかどうか。

method

ExcelScript.SortMethod

省略可能。 中国語文字に使用される順序付けの方法です。

戻り値

void

例

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

テーブルに現在設定されている並べ替えをクリアします。 これにより表の順序が変更されることはありませんが、ヘッダーのボタンの状態がクリアされます。

clear(): void;

戻り値

void

getFields()

テーブルの最後の並べ替えに使用される現在の条件を指定します。

getFields(): SortField[];

戻り値

ExcelScript.SortField[]

getMatchCase()

大文字と小文字がテーブルの最後の並べ替えに影響するかどうかを指定します。

getMatchCase(): boolean;

戻り値

boolean

getMethod()

テーブルの並べ替えに最後に使用した中国語の文字順序付けメソッドを表します。

getMethod(): SortMethod;

戻り値

ExcelScript.SortMethod

reapply()

テーブルに、現在の並べ替えパラメーターを再適用します。

reapply(): void;

戻り値

void

例

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