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: TypecaseSensitive
Section titled "caseSensitive"Inherited from: RelativeIndexSortSettings
caseSensitive: booleansortType
Section titled "sortType"sortType: WorksheetSortTypeAccessors
Section titled "Accessors"region
Section titled "region"Returns the region that the filter settings is applied to (read-only).
get region(): WorksheetRegionReturns WorksheetRegion
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