ExcelScript.RangeSort interface

Пакет:

ExcelScript

Управляет операциями сортировки объектов 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
    );
}