menu

Interface GridServiceType

Hierarchy

Hierarchy

GridServiceType

Properties

cms

cms: IgxColumnMovingService

crudService

crudService: any

grid

Methods

addRowToData

addRowToData(rowData: any, parentID?: any): void
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:276
Parameters
- rowData: any
- Optional parentID: any
Returns void

`Optional` clear_groupby

clear_groupby(field: any): void
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:299
Parameters
- field: any
Returns void

clear_sort

clear_sort(fieldName: string): void
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:285
Parameters
- fieldName: string
Returns void

deleteRowById

deleteRowById(id: any): any
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:277
Parameters
- id: any
Returns any

`Optional` expand_path_to_record

expand_path_to_record(record: ITreeGridRecord): void
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:295
Parameters
- record: ITreeGridRecord
Returns void

filterDataByExpressions

filterDataByExpressions(expressionsTree: IFilteringExpressionsTree): any[]
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:289
Parameters
- expressionsTree: IFilteringExpressionsTree
Returns any[]

`Optional` getChildGrid

getChildGrid(path: IPathSegment[]): GridType
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:302
Parameters
- path: IPathSegment[]
Returns GridType

`Optional` getChildGrids

getChildGrids(inDepth?: boolean): GridType[]
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:301
Parameters
- Optional inDepth: boolean
Returns GridType[]

`Optional` getParentRowId

getParentRowId(child: GridType): any
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:300
Parameters
- child: GridType
Returns any

getRowData

getRowData(id: any): any
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:263
Parameters
- id: any
Returns any

get_all_data

get_all_data(includeTransactions?: boolean): any[]
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:261
Parameters
- Optional includeTransactions: boolean
Returns any[]

get_cell_by_index

get_cell_by_index(rowIndex: number, columnID: string | number): CellType
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:272
Parameters
- rowIndex: number
- columnID: string | number
Returns CellType

get_cell_by_key

get_cell_by_key(rowSelector: any, field: string): CellType
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:271
Parameters
- rowSelector: any
- field: string
Returns CellType

get_cell_by_visible_index

get_cell_by_visible_index(rowIndex: number, columnIndex: number): any
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:273
Parameters
- rowIndex: number
- columnIndex: number
Returns any

get_column_by_name

get_column_by_name(name: string): ColumnType
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:262
Parameters
- name: string
Returns ColumnType

get_data

get_data(): any[]
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:260
Returns any[]

`Optional` get_groupBy_record_id

get_groupBy_record_id(gRow: IGroupByRecord): string
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:297
Parameters
- gRow: IGroupByRecord
Returns string

get_pin_row_event_args

get_pin_row_event_args(rowID: any, index?: number, row?: RowType, pinned?: boolean): IPinRowEventArgs
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:287
Parameters
- rowID: any
- Optional index: number
- Optional row: RowType
- Optional pinned: boolean
Returns IPinRowEventArgs

get_rec_by_id

get_rec_by_id(id: any): any
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:264
Parameters
- id: any
Returns any

get_rec_id_by_index

get_rec_id_by_index(index: number, dataCollection?: any[]): any
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:269
Parameters
- index: number
- Optional dataCollection: any[]
Returns any

get_rec_index_by_id

get_rec_index_by_id(pk: string | number, dataCollection?: any[]): number
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:268
Parameters
- pk: string | number
- Optional dataCollection: any[]
Returns number

get_row_by_index

get_row_by_index(rowSelector: any): RowType
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:266
Parameters
- rowSelector: any
Returns RowType

get_row_by_key

get_row_by_key(rowSelector: any): RowType
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:267
Parameters
- rowSelector: any
Returns RowType

get_row_expansion_state

get_row_expansion_state(id: any): boolean
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:278
Parameters
- id: any
Returns boolean

get_row_id

get_row_id(rowData: any): any
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:265
Parameters
- rowData: any
Returns any

get_row_index_in_data

get_row_index_in_data(rowID: any, dataCollection?: any[]): number
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:270
Parameters
- rowID: any
- Optional dataCollection: any[]
Returns number

`Optional` get_selected_children

get_selected_children(record: ITreeGridRecord, selectedRowIDs: any[]): void
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:296
Parameters
- record: ITreeGridRecord
- selectedRowIDs: any[]
Returns void

get_summary_data

get_summary_data(): any[]
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:280
Returns any[]

prepare_sorting_expression

prepare_sorting_expression(stateCollections: any[][], expression: ISortingExpression<any>): void
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:282
Parameters
- stateCollections: any[][]
- expression: ISortingExpression<any>
Returns void

`Optional` registerChildRowIsland

registerChildRowIsland(rowIsland: GridType): void
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:305
Parameters
- rowIsland: GridType
Returns void

`Optional` remove_grouping_expression

remove_grouping_expression(fieldName: string): void
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:298
Parameters
- fieldName: string
Returns void

row_deleted_transaction

row_deleted_transaction(id: any): boolean
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:275
Parameters
- id: any
Returns boolean

`Optional` set_grouprow_expansion_state

set_grouprow_expansion_state(groupRow: IGroupByRecord, value: boolean): void
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:274
Parameters
- groupRow: IGroupByRecord
- value: boolean
Returns void

set_row_expansion_state

set_row_expansion_state(id: any, expanded: boolean, event?: Event): void
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:279
Parameters
- id: any
- expanded: boolean
- Optional event: Event
Returns void

sort

sort(expression: ISortingExpression<any>): void
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:283
Parameters
- expression: ISortingExpression<any>
Returns void

sortDataByExpressions

sortDataByExpressions(data: any[], expressions: ISortingExpression<any>[]): any[]
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:290
Parameters
- data: any[]
- expressions: ISortingExpression<any>[]
Returns any[]

sort_multiple

sort_multiple(expressions: ISortingExpression<any>[]): void
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:284
Parameters
- expressions: ISortingExpression<any>[]
Returns void

`Optional` unsetChildRowIsland

unsetChildRowIsland(rowIsland: GridType): void
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:304
Parameters
- rowIsland: GridType
Returns void

update_cell

update_cell(cell: IgxCell): IGridEditEventArgs
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:292
Parameters
- cell: IgxCell
Returns IGridEditEventArgs

update_row

update_row(row: IgxEditRow, value: any, event?: Event): IGridEditEventArgs
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:293
Parameters
- row: IgxEditRow
- value: any
- Optional event: Event
Returns IGridEditEventArgs