ExcelScript.RangeSort interface

Pacote:

ExcelScript

Gere operações de ordenação em Range objetos.

Métodos

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

Executa uma operação de classificação.

Detalhes do método

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

Executa uma operação de classificação.

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

Parâmetros

fields

ExcelScript.SortField[]

A lista de condições para a classificação.

matchCase

boolean

Opcional. Define se o uso de maiúsculas ou minúsculas afeta a ordenação da cadeia de caracteres.

hasHeaders

boolean

Opcional. Se o intervalo tem um cabeçalho.

orientation

ExcelScript.SortOrientation

Opcional. Se a operação classifica linhas ou colunas.

method

ExcelScript.SortMethod

Opcional. O método de ordenação usado pelos caracteres chineses.

Retornos

void

Exemplos

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