@serenity-is/sleekgrid / IDataView

Interface: IDataView<TItem>

Defined in: src/core/idataview.ts:6

Type Parameters

TItem

TItem = any

Properties

onDataChanged?

readonly optional onDataChanged: EventEmitter<{ }>

Defined in: src/core/idataview.ts:16

Event fired when the underlying data changes

---

onRowCountChanged?

readonly optional onRowCountChanged: EventEmitter<{ current: number; previous: number; }>

Defined in: src/core/idataview.ts:18

Event fired when the row count changes

---

onRowsChanged?

readonly optional onRowsChanged: EventEmitter<{ rows: number[]; }>

Defined in: src/core/idataview.ts:20

Event fired when specific rows change

Methods

getGrandTotals()

getGrandTotals(): IGroupTotals

Defined in: src/core/idataview.ts:8

Gets the grand totals for all aggregated data.

Returns

IGroupTotals

---

getItem()

getItem(row): TItem | IGroupTotals<any> | Group<TItem>

Defined in: src/core/idataview.ts:12

Gets the item at the specified row index.

Parameters

row

number

Returns

TItem | IGroupTotals<any> | Group<TItem>

---

getItemMetadata()?

optional getItemMetadata(row): ItemMetadata<TItem>

Defined in: src/core/idataview.ts:14

Gets metadata for the item at the specified row index.

Parameters

row

number

Returns

ItemMetadata<TItem>

---

getLength()

getLength(): number

Defined in: src/core/idataview.ts:10

Gets the total number of rows in the view.

Returns

number