ExcelScript.SortField interface

Paquete:

ExcelScript

Representa una condición en una operación de ordenación.

Propiedades

ascending	Especifica si la ordenación se realiza de forma ascendente.
color	Especifica el color que es el destino de la condición si la ordenación está en color de fuente o celda.
dataOption	Representa opciones de ordenación adicionales para este campo.
icon	Especifica el icono que es el destino de la condición, si la ordenación está en el icono de la celda.
key	Especifica la columna (o fila, en función de la orientación de ordenación) en la que se encuentra la condición. Se representa como un desplazamiento de la primera columna (o fila).
sortOn	Especifica el tipo de ordenación de esta condición.
subField	Especifica el subcampo que es el nombre de propiedad de destino de un valor enriquecido por el que se va a ordenar.

Detalles de las propiedades

ascending

Especifica si la ordenación se realiza de forma ascendente.

ascending?: boolean;

Valor de propiedad

boolean

color

Especifica el color que es el destino de la condición si la ordenación está en color de fuente o celda.

color?: string;

Valor de propiedad

string

Ejemplos

/**
 * 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 opciones de ordenación adicionales para este campo.

dataOption?: SortDataOption;

Valor de propiedad

ExcelScript.SortDataOption

Ejemplos

/**
 * 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 el icono que es el destino de la condición, si la ordenación está en el icono de la celda.

icon?: Icon;

Valor de propiedad

ExcelScript.Icon

key

Especifica la columna (o fila, en función de la orientación de ordenación) en la que se encuentra la condición. Se representa como un desplazamiento de la primera columna (o fila).

key: number;

Valor de propiedad

number

Ejemplos

/**
 * 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 el tipo de ordenación de esta condición.

sortOn?: SortOn;

Valor de propiedad

ExcelScript.SortOn

subField

Especifica el subcampo que es el nombre de propiedad de destino de un valor enriquecido por el que se va a ordenar.

subField?: string;

Valor de propiedad

string