menu

Class IgxHierarchicalGridAPIService

Hierarchy

GridBaseAPIService<IgxGridBaseComponent & IGridDataBindable>
- IgxHierarchicalGridAPIService

Properties

grid

Methods

Properties

grid

grid: IgxGridBaseComponent & IGridDataBindable

Methods

_update_row

_update_row(row: IgxRow, value?: any): void

Inherited from GridBaseAPIService._update_row
- Defined in lib/grids/api.service.ts:191
Parameters
- row: IgxRow
- Optional value: any
Returns void

addRowToData

addRowToData(rowData: any): void

Inherited from GridBaseAPIService.addRowToData
- Defined in lib/grids/api.service.ts:455
Parameters
- rowData: any
Returns void

atInexistingPage

atInexistingPage(): Boolean

Inherited from GridBaseAPIService.atInexistingPage
- Defined in lib/grids/api.service.ts:550
Returns Boolean

clear_filter

clear_filter(fieldName: string): void

Inherited from GridBaseAPIService.clear_filter
- Defined in lib/grids/api.service.ts:330
Parameters
- fieldName: string
Returns void

clear_sort

clear_sort(fieldName: string): void

Inherited from GridBaseAPIService.clear_sort
- Defined in lib/grids/api.service.ts:352
Parameters
- fieldName: string
Returns void

deleteRowById

deleteRowById(rowId: any): void

Inherited from GridBaseAPIService.deleteRowById
- Defined in lib/grids/api.service.ts:485
Parameters
- rowId: any
Returns void

deleteRowFromData

deleteRowFromData(rowID: any, index: number): void

Inherited from GridBaseAPIService.deleteRowFromData
- Defined in lib/grids/api.service.ts:468
Parameters
- rowID: any
- index: number
Returns void

escape_editMode

escape_editMode(): void

Inherited from GridBaseAPIService.escape_editMode
- Defined in lib/grids/api.service.ts:66
Returns void

filter

filter(fieldName: string, term: any, conditionOrExpressionsTree: IFilteringOperation | IFilteringExpressionsTree, ignoreCase: boolean): void

Inherited from GridBaseAPIService.filter
- Defined in lib/grids/api.service.ts:290
Parameters
- fieldName: string
- term: any
- conditionOrExpressionsTree: IFilteringOperation | IFilteringExpressionsTree
- ignoreCase: boolean
Returns void

filter_global

filter_global(term: any, condition: any, ignoreCase: any): void

Inherited from GridBaseAPIService.filter_global
- Defined in lib/grids/api.service.ts:309
Parameters
- term: any
- condition: any
- ignoreCase: any
Returns void

getChildGrid

getChildGrid(path: Array<IPathSegment>): any

- Defined in lib/grids/hierarchical-grid/hierarchical-grid-api.service.ts:26
Parameters
- path: Array<IPathSegment>
Returns any

getChildGridByID

getChildGridByID(rowIslandKey: any, rowID: any): IgxHierarchicalGridComponent

- Defined in lib/grids/hierarchical-grid/hierarchical-grid-api.service.ts:92
Parameters
- rowIslandKey: any
- rowID: any
Returns IgxHierarchicalGridComponent

getChildGrids

getChildGrids(inDepth?: boolean): any[]

- Defined in lib/grids/hierarchical-grid/hierarchical-grid-api.service.ts:42
Parameters
- Optional inDepth: boolean
Returns any[]

getChildGridsForRowIsland

getChildGridsForRowIsland(rowIslandKey: any): IgxHierarchicalGridComponent[]

- Defined in lib/grids/hierarchical-grid/hierarchical-grid-api.service.ts:81
Parameters
- rowIslandKey: any
Returns IgxHierarchicalGridComponent[]

getChildRowIsland

getChildRowIsland(key: string): IgxRowIslandComponent

- Defined in lib/grids/hierarchical-grid/hierarchical-grid-api.service.ts:22
Parameters
- key: string
Returns IgxRowIslandComponent

getParentRowId

getParentRowId(childGrid: IgxHierarchicalGridComponent): any

- Defined in lib/grids/hierarchical-grid/hierarchical-grid-api.service.ts:59
Parameters
- childGrid: IgxHierarchicalGridComponent
Returns any

get_all_data

get_all_data(includeTransactions?: boolean): any[]

Inherited from GridBaseAPIService.get_all_data
- Defined in lib/grids/api.service.ts:439
Parameters
- Default value includeTransactions: boolean = false
Returns any[]

get_cell_by_index

get_cell_by_index(rowIndex: number, columnIndex: number): IgxGridCellComponent

Inherited from GridBaseAPIService.get_cell_by_index
- Defined in lib/grids/api.service.ts:104
Parameters
- rowIndex: number
- columnIndex: number
Returns IgxGridCellComponent

get_cell_by_key

get_cell_by_key(rowSelector: any, field: string): IgxGridCellComponent

Inherited from GridBaseAPIService.get_cell_by_key
- Defined in lib/grids/api.service.ts:97
Parameters
- rowSelector: any
- field: string
Returns IgxGridCellComponent

get_cell_by_visible_index

get_cell_by_visible_index(rowIndex: number, columnIndex: number): IgxGridCellComponent

Inherited from GridBaseAPIService.get_cell_by_visible_index
- Defined in lib/grids/api.service.ts:111
Parameters
- rowIndex: number
- columnIndex: number
Returns IgxGridCellComponent

get_cell_inEditMode

get_cell_inEditMode(): IgxCell

Inherited from GridBaseAPIService.get_cell_inEditMode
- Defined in lib/grids/api.service.ts:71
Returns IgxCell

get_column_by_name

get_column_by_name(name: string): IgxColumnComponent

Inherited from GridBaseAPIService.get_column_by_name
- Defined in lib/grids/api.service.ts:26
Parameters
- name: string
Returns IgxColumnComponent

get_data

get_data(): any[]

Inherited from GridBaseAPIService.get_data
- Defined in lib/grids/api.service.ts:433
Returns any[]

get_filtered_data

get_filtered_data(): any[]

Inherited from GridBaseAPIService.get_filtered_data
- Defined in lib/grids/api.service.ts:446
Returns any[]

get_row_by_index

get_row_by_index(rowIndex: number): IgxRowComponent<IgxGridBaseComponent & IGridDataBindable>

Inherited from GridBaseAPIService.get_row_by_index
- Defined in lib/grids/api.service.ts:93
Parameters
- rowIndex: number
Returns IgxRowComponent<IgxGridBaseComponent & IGridDataBindable>

get_row_by_key

get_row_by_key(rowSelector: any): IgxRowComponent<IgxGridBaseComponent & IGridDataBindable>

Inherited from GridBaseAPIService.get_row_by_key
- Defined in lib/grids/api.service.ts:84
Parameters
- rowSelector: any
Returns IgxRowComponent<IgxGridBaseComponent & IGridDataBindable>

get_row_id

get_row_id(rowData: any): any

Inherited from GridBaseAPIService.get_row_id
- Defined in lib/grids/api.service.ts:529
Parameters
- rowData: any
Returns any

get_row_index_in_data

get_row_index_in_data(rowID: any): number

Inherited from GridBaseAPIService.get_row_index_in_data
- Defined in lib/grids/api.service.ts:75
Parameters
- rowID: any
Returns number

get_summary_data

get_summary_data(): any[]

Inherited from GridBaseAPIService.get_summary_data
- Defined in lib/grids/api.service.ts:30
Returns any[]

registerChildGrid

registerChildGrid(parentRowID: string | object, rowIslandKey: string, grid: IgxHierarchicalGridComponent): void

- Defined in lib/grids/hierarchical-grid/hierarchical-grid-api.service.ts:72
Parameters
- parentRowID: string | object
- rowIslandKey: string
- grid: IgxHierarchicalGridComponent
Returns void

registerChildRowIsland

registerChildRowIsland(rowIsland: IgxRowIslandComponent): void

- Defined in lib/grids/hierarchical-grid/hierarchical-grid-api.service.ts:11
Parameters
- rowIsland: IgxRowIslandComponent
Returns void

row_deleted_transaction

row_deleted_transaction(rowID: any): boolean

Inherited from GridBaseAPIService.row_deleted_transaction
- Defined in lib/grids/api.service.ts:534
Parameters
- rowID: any
Returns boolean

should_apply_number_style

should_apply_number_style(column: IgxColumnComponent): boolean

Inherited from GridBaseAPIService.should_apply_number_style
- Defined in lib/grids/api.service.ts:429
Parameters
- column: IgxColumnComponent
Returns boolean

sort

sort(expression: ISortingExpression): void

Inherited from GridBaseAPIService.sort
- Defined in lib/grids/api.service.ts:268
Parameters
- expression: ISortingExpression
Returns void

sort_multiple

sort_multiple(expressions: ISortingExpression[]): void

Inherited from GridBaseAPIService.sort_multiple
- Defined in lib/grids/api.service.ts:277
Parameters
- expressions: ISortingExpression[]
Returns void

submit_value

submit_value(): void

Inherited from GridBaseAPIService.submit_value
- Defined in lib/grids/api.service.ts:118
Returns void

unsetChildRowIsland

unsetChildRowIsland(rowIsland: IgxRowIslandComponent): void

- Defined in lib/grids/hierarchical-grid/hierarchical-grid-api.service.ts:16
Parameters
- rowIsland: IgxRowIslandComponent
Returns void

update_cell

update_cell(cell: IgxCell, value: any): IGridEditEventArgs

Inherited from GridBaseAPIService.update_cell
- Defined in lib/grids/api.service.ts:129
Parameters
- cell: IgxCell
- value: any
Returns IGridEditEventArgs

update_row

update_row(row: IgxRow, value: any): IGridEditEventArgs

Inherited from GridBaseAPIService.update_row
- Defined in lib/grids/api.service.ts:208
Parameters
- row: IgxRow
- value: any
Returns IGridEditEventArgs