ExcelScript.RangeSort interface

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

方法

apply(fields, matchCase, hasHeaders, orientation, method)

执行排序操作。

方法详细信息

apply(fields, matchCase, hasHeaders, orientation, method)

执行排序操作。

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

参数

fields

ExcelScript.SortField[]

要用作排序依据的条件列表。

matchCase

boolean

可选。 是否让大小写对字符串排序产生影响。

hasHeaders

boolean

可选。 该区域是否有标头。

orientation
ExcelScript.SortOrientation

可选。 该操作是对行还是列排序。

method
ExcelScript.SortMethod

可选。 用于中文字符的排序方法。

返回

void

示例

/**
 * This script sorts the used range of the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
    // Get the used range of the current worksheet.
    const activeRange = workbook.getActiveWorksheet().getUsedRange();

    // Sort the rows in ascending order based on the last column.
    activeRange.getSort().apply(
        [{
            ascending: true,
            key: activeRange.getColumnCount() - 1
        }],
        false, /* Don't match case. */
        true,  /* Treat the first row as a header row. */
        ExcelScript.SortOrientation.rows
    );
}