Exposes methods to identify a region in the wroksheet and to apply sort criteria to that region.
Constructors
Section titled "Constructors"WorksheetSortSettings
new WorksheetSortSettings(a: Worksheet, b: object): WorksheetSortSettingsReturns WorksheetSortSettings
Properties
Section titled "Properties"$t: TypeAccessors
Section titled "Accessors"caseSensitive
Section titled "caseSensitive"Inherited from: RelativeIndexSortSettings
Gets or sets the value which indicates whether strings should be compared case-sensitively when they are sorted.
get caseSensitive(): boolean
Returns boolean
set caseSensitive(a: boolean): voidParameters
- a:
boolean
Returns void
region
Section titled "region"Returns the region that the filter settings is applied to (read-only).
get region(): WorksheetRegion
Returns WorksheetRegion
sortType
Section titled "sortType"Determines whether columns or rows will be sorted within the region. 'Rows' is the default. Note: when this property is changed all existing sort conditions will be cleared so this property should be set before sort conditions are added.
get sortType(): WorksheetSortType
Returns WorksheetSortType
Methods
Section titled "Methods"clearRegion
Section titled "clearRegion"Clears the region as well as any existing sort criteria
clearRegion(): voidReturns void
reapplySortConditions
Section titled "reapplySortConditions"Re-sorts all data cells in the region based on the sort conditions.
reapplySortConditions(): voidReturns void
setRegion
Section titled "setRegion"Sets the region where the filter settings should be applied
setRegion(address: string): voidParameters
- address:
stringThe address of the new region.
Returns void
sortConditions
Section titled "sortConditions"Inherited from: RelativeIndexSortSettings
Gets or sets the sort condition for the specified sort-able item.
sortConditions(sortableItem: RelativeIndex, value: SortCondition): SortConditionParameters
- sortableItem:
RelativeIndexThe sort-able item for which to get or set the sort condition.
- value:
SortCondition