ArrayModel

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

ArrayModel wraps a JavaScript array for use in .slint views. The underlying array can be modified with the [[ArrayModel.push]], [[ArrayModel.remove]], and [[ArrayModel.splice]] methods.

Extends

Model<T>

Type Parameters

T

T

Constructors

Constructor

new ArrayModel<T>(arr): ArrayModel<T>

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

Creates a new ArrayModel.

Parameters

arr

T[]

Returns

ArrayModel<T>

Overrides

Model<T>.constructor

Accessors

length

Get Signature

get length(): number

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

Returns the number of entries in the array model.

Returns

number

Methods

[iterator]()

[iterator](): Iterator<T>

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

Returns

Iterator<T>

Inherited from

Model.[iterator]

entries()

entries(): IterableIterator<[number, T]>

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

Returns an iterable of key, value pairs for every entry in the array.

Returns

IterableIterator<[number, T]>

filter()

filter(filterFunction): FilterModel<T>

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

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:354 ↗

Insert a new row into the array backing the model at the specified index and notifies run-time about the added row.

Parameters

_index

number

index at which to insert the new row.

_data

T

data item to store in the new row.

Returns

void

Overrides

Model.insertRow

map()

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

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

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

pop()

pop(): T | undefined

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

Removes the last element from the array and returns it.

Returns

T | undefined

The removed element or undefined if the array is empty.

push()

push(…values): void

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

Pushes new values to the array that’s backing the model and notifies the run-time about the added rows.

Parameters

values

…T[]

list of values that will be pushed to the array.

Returns

void

pushRow()

pushRow(data): void

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

Add a new row to the array backing the model and notifies run-time about the added row.

Parameters

data

T

new data item to store in a new row.

Returns

void

Overrides

Model.pushRow

remove()

remove(index, size): void

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

Removes the specified number of element from the array that’s backing the model, starting at the specified index.

Parameters

index

number

index of first row to remove.

size

number

number of rows to remove.

Returns

void

removeRow()

removeRow(_index): void

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

Remove a row from the array backing the model and notifies run-time about the removed row.

Parameters

_index

number

index of the row to remove.

Returns

void

Overrides

Model.removeRow

reverse()

reverse(): ReverseModel<T>

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

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:305 ↗

Returns the number of entries in the array model.

Returns

number

Overrides

Model.rowCount

rowData()

rowData(row): T

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

Returns the data at the specified row.

Parameters

row

number

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

Returns

T

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:323 ↗

Stores the given data on the given row index and notifies run-time about the changed row.

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:165 ↗

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

splice()

splice(start, deleteCount?, …items): T[]

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

Removes elements from the array that’s backing the model and, if necessary, inserts new elements in their place, following the semantics of Array.prototype.splice. The run-time is notified about the removed and added rows.

Parameters

start

number

zero-based index at which to start changing the array; negative values count back from the end and out-of-range values are clamped.

deleteCount?

number

number of elements to remove starting at start; if omitted, all elements from start to the end are removed.

items

…T[]

elements to insert at start.

Returns

T[]

an array containing the removed elements.

values()

values(): IterableIterator<T>

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

Returns an iterable of values in the array.

Returns

IterableIterator<T>