SortField Object (JavaScript API for Excel)

Represents a condition in a sorting operation.

Properties

Property Type Description Req. Set
ascending bool Represents whether the sorting is done in an ascending fashion. 1.2
color string Represents the color that is the target of the condition if the sorting is on font or cell color. 1.2
dataOption string Represents additional sorting options for this field. Possible values are: Normal, TextAsNumber. 1.2
key int Represents the column (or row, depending on the sort orientation) that the condition is on. Represented as an offset from the first column (or row). 1.2
sortOn string Represents the type of sorting of this condition. Possible values are: Value, CellColor, FontColor, Icon. 1.2

See property access examples.

Relationships

Relationship Type Description Req. Set
icon Icon Represents the icon that is the target of the condition if the sorting is on the cell's icon. 1.2

Methods

None

ion Req. Set load(param: object) void Fills the proxy object created in JavaScript layer with property and object values specified in the parameter. 1.1

Method Details

load(param: object)

Fills the proxy object created in JavaScript layer with property and object values specified in the parameter.

Syntax

object.load(param);

Parameters

Parameter Type Description  
param object Optional. Accepts parameter and relationship names as delimited string or an array. Or, provide loadOption object.  

Returns

void