Model

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

Model is the interface for feeding dynamic data into .slint views.

A model is organized like a table with rows of data. The fields of the data type T behave like columns.

Extended by

Type Parameters

T

T

the type of the model’s items.

Example

As an example let’s see the implementation of ArrayModel

export class ArrayModel<T> extends Model<T> {
   private a: Array<T>

  constructor(arr: Array<T>) {
       super();
       this.a = arr;
   }

   rowCount() {
       return this.a.length;
   }

   rowData(row: number) {
      return this.a[row];
   }

   setRowData(row: number, data: T) {
       this.a[row] = data;
       this.notifyRowDataChanged(row);
   }

   push(...values: T[]) {
       let size = this.a.length;
       Array.prototype.push.apply(this.a, values);
       this.notifyRowAdded(size, arguments.length);
   }

   remove(index: number, size: number) {
       let r = this.a.splice(index, size);
       this.notifyRowRemoved(index, size);
   }

   get length(): number {
       return this.a.length;
   }

   values(): IterableIterator<T> {
       return this.a.values();
   }

   entries(): IterableIterator<[number, T]> {
       return this.a.entries()
   }
}

Implements

Iterable<T>

Methods

[iterator]()

[iterator](): Iterator<T>

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

Returns

Iterator<T>

Implementation of

Iterable.[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.

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

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.

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

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

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.

rowCount()

abstract rowCount(): number

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

Implementations of this function must return the current number of rows.

Returns

number

rowData()

abstract rowData(row): T | undefined

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

Implementations of this function must return 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.

setRowData()

setRowData(_row, _data): void

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

Implementations of this function must store the provided data parameter in the model at the specified row.

Parameters

_row

number

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

_data

T

new data item to store on the given row index

Returns

void

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.