Represents the settings which apply to sorting a region of values based on indices relative to either the Worksheet's [[Worksheet.filterSettings]] or [[Worksheet.sortSettings]] region.

Hierarchy

Hierarchy (view full)

Constructors

Properties

$type: Type
$t: Type
nextHashCode: number

Accessors

  • get caseSensitive(): boolean
  • Gets or sets the value which indicates whether strings should be compared case-sensitively when they are sorted.

    This is only applicable to sort conditions which sort strings.

    True to sort strings case-sensitively; False to ignore case.

    Returns boolean

  • set caseSensitive(a): void
  • Parameters

    • a: boolean

    Returns void

Methods

  • Parameters

    • other: any

    Returns boolean

  • Returns number

  • Returns Base

  • Gets or sets the sort condition for the specified sort-able item.

    Throws

    [[ArgumentNullException]] 'sortableItem' is null.

    Throws

    [[InvalidOperationException]] The sort-able item is not already in the collection and there are already 64 sort conditions in the collection.

    Parameters

    Returns SortCondition

  • Gets or sets the pair of item and sort condition at the specified index.

    Throws

    [[ArgumentNullException]] The Key or Value of the assigned value is null.

    Throws

    [[InvalidOperationException]] The Key of the assigned value already in the collection at a different index.

    Parameters

    • index: number

      The index at which to get the pair of item and sort condition.

    • Optional value: KeyValuePair$2<RelativeIndex, SortCondition>

    Returns KeyValuePair$2<RelativeIndex, SortCondition>

  • Gets the collection of sort conditions to use when sorting the region of data.

    If these settings are used in a [[WorksheetTable]], each sort condition in the collection applies to a [[WorksheetTableColumn]].

    This collection is ordered based on precedence. The first sort condition in the collection has the highest sort precedence.

    See

    [[WorksheetTableColumn.sortCondition]]

    Returns SortConditionCollection$1<RelativeIndex>

  • Parameters

    • item1: any
    • item2: any

    Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

  • Parameters

    • obj: any

    Returns any[]

  • Parameters

    • obj: any

    Returns any[]

  • Parameters

    • obj: any

    Returns number

  • Parameters

    • a: any
    • b: any

    Returns boolean