menu

Class IgxGridAPIService

Hierarchy

Hierarchy

GridBaseAPIService<GridType>
- IgxGridAPIService

Implements

GridServiceType

Constructors

Properties

Methods

Constructors

constructor

new IgxGridAPIService(crudService: IgxGridCRUDService, cms: IgxColumnMovingService): IgxGridAPIService
Inherited from GridBaseAPIService<GridType>.constructor
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:25
Parameters
- crudService: IgxGridCRUDService
- cms: IgxColumnMovingService
Returns IgxGridAPIService

Properties

cms

cms: IgxColumnMovingService

crudService

crudService: IgxGridCRUDService

grid

grid: GridType

Methods

addRowToData

addRowToData(rowData: any, _parentID?: any): void
Implementation of GridServiceType.addRowToData

Inherited from GridBaseAPIService.addRowToData
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:296
Parameters
- rowData: any
- Optional _parentID: any
Returns void

allow_expansion_state_change

allow_expansion_state_change(rowID: any, expanded: any): boolean
Inherited from GridBaseAPIService.allow_expansion_state_change
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:449
Parameters
- rowID: any
- expanded: any
Returns boolean

arrange_sorting_expressions

arrange_sorting_expressions(): void
- Defined in projects/igniteui-angular/src/lib/grids/grid/grid-api.service.ts:123
Returns void

clear_groupby

clear_groupby(name?: string | string[]): void
Implementation of GridServiceType.clear_groupby

Overrides GridBaseAPIService.clear_groupby
- Defined in projects/igniteui-angular/src/lib/grids/grid/grid-api.service.ts:31
Parameters
- Optional name: string | string[]
Returns void

clear_sort

clear_sort(fieldName: string): void
Implementation of GridServiceType.clear_sort

Inherited from GridBaseAPIService.clear_sort
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:263
Parameters
- fieldName: string
Returns void

deleteRowById

deleteRowById(rowId: any): any
Implementation of GridServiceType.deleteRowById

Inherited from GridBaseAPIService.deleteRowById
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:329
Parameters
- rowId: any
Returns any

deleteRowFromData

deleteRowFromData(rowID: any, index: number): void
Inherited from GridBaseAPIService.deleteRowFromData
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:311
Parameters
- rowID: any
- index: number
Returns void

filterDataByExpressions

filterDataByExpressions(expressionsTree: IFilteringExpressionsTree): any[]
Implementation of GridServiceType.filterDataByExpressions

Inherited from GridBaseAPIService.filterDataByExpressions
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:530
Parameters
- expressionsTree: IFilteringExpressionsTree
Returns any[]

get_all_data

get_all_data(includeTransactions?: boolean): any[]
Implementation of GridServiceType.get_all_data

Inherited from GridBaseAPIService.get_all_data
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:285
Parameters
- includeTransactions: boolean = false
Returns any[]

get_cell_by_index

get_cell_by_index(rowIndex: number, columnID: string | number): CellType
Implementation of GridServiceType.get_cell_by_index

Inherited from GridBaseAPIService.get_cell_by_index
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:121
Parameters
- rowIndex: number
- columnID: string | number
Returns CellType

get_cell_by_key

get_cell_by_key(rowSelector: any, field: string): CellType
Implementation of GridServiceType.get_cell_by_key

Inherited from GridBaseAPIService.get_cell_by_key
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:114
Parameters
- rowSelector: any
- field: string
Returns CellType

get_cell_by_visible_index

get_cell_by_visible_index(rowIndex: number, columnIndex: number): CellType
Implementation of GridServiceType.get_cell_by_visible_index

Inherited from GridBaseAPIService.get_cell_by_visible_index
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:133
Parameters
- rowIndex: number
- columnIndex: number
Returns CellType

get_column_by_name

get_column_by_name(name: string): ColumnType
Implementation of GridServiceType.get_column_by_name

Inherited from GridBaseAPIService.get_column_by_name
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:30
Parameters
- name: string
Returns ColumnType

get_data

get_data(): any[]
Implementation of GridServiceType.get_data

Inherited from GridBaseAPIService.get_data
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:279
Returns any[]

get_filtered_data

get_filtered_data(): any[]
Inherited from GridBaseAPIService.get_filtered_data
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:292
Returns any[]

get_groupBy_record_id

get_groupBy_record_id(gRow: IGroupByRecord): string
Implementation of GridServiceType.get_groupBy_record_id
- Defined in projects/igniteui-angular/src/lib/grids/grid/grid-api.service.ts:135
Parameters
- gRow: IGroupByRecord
Returns string

get_rec_by_id

get_rec_by_id(rowID: any): any
Implementation of GridServiceType.get_rec_by_id

Inherited from GridBaseAPIService.get_rec_by_id
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:434
Parameters
- rowID: any
Returns any

get_rec_id_by_index

get_rec_id_by_index(index: number, dataCollection?: any[]): any
Implementation of GridServiceType.get_rec_id_by_index

Inherited from GridBaseAPIService.get_rec_id_by_index
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:105
Gets the rowID of the record at the specified data view index

Parameters
- index: number
- Optional dataCollection: any[]
Returns any

get_rec_index_by_id

get_rec_index_by_id(pk: string | number, dataCollection?: any[]): number
Implementation of GridServiceType.get_rec_index_by_id

Inherited from GridBaseAPIService.get_rec_index_by_id
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:444
Returns the index of the record in the data view by pk or -1 if not found or primaryKey is not set.

Parameters
- pk: string | number
- Optional dataCollection: any[]
Returns number

get_row_by_index

get_row_by_index(rowIndex: number): RowType
Implementation of GridServiceType.get_row_by_index

Inherited from GridBaseAPIService.get_row_by_index
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:95
Parameters
- rowIndex: number
Returns RowType

get_row_by_key

get_row_by_key(rowSelector: any): RowType
Implementation of GridServiceType.get_row_by_key

Inherited from GridBaseAPIService.get_row_by_key
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:83
Parameters
- rowSelector: any
Returns RowType

get_row_expansion_state

get_row_expansion_state(record: any): boolean
Implementation of GridServiceType.get_row_expansion_state

Inherited from GridBaseAPIService.get_row_expansion_state
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:395
Parameters
- record: any
Returns boolean

get_row_id

get_row_id(rowData: any): any
Implementation of GridServiceType.get_row_id

Inherited from GridBaseAPIService.get_row_id
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:375
Parameters
- rowData: any
Returns any

get_row_index_in_data

get_row_index_in_data(rowID: any, dataCollection?: any[]): number
Implementation of GridServiceType.get_row_index_in_data

Inherited from GridBaseAPIService.get_row_index_in_data
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:73
Parameters
- rowID: any
- Optional dataCollection: any[]
Returns number

get_summary_data

get_summary_data(): any[]
Implementation of GridServiceType.get_summary_data

Inherited from GridBaseAPIService.get_summary_data
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:34
Returns any[]

groupBy

groupBy(expression: IGroupingExpression): void
- Defined in projects/igniteui-angular/src/lib/grids/grid/grid-api.service.ts:13
Parameters
- expression: IGroupingExpression
Returns void

groupBy_deselect_all_rows_in_group

groupBy_deselect_all_rows_in_group(groupRow: IGroupByRecord): void
- Defined in projects/igniteui-angular/src/lib/grids/grid/grid-api.service.ts:118
Parameters
- groupRow: IGroupByRecord
Returns void

groupBy_fully_expand_group

groupBy_fully_expand_group(groupRow: IGroupByRecord): void
- Defined in projects/igniteui-angular/src/lib/grids/grid/grid-api.service.ts:102
Parameters
- groupRow: IGroupByRecord
Returns void

groupBy_get_expanded_for_group

groupBy_get_expanded_for_group(groupRow: IGroupByRecord): IGroupByExpandState
- Defined in projects/igniteui-angular/src/lib/grids/grid/grid-api.service.ts:57
Parameters
- groupRow: IGroupByRecord
Returns IGroupByExpandState

groupBy_is_row_in_group

groupBy_is_row_in_group(groupRow: IGroupByRecord, rowID: any): boolean
- Defined in projects/igniteui-angular/src/lib/grids/grid/grid-api.service.ts:64
Parameters
- groupRow: IGroupByRecord
- rowID: any
Returns boolean

groupBy_multiple

groupBy_multiple(expressions: IGroupingExpression[]): void
- Defined in projects/igniteui-angular/src/lib/grids/grid/grid-api.service.ts:20
Parameters
- expressions: IGroupingExpression[]
Returns void

groupBy_select_all_rows_in_group

groupBy_select_all_rows_in_group(groupRow: IGroupByRecord, clearPrevSelection: boolean): void
- Defined in projects/igniteui-angular/src/lib/grids/grid/grid-api.service.ts:113
Parameters
- groupRow: IGroupByRecord
- clearPrevSelection: boolean
Returns void

groupBy_toggle_group

groupBy_toggle_group(groupRow: IGroupByRecord): void
- Defined in projects/igniteui-angular/src/lib/grids/grid/grid-api.service.ts:75
Parameters
- groupRow: IGroupByRecord
Returns void

prepare_grouping_expression

prepare_grouping_expression(stateCollections: any[][], expression: IGroupingExpression): void
Inherited from GridBaseAPIService.prepare_grouping_expression
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:490
Parameters
- stateCollections: any[][]
- expression: IGroupingExpression
Returns void

prepare_sorting_expression

prepare_sorting_expression(stateCollections: any[][], expression: ISortingExpression): void
Implementation of GridServiceType.prepare_sorting_expression

Inherited from GridBaseAPIService.prepare_sorting_expression
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:453
Parameters
- stateCollections: any[][]
- expression: ISortingExpression
Returns void

remove_grouping_expression

remove_grouping_expression(fieldName: string): void
Implementation of GridServiceType.remove_grouping_expression

Overrides GridBaseAPIService.remove_grouping_expression
- Defined in projects/igniteui-angular/src/lib/grids/grid/grid-api.service.ts:152
Parameters
- fieldName: string
Returns void

row_deleted_transaction

row_deleted_transaction(rowID: any): boolean
Implementation of GridServiceType.row_deleted_transaction

Inherited from GridBaseAPIService.row_deleted_transaction
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:379
Parameters
- rowID: any
Returns boolean

set_grouprow_expansion_state

set_grouprow_expansion_state(groupRow: IGroupByRecord, value: boolean): void
Implementation of GridServiceType.set_grouprow_expansion_state
- Defined in projects/igniteui-angular/src/lib/grids/grid/grid-api.service.ts:96
Parameters
- groupRow: IGroupByRecord
- value: boolean
Returns void

set_row_expansion_state

set_row_expansion_state(rowID: any, expanded: boolean, event?: Event): void
Implementation of GridServiceType.set_row_expansion_state

Inherited from GridBaseAPIService.set_row_expansion_state
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:408
Parameters
- rowID: any
- expanded: boolean
- Optional event: Event
Returns void

should_apply_number_style

should_apply_number_style(column: ColumnType): boolean
Inherited from GridBaseAPIService.should_apply_number_style
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:275
Parameters
- column: ColumnType
Returns boolean

sort

sort(expression: ISortingExpression): void
Implementation of GridServiceType.sort

Inherited from GridBaseAPIService.sort
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:221
Parameters
- expression: ISortingExpression
Returns void

sortDataByExpressions

sortDataByExpressions(data: any[], expressions: ISortingExpression[]): any[]
Implementation of GridServiceType.sortDataByExpressions

Inherited from GridBaseAPIService.sortDataByExpressions
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:541
Parameters
- data: any[]
- expressions: ISortingExpression[]
Returns any[]

sort_decoupled

sort_decoupled(expression: IGroupingExpression): void
Inherited from GridBaseAPIService.sort_decoupled
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:230
Parameters
- expression: IGroupingExpression
Returns void

sort_groupBy_multiple

sort_groupBy_multiple(expressions: ISortingExpression[]): void
Inherited from GridBaseAPIService.sort_groupBy_multiple
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:252
Parameters
- expressions: ISortingExpression[]
Returns void

sort_multiple

sort_multiple(expressions: ISortingExpression[]): void
Implementation of GridServiceType.sort_multiple

Inherited from GridBaseAPIService.sort_multiple
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:239
Parameters
- expressions: ISortingExpression[]
Returns void

update_cell

update_cell(cell: IgxCell): IGridEditEventArgs
Implementation of GridServiceType.update_cell

Inherited from GridBaseAPIService.update_cell
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:140
Parameters
- cell: IgxCell
Returns IGridEditEventArgs

update_row

update_row(row: IgxEditRow, value: any, event?: Event): IGridEditEventArgs
Implementation of GridServiceType.update_row

Inherited from GridBaseAPIService.update_row
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:172
Parameters
- row: IgxEditRow
- value: any
- Optional event: Event
Returns IGridEditEventArgs