ExcelScript.SortField interface

パッケージ:

ExcelScript

並べ替え操作の条件を表します。

プロパティ

ascending	並べ替えが昇順で行われるかどうかを指定します。
color	並べ替えがフォントまたはセルの色にある場合に条件のターゲットとなる色を指定します。
dataOption	このフィールドのその他の並べ替えオプションを表します。
icon	並べ替えがセルのアイコンにある場合に、条件の対象となるアイコンを指定します。
key	条件がオンになっている列 (並べ替えの向きに応じて行) を指定します。 最初の列 (または行) からのオフセットとして表されます。
sortOn	この条件の並べ替えの種類を指定します。
subField	並べ替えるリッチ値のターゲット プロパティ名であるサブフィールドを指定します。

プロパティの詳細

ascending

並べ替えが昇順で行われるかどうかを指定します。

ascending?: boolean;

プロパティ値

boolean

color

並べ替えがフォントまたはセルの色にある場合に条件のターゲットとなる色を指定します。

color?: string;

プロパティ値

string

例

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

このフィールドのその他の並べ替えオプションを表します。

dataOption?: SortDataOption;

プロパティ値

ExcelScript.SortDataOption

例

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

並べ替えがセルのアイコンにある場合に、条件の対象となるアイコンを指定します。

icon?: Icon;

プロパティ値

ExcelScript.Icon

key

条件がオンになっている列 (並べ替えの向きに応じて行) を指定します。 最初の列 (または行) からのオフセットとして表されます。

key: number;

プロパティ値

number

例

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

この条件の並べ替えの種類を指定します。

sortOn?: SortOn;

プロパティ値

ExcelScript.SortOn

subField

並べ替えるリッチ値のターゲット プロパティ名であるサブフィールドを指定します。

subField?: string;

プロパティ値

string