SortModel

Defined in: api/node/typescript/models.ts:663 ↗

SortModel acts as an adapter model for a given source model by sorting all its rows according to the order given by compareFunction.

Note that, like FilterModel, the SortModel does not automatically observe modifications made directly to the source model. After such a modification, call SortModel.reset to re-apply the sort order and refresh the sorted view. Modifications made through SortModel.setRowData are reflected automatically.

Calling SortModel.setRowData while the cached sort order is stale (i.e. after the source model was mutated directly without a following SortModel.reset) does not just return stale reads — it writes to whatever source row the stale order points at, which may no longer be the row the caller intended. Always call SortModel.reset after a direct source mutation before calling SortModel.setRowData again.

Example

const source = new ArrayModel(["lorem", "ipsum", "dolor"]);
const sorted = new SortModel(source, (a, b) => a.localeCompare(b));

// prints dolor, ipsum, lorem
for (const x of sorted) {
    console.log(x);
}

js

Extends

• Model<T>

Type Parameters

T

T

Constructors

Constructor

new SortModel<T>(sourceModel, compareFunction): SortModel<T>

Defined in: api/node/typescript/models.ts:678 ↗

Constructs a new SortModel that provides a sorted view on the given sourceModel by applying the order given by compareFunction.

Parameters

sourceModel

Model<T>

the wrapped model.

compareFunction

(a, b) => number

compares two rows the same way the callback passed to Array.prototype.sort does.

Returns

SortModel<T>

Overrides

Model<T>.constructor

Properties

sourceModel

readonly sourceModel: Model<T>

Defined in: api/node/typescript/models.ts:667 ↗

The source model that this SortModel sorts rows from.

Methods

[iterator]()

[iterator](): Iterator<T>

Defined in: api/node/typescript/models.ts:196 ↗

Returns

Iterator<T>

Inherited from

Model.[iterator]

---

filter()

filter(filterFunction): FilterModel<T>

Defined in: api/node/typescript/models.ts:118 ↗

Returns a new Model that only contains the rows of this model for which filterFunction returns true.

Parameters

filterFunction

(data) => boolean

returns true if a row should be visible.

Returns

FilterModel<T>

a new FilterModel that wraps the current model.

Inherited from

Model.filter

---

insertRow()

insertRow(_index, _data): void

Defined in: api/node/typescript/models.ts:190 ↗

Implementations of this function must add a row at the specified index, pushing all next rows to the right.

Parameters

_index

number

index of the row to insert.

_data

T

new data item to store in a new row.

Returns

void

Inherited from

Model.insertRow

---

map()

map<U>(mapFunction): MapModel<T, U>

Defined in: api/node/typescript/models.ts:108 ↗

Returns a new Model where all elements are mapped by the function mapFunction.

Type Parameters

U

U

Parameters

mapFunction

(data) => U

maps the data from T to U.

Returns

MapModel<T, U>

a new MapModel that wraps the current model.

Inherited from

Model.map

---

pushRow()

pushRow(_data): void

Defined in: api/node/typescript/models.ts:168 ↗

Implementations of this function must add a line to the model with the provided data.

Parameters

_data

T

new data item to store in a new row.

Returns

void

Inherited from

Model.pushRow

---

removeRow()

removeRow(_index): void

Defined in: api/node/typescript/models.ts:178 ↗

Implementations of this function must remove the row at the specified index.

Parameters

_index

number

index of the row to remove.

Returns

void

Inherited from

Model.removeRow

---

reset()

reset(): void

Defined in: api/node/typescript/models.ts:788 ↗

Re-applies the sort order on the rows of the source model and notifies the run-time that the sorted view has changed. Call this after modifying the source model directly, so that the sorted view reflects the current state of the source model.

Returns

void

---

reverse()

reverse(): ReverseModel<T>

Defined in: api/node/typescript/models.ts:137 ↗

Returns a new Model with the same rows as this model, in reverse order.

Returns

ReverseModel<T>

a new ReverseModel that wraps the current model.

Inherited from

Model.reverse

---

rowCount()

rowCount(): number

Defined in: api/node/typescript/models.ts:730 ↗

Returns the number of entries in the sorted model.

Returns

number

Overrides

Model.rowCount

---

rowData()

rowData(row): T | undefined

Defined in: api/node/typescript/models.ts:739 ↗

Returns the data at the specified row.

Parameters

row

number

index in range 0..(rowCount() - 1).

Returns

T | undefined

undefined if row is out of range otherwise the data.

Overrides

Model.rowData

---

setRowData()

setRowData(row, data): void

Defined in: api/node/typescript/models.ts:760 ↗

Stores the given data in the source model at the row that corresponds to the given sorted row index, then re-reads it from the source model to find its new sorted position, notifying either a row change (position unchanged) or a row move (position changed) accordingly.

If the source model’s setRowData does not synchronously commit the value read back by rowData (for example a read-only model that ignores the write), the cached sort order may go out of sync; call SortModel.reset in that case.

Parameters

row

number

index in range 0..(rowCount() - 1).

data

T

new data item to store on the given row index.

Returns

void

Overrides

Model.setRowData

---

sort()

sort(compareFunction): SortModel<T>

Defined in: api/node/typescript/models.ts:129 ↗

Returns a new Model with the same rows as this model, ordered according to compareFunction.

Parameters

compareFunction

(a, b) => number

compares two rows the same way the callback passed to Array.prototype.sort does.

Returns

SortModel<T>

a new SortModel that wraps the current model.

Inherited from

Model.sort

---

unsortedRow()

unsortedRow(sortedRow): number | undefined

Defined in: api/node/typescript/models.ts:799 ↗

Given a sortedRow index into this SortModel, returns the corresponding row index in the source model.

Parameters

sortedRow

number

index in range 0..(rowCount() - 1).

Returns

number | undefined

undefined if sortedRow is out of range otherwise the source row index.