Edit

Share via

Excel.SortField interface

  • Reference
Package:
excel

Represents a condition in a sorting operation.

Remarks

[ API set: ExcelApi 1.2 ]

Properties

ascending

Specifies if the sorting is done in an ascending fashion.
color

Specifies the color that is the target of the condition if the sorting is on font or cell color.
dataOption

Represents additional sorting options for this field.
icon

Specifies the icon that is the target of the condition, if the sorting is on the cell's icon.
key

Specifies the column (or row, depending on the sort orientation) that the condition is on. Represented as an offset from the first column (or row).
sortOn

Specifies the type of sorting of this condition.
subField

Specifies the subfield that is the target property name of a rich value to sort on.

Property Details

ascending

Specifies if the sorting is done in an ascending fashion.

ascending?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.2 ]

color

Specifies the color that is the target of the condition if the sorting is on font or cell color.

color?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.2 ]

dataOption

Represents additional sorting options for this field.

dataOption?: Excel.SortDataOption | "Normal" | "TextAsNumber";

Property Value

Excel.SortDataOption | "Normal" | "TextAsNumber"

Remarks

[ API set: ExcelApi 1.2 ]

icon

Specifies the icon that is the target of the condition, if the sorting is on the cell's icon.

icon?: Excel.Icon;

Property Value

Excel.Icon

Remarks

[ API set: ExcelApi 1.2 ]

key

Specifies the column (or row, depending on the sort orientation) that the condition is on. Represented as an offset from the first column (or row).

key: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.2 ]

sortOn

Specifies the type of sorting of this condition.

sortOn?: Excel.SortOn | "Value" | "CellColor" | "FontColor" | "Icon";

Property Value

Excel.SortOn | "Value" | "CellColor" | "FontColor" | "Icon"

Remarks

[ API set: ExcelApi 1.2 ]

subField

Specifies the subfield that is the target property name of a rich value to sort on.

subField?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.9 ]