constructor

• new SortSettings$1<T>($t, a, b): SortSettings$1<T>

• Type parameters

  Type Parameters

  • T extends ISortable

  Parameters

  • $t: Type

  • a: ISortSettingsOwner

  • b: ((arg1) => void)

    • • (arg1): void

      • Parameters

        • arg1: T

        Returns void

  Returns SortSettings$1<T>

Static $t

caseSensitive

• 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

sortConditions

• sortConditions(sortableItem, value?): SortCondition

• 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

  • sortableItem: T

    The sort-able item for which to get or set the sort condition.

  • Optional value: SortCondition

  Returns SortCondition

• sortConditions(index, value?): KeyValuePair$2<T, 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<T, SortCondition>

  Returns KeyValuePair$2<T, SortCondition>

• sortConditions(): SortConditionCollection$1<T>

• 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<T>