Class ArrayModel<T>

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

Type Parameters

T

Hierarchy (view full)

Model<T>
- ArrayModel

Index

Constructors

Accessors

Methods

[iterator] entries notifyReset notifyRowAdded notifyRowDataChanged notifyRowRemoved pop push remove rowCount rowData setRowData values

Constructors

constructor

new ArrayModel<T>(arr): ArrayModel<T>
Creates a new ArrayModel.
Type Parameters
- T
Parameters
- arr: T[]
Returns ArrayModel<T>
Overrides Model.constructor
- Defined in index.ts:302

Accessors

length

get length(): number
Returns the number of entries in the array model.

Returns number
- Defined in index.ts:310

Methods

[iterator]

[iterator](): Iterator<T, any, undefined>
Returns Iterator<T, any, undefined>
Inherited from Model.[iterator]
- Defined in index.ts:249

entries

entries(): IterableIterator<[number, T]>
Returns an iterable of key, value pairs for every entry in the array.

Returns IterableIterator<[number, T]>
- Defined in index.ts:386

`Protected` notifyReset

notifyReset(): void
Notifies the view that the complete data must be reload.

Returns void
Inherited from Model.notifyReset
- Defined in index.ts:282

`Protected` notifyRowAdded

notifyRowAdded(row, count): void
Notifies the view that multiple rows are added to the model.
Parameters
- row: number
  index of the first added row.
- count: number
  the number of added items.
Returns void
Inherited from Model.notifyRowAdded
- Defined in index.ts:266

`Protected` notifyRowDataChanged

notifyRowDataChanged(row): void
Notifies the view that the data of the current row is changed.
Parameters
- row: number
  index of the changed row.
Returns void
Inherited from Model.notifyRowDataChanged
- Defined in index.ts:257

`Protected` notifyRowRemoved

notifyRowRemoved(row, count): void
Notifies the view that multiple rows are removed to the model.
Parameters
- row: number
  index of the first removed row.
- count: number
  the number of removed items.
Returns void
Inherited from Model.notifyRowRemoved
- Defined in index.ts:275

pop

pop(): T
Removes the last element from the array and returns it.

Returns T
The removed element or undefined if the array is empty.
- Defined in index.ts:356

push

push(...values): void
Pushes new values to the array that's backing the model and notifies the run-time about the added rows.
Parameters
- Rest ...values: T[]
  list of values that will be pushed to the array.
Returns void
- Defined in index.ts:345

remove

remove(index, size): void
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
- Defined in index.ts:371

rowCount

rowCount(): number
Returns the number of entries in the array model.

Returns number
Overrides Model.rowCount
- Defined in index.ts:317

rowData

rowData(row): T
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
- Defined in index.ts:326

setRowData

setRowData(row, data): void
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
- Defined in index.ts:335

values

values(): IterableIterator<T>
Returns an iterable of values in the array.

Returns IterableIterator<T>
- Defined in index.ts:379