ExcelScript.SortField interface

Pacote:

ExcelScript

Representa uma condição em uma operação de classificação.

Propriedades

ascending	Especifica se a classificação é feita de forma crescente.
color	Especifica a cor que é o destino da condição se a classificação estiver na fonte ou na cor da célula.
dataOption	Representa as opções de classificação adicionais para esse campo.
icon	Especifica o ícone que é o destino da condição, se a classificação estiver no ícone da célula.
key	Especifica a coluna (ou linha, dependendo da orientação de classificação) em que a condição está. Representado como um deslocamento da primeira coluna (ou linha).
sortOn	Especifica o tipo de classificação dessa condição.
subField	Especifica o subcampo que é o nome da propriedade de destino de um valor rico para classificar.

Detalhes da propriedade

ascending

Especifica se a classificação é feita de forma crescente.

ascending?: boolean;

Valor da propriedade

boolean

color

Especifica a cor que é o destino da condição se a classificação estiver na fonte ou na cor da célula.

color?: string;

Valor da propriedade

string

Exemplos

/**
 * This script sorts a range based on the color of the cells.
 * It brings all red cells to the top of the range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range (A1:D8) to sort from the current worksheet.
  const worksheet = workbook.getActiveWorksheet();
  const rangeToSort = worksheet.getRange("A1:D8");

  // Create a SortField for color sorting.
  // This sorts the rows based on the fill color of each row's cell in the first column.
  let colorSort: ExcelScript.SortField = {
    ascending: true,
    color: "FF0000", /* red */
    key: 0,
    sortOn: ExcelScript.SortOn.cellColor
  };

  // Apply the SortField to the range.
  rangeToSort.getSort().apply([colorSort]);
}

dataOption

Representa as opções de classificação adicionais para esse campo.

dataOption?: SortDataOption;

Valor da propriedade

ExcelScript.SortDataOption

Exemplos

/**
 * This script sorts a table based on the values in column 1.
 * If the text of a column-1 value can be treated as a number, 
 * it will be sorted in numerical order, rather than Unicode order
 * (so 123 will come before 12.3).
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first table on the current worksheet.
  const currentSheet = workbook.getActiveWorksheet();
  const table = currentSheet.getTables()[0];

  // Create the sorting parameters.
  const countSortField: ExcelScript.SortField = {
    key: 1,
    ascending: true,
    dataOption: ExcelScript.SortDataOption.textAsNumber
  };

  // Apply the sort to the table.
  const sort = table.getSort();
  sort.apply([countSortField]);
}

icon

Especifica o ícone que é o destino da condição, se a classificação estiver no ícone da célula.

icon?: Icon;

Valor da propriedade

ExcelScript.Icon

key

Especifica a coluna (ou linha, dependendo da orientação de classificação) em que a condição está. Representado como um deslocamento da primeira coluna (ou linha).

key: number;

Valor da propriedade

number

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 rows. */
        ExcelScript.SortOrientation.rows
    );
}

sortOn

Especifica o tipo de classificação dessa condição.

sortOn?: SortOn;

Valor da propriedade

ExcelScript.SortOn

subField

Especifica o subcampo que é o nome da propriedade de destino de um valor rico para classificar.

subField?: string;

Valor da propriedade

string