menu

Class IgxTreeGridAPIService

Hierarchy

Hierarchy

GridBaseAPIService<GridType>
- IgxTreeGridAPIService

Constructors

Properties

Constructors

constructor

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

Properties

cms

cms: IgxColumnMovingService

crudService

crudService: IgxGridCRUDService

grid

grid: GridType

Methods

addRowToData

addRowToData(data: any, parentRowID?: any): void
Overrides GridBaseAPIService.addRowToData
- Defined in projects/igniteui-angular/src/lib/grids/tree-grid/tree-grid-api.service.ts:186
Parameters
- data: any
- Optional parentRowID: any
Returns void

allow_expansion_state_change

allow_expansion_state_change(rowID: any, expanded: any): boolean
Overrides GridBaseAPIService.allow_expansion_state_change
- Defined in projects/igniteui-angular/src/lib/grids/tree-grid/tree-grid-api.service.ts:41
Parameters
- rowID: any
- expanded: any
Returns boolean

clear_groupby

clear_groupby(_name?: string | string[]): void
Inherited from GridBaseAPIService.clear_groupby
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:281
Parameters
- Optional _name: string | string[]
Returns void

clear_sort

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

deleteRowById

deleteRowById(rowID: any): any
Overrides GridBaseAPIService.deleteRowById
- Defined in projects/igniteui-angular/src/lib/grids/tree-grid/tree-grid-api.service.ts:87
Parameters
- rowID: any
Returns any

deleteRowFromData

deleteRowFromData(rowID: any, index: number): void
Overrides GridBaseAPIService.deleteRowFromData
- Defined in projects/igniteui-angular/src/lib/grids/tree-grid/tree-grid-api.service.ts:108
Parameters
- rowID: any
- index: number
Returns void

expand_path_to_record

expand_path_to_record(record: ITreeGridRecord): void
- Defined in projects/igniteui-angular/src/lib/grids/tree-grid/tree-grid-api.service.ts:52
Parameters
- record: ITreeGridRecord
Returns void

filterDataByExpressions

filterDataByExpressions(expressionsTree: IFilteringExpressionsTree): any[]
Overrides GridBaseAPIService.filterDataByExpressions
- Defined in projects/igniteui-angular/src/lib/grids/tree-grid/tree-grid-api.service.ts:231
Parameters
- expressionsTree: IFilteringExpressionsTree
Returns any[]

filterTreeDataByExpressions

filterTreeDataByExpressions(expressionsTree: IFilteringExpressionsTree): ITreeGridRecord[]
- Defined in projects/igniteui-angular/src/lib/grids/tree-grid/tree-grid-api.service.ts:249
Parameters
- expressionsTree: IFilteringExpressionsTree
Returns ITreeGridRecord[]

get_all_data

get_all_data(transactions?: boolean): any[]
Overrides GridBaseAPIService.get_all_data
- Defined in projects/igniteui-angular/src/lib/grids/tree-grid/tree-grid-api.service.ts:17
Parameters
- Optional transactions: boolean
Returns any[]

get_cell_by_index

get_cell_by_index(rowIndex: number, columnID: string | number): CellType
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
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
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
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[]
Inherited from GridBaseAPIService.get_data
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:288
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:301
Returns any[]

get_pin_row_event_args

get_pin_row_event_args(rowID: any, index?: number, row?: RowType, pinned?: boolean): IPinRowEventArgs
Inherited from GridBaseAPIService.get_pin_row_event_args
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:585
Parameters
- rowID: any
- Optional index: number
- Optional row: RowType
- Optional pinned: boolean
Returns IPinRowEventArgs

get_rec_by_id

get_rec_by_id(rowID: any): ITreeGridRecord
Overrides GridBaseAPIService.get_rec_by_id
- Defined in projects/igniteui-angular/src/lib/grids/tree-grid/tree-grid-api.service.ts:171
Parameters
- rowID: any
Returns ITreeGridRecord

get_rec_id_by_index

get_rec_id_by_index(index: number, dataCollection?: any[]): any
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
Overrides GridBaseAPIService.get_rec_index_by_id
- Defined in projects/igniteui-angular/src/lib/grids/tree-grid/tree-grid-api.service.ts:181
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
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
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: ITreeGridRecord): boolean
Overrides GridBaseAPIService.get_row_expansion_state
- Defined in projects/igniteui-angular/src/lib/grids/tree-grid/tree-grid-api.service.ts:71
Parameters
- record: ITreeGridRecord
Returns boolean

get_row_id

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

get_row_index_in_data

get_row_index_in_data(rowID: any, dataCollection?: any[]): number
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_selected_children

get_selected_children(record: ITreeGridRecord, selectedRowIDs: any[]): void
- Defined in projects/igniteui-angular/src/lib/grids/tree-grid/tree-grid-api.service.ts:154
Parameters
- record: ITreeGridRecord
- selectedRowIDs: any[]
Returns void

get_summary_data

get_summary_data(): any[]
Overrides GridBaseAPIService.get_summary_data
- Defined in projects/igniteui-angular/src/lib/grids/tree-grid/tree-grid-api.service.ts:24
Returns any[]

pin_row

pin_row(rowID: any, index?: number, row?: RowType): void
Inherited from GridBaseAPIService.pin_row
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:555
Parameters
- rowID: any
- Optional index: number
- Optional row: RowType
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:500
Parameters
- stateCollections: any[][]
- expression: IGroupingExpression
Returns void

prepare_sorting_expression

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

remove_grouping_expression

remove_grouping_expression(_fieldName: any): void
Inherited from GridBaseAPIService.remove_grouping_expression
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:537
Parameters
- _fieldName: any
Returns void

row_deleted_transaction

row_deleted_transaction(rowID: any): boolean
Overrides GridBaseAPIService.row_deleted_transaction
- Defined in projects/igniteui-angular/src/lib/grids/tree-grid/tree-grid-api.service.ts:167
Parameters
- rowID: any
Returns boolean

set_row_expansion_state

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

should_apply_number_style

should_apply_number_style(column: ColumnType): boolean
Overrides GridBaseAPIService.should_apply_number_style
- Defined in projects/igniteui-angular/src/lib/grids/tree-grid/tree-grid-api.service.ts:83
Parameters
- column: ColumnType
Returns boolean

sort

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

sortDataByExpressions

sortDataByExpressions(data: ITreeGridRecord[], expressions: ISortingExpression[]): any[]
Overrides GridBaseAPIService.sortDataByExpressions
- Defined in projects/igniteui-angular/src/lib/grids/tree-grid/tree-grid-api.service.ts:240
Parameters
- data: ITreeGridRecord[]
- 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:239
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:261
Parameters
- expressions: ISortingExpression[]
Returns void

sort_multiple

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

unpin_row

unpin_row(rowID: any, row: RowType): void
Inherited from GridBaseAPIService.unpin_row
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:570
Parameters
- rowID: any
- row: RowType
Returns void

update_cell

update_cell(cell: IgxCell): IGridEditEventArgs
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
Inherited from GridBaseAPIService.update_row
- Defined in projects/igniteui-angular/src/lib/grids/api.service.ts:181
Parameters
- row: IgxEditRow
- value: any
- Optional event: Event
Returns IGridEditEventArgs