ExcelScript.TableSort interface

Gerencia operações de classificação em objetos Table.

Métodos

apply(fields, matchCase, method)

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

clear()

Limpa a classificação que está na tabela. Essa ação não modifica a ordenação da tabela, mas limpa o estado dos botões do cabeçalho.

getFields()

Especifica as condições atuais usadas para classificar a tabela pela última vez.

getMatchCase()

Especifica se o capital próprio impacta o último tipo da tabela.

getMethod()

Indica o último método de ordenação de caracteres chineses usado para classificar a tabela.

reapply()

Reaplica os parâmetros de classificação atuais à tabela.

Detalhes do método

apply(fields, matchCase, method)

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

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

Parâmetros

fields
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.

method
SortMethod

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

Retornos

void

Exemplos

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

Limpa a classificação que está na tabela. Essa ação não modifica a ordenação da tabela, mas limpa o estado dos botões do cabeçalho.

clear(): void;

Retornos

void

getFields()

Especifica as condições atuais usadas para classificar a tabela pela última vez.

getFields(): SortField[];

Retornos

getMatchCase()

Especifica se o capital próprio impacta o último tipo da tabela.

getMatchCase(): boolean;

Retornos

boolean

getMethod()

Indica o último método de ordenação de caracteres chineses usado para classificar a tabela.

getMethod(): SortMethod;

Retornos

reapply()

Reaplica os parâmetros de classificação atuais à tabela.

reapply(): void;

Retornos

void