Interface IColumnEditorCollection

Collection for Column Editors

Hierarchy

IColumnEditorSet
- IColumnEditorCollection

Index

Methods

Methods

deleteColumn

deleteColumn(col: IColumnEditor): void

- Defined in model.column.ts:186
Delete a Column.

Parameters
- col: IColumnEditor
  
  The column to be deleted.
Returns void

deletedColumns

deletedColumns(): IColumnEditor[]

- Defined in model.column.ts:189
Get all the deleted Columns

Returns IColumnEditor[]

filter

filter(filterFunc: function): IColumnEditor[]

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: IColumnEditor, i: number, a: IColumnEditor[]): boolean
    - Parameters
      - v: IColumnEditor
      - i: number
      - a: IColumnEditor[]
      Returns boolean
Returns IColumnEditor[]

getColumnById

getColumnById(columnId: number): IColumnEditor

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

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

getColumnByIndex

getColumnByIndex(index: number): IColumnEditor

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 IColumnEditor

getColumnByOffset

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

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 IColumnEditor

getColumns

getColumns(): IColumnEditor[]

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

Returns IColumnEditor[]

insertColumn

insertColumn(newColumnName: string, prevColumn: IColumnEditor): IColumnEditor

- Defined in model.column.ts:181
Insert a new Column after the given Column.

Parameters
- newColumnName: string
  
  Name for the new Column
- prevColumn: IColumnEditor
  
  The previous Column.
Returns IColumnEditor

insertColumnAtEnd

insertColumnAtEnd(newColumnName: string): IColumnEditor

- Defined in model.column.ts:175
Insert a new column at the end of a collection.

Parameters
- newColumnName: string
  
  Name for the new Column
Returns IColumnEditor

insertColumnAtStart

insertColumnAtStart(newColumnName: string): IColumnEditor

- Defined in model.column.ts:170
Insert a new column at the beginning of a collection.

Parameters
- newColumnName: string
  
  Name for the new Column
Returns IColumnEditor

insertedColumns

insertedColumns(): IColumnEditor[]

- Defined in model.column.ts:191
Get all the inserted Columns

Returns IColumnEditor[]

isModified

isModified(): boolean

Inherited from IColumnEditorSet.isModified
- Defined in model.column.ts:160
Returns true if any items in the Column Collection is modified, false otherwise.

Returns boolean

Generated using TypeDoc