ExcelScript.TableSort interface

包:

ExcelScript

管理对 Table 对象的排序操作。

方法

apply(fields, matchCase, method)	执行排序操作。
clear()	清除表上的当前排序。 尽管这不能修改表的排序，但它会清除标题按钮的状态。
getFields()	指定用于上次对表进行排序的当前条件。
getMatchCase()	指定大小写是否影响表的最后一种类型。
getMethod()	表示上次用于对表进行排序的中文字符排序方法。
reapply()	对 table 重新应用当前的排序参数。

方法详细信息

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

对 table 重新应用当前的排序参数。

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