Interface IColumnDataCollection

Column Collection for readonly IColumnData objects.

Hierarchy

IColumnCollection<IColumnData>
- IColumnDataCollection

Index

Methods

Methods

filter

filter(filterFunc: function): IColumnData[]

Inherited from IColumnCollection.filter
- Defined in model.column.ts:139
Filter from the Column Collection based on criteria.

Parameters
- filterFunc: function
  
  Callback with filter criteria.
  - - (v: IColumnData, i: number, a: IColumnData[]): boolean
    - Parameters
      - v: IColumnData
      - i: number
      - a: IColumnData[]
      Returns boolean
Returns IColumnData[]

getColumnById

getColumnById(columnId: number): IColumnData

Inherited from IColumnCollection.getColumnById
- Defined in model.column.ts:121
Gets a Column by ID.

Parameters
- columnId: number
  
  Column ID to fetch.
Returns IColumnData

getColumnByIndex

getColumnByIndex(index: number): IColumnData

Inherited from IColumnCollection.getColumnByIndex
- Defined in model.column.ts:128
Get a Column by its index in the collection.

Parameters
- index: number
  
  Index of the Column being searched.
Returns IColumnData

getColumnByOffset

getColumnByOffset(columnId: number, offset: number): IColumnData

Inherited from IColumnCollection.getColumnByOffset
- Defined in model.column.ts:134
Get a Column based on an offset with respect to another column in the collection.

Parameters
- columnId: number
  
  Reference Column
- offset: number
  
  Offset with respect to the Reference Column
Returns IColumnData

getColumns

getColumns(): IColumnData[]

Inherited from IColumnCollection.getColumns
- Defined in model.column.ts:123
Gets all Columns

Returns IColumnData[]

getColumnsByTxId

getColumnsByTxId(txId: number, includeInactive?: boolean): IColumnData[]

- Defined in model.column.ts:150
Get Columns in a collection with respect to a Transaction ID and Active/ Inactive state.

Parameters
- txId: number
  
  Transaction ID with respect to which Columns are fetched.
- Optional includeInactive: boolean
  
  Whether inactive columns should be included.
Returns IColumnData[]

Generated using TypeDoc