Interface IRowDataCollection

Collection class for Row Data objects.

Hierarchy

IRowCollection<IRowData>
- IRowDataCollection

Index

Methods

Methods

filter

filter(filterFunc: function): IRowData[]

Inherited from IRowCollection.filter
- Defined in model.row.ts:84
Filter rows based on given criteria.

Parameters
- filterFunc: function
  
  Row Filter callback
  - - (v: IRowData, i: number, a: IRowData[]): boolean
    - Parameters
      - v: IRowData
      - i: number
      - a: IRowData[]
      Returns boolean
Returns IRowData[]

getCount

getCount(): number

Inherited from IRowCollection.getCount
- Defined in model.row.ts:66
Get count of Rows

Returns number

getRowById

getRowById(rowId: number): IRowData

Inherited from IRowCollection.getRowById
- Defined in model.row.ts:62
Get by Row ID

Parameters
- rowId: number
  
  Row ID
Returns IRowData

getRowByIndex

getRowByIndex(index: number): IRowData

Inherited from IRowCollection.getRowByIndex
- Defined in model.row.ts:72
Fetch a Row by its index in the Collection

Parameters
- index: number
  
  Index in the collection
Returns IRowData

getRowByOffset

getRowByOffset(rowId: number, offset: number): IRowData

Inherited from IRowCollection.getRowByOffset
- Defined in model.row.ts:78
Fetch a Row by position with respect to another Row.

Parameters
- rowId: number
  
  Reference Row ID
- offset: number
  
  Offset with respect to Reference Row
Returns IRowData

getRows

getRows(): IRowData[]

Inherited from IRowCollection.getRows
- Defined in model.row.ts:64
Get all Rows.

Returns IRowData[]

getRowsByTxId

getRowsByTxId(txId: number, includeInactive?: boolean): IRowData[]

- Defined in model.row.ts:95
Fetch Rows based on Transaction ID, and optionally based on Active/ Inactive state.

Parameters
- txId: number
  
  Reference Transaction ID
- Optional includeInactive: boolean
  
  Whether to include Inactive Rows
Returns IRowData[]

Generated using TypeDoc