cms

crudService

grid

addRowToData

• addRowToData(rowData, parentID?): void

• Represents a method declaration for adding a new row to the grid. It takes the row's data and the identifier of the parent row if applicable (used for tree grids)

  Parameters

  • rowData: any

  • Optional parentID: any

  Returns void

Optional clear_groupby

• clear_groupby(field): void

• Parameters

  • field: any

  Returns void

clear_sort

• clear_sort(fieldName): void

• Represents a method declaration for reseting the sorting

  Parameters

  • fieldName: string

  Returns void

deleteRowById

• deleteRowById(id): any

• Represents a method declaration for deleting a row, specified by it's identidier (taken as a parameter)

  Parameters

  • id: any

  Returns any

Optional expand_path_to_record

• expand_path_to_record(record): void

• Parameters

  • record: ITreeGridRecord

  Returns void

filterDataByExpressions

• filterDataByExpressions(expressionsTree): any[]

• Parameters

  • expressionsTree: IFilteringExpressionsTree

  Returns any[]

Optional getChildGrid

• getChildGrid(path): GridType

• Parameters

  • path: IPathSegment[]

  Returns GridType

Optional getChildGrids

• getChildGrids(inDepth?): GridType[]

• Parameters

  • Optional inDepth: boolean

  Returns GridType[]

Optional getParentRowId

• getParentRowId(child): any

• Parameters

  • child: GridType

  Returns any

getRowData

• getRowData(id): any

• Represents a method declaration for retrieving the data associated with a specific row by its unique identifier (of any type, taken as a parameter).

  Parameters

  • id: any

  Returns any

get_all_data

• get_all_data(includeTransactions?): any[]

• Represents a method declaration for retrieving all the data available in the grid, including any transactional data. includeTransactions: Optional parameter. Specifies whether to include transactional data if present. Returns an array containing all the data available in the grid.

  Parameters

  • Optional includeTransactions: boolean

  Returns any[]

get_cell_by_index

• get_cell_by_index(rowIndex, columnID): CellType

• Represents a method declaration for retrieving the cell object associated with a specific row and column using their indexes.

  Parameters

  • rowIndex: number

  • columnID: string | number

  Returns CellType

get_cell_by_key

• get_cell_by_key(rowSelector, field): CellType

• Represents a method declaration for retrieving the cell object associated with a specific row and column in the grid.

  Parameters

  • rowSelector: any

  • field: string

  Returns CellType

get_cell_by_visible_index

• get_cell_by_visible_index(rowIndex, columnIndex): any

• Represents a method declaration for retrieving the cell object associated with a specific row and column using their indexes. It counts only the indexes of the visible columns and rows

  Parameters

  • rowIndex: number

  • columnIndex: number

  Returns any

get_column_by_name

• get_column_by_name(name): ColumnType

• Represents a method declaration for retrieving a column object by its name, taken as a parameter.

  Parameters

  • name: string

  Returns ColumnType

get_data

• get_data(): any[]

• Represents a method declaration for retrieving the data used in the grid. The returned values could be of any type

  Returns any[]

Optional get_groupBy_record_id

• get_groupBy_record_id(gRow): string

• Parameters

  • gRow: IGroupByRecord

  Returns string

get_pin_row_event_args

• get_pin_row_event_args(rowID, index?, row?, pinned?): IPinRowEventArgs

• Represents an event, triggered when the pin state is changed

  Parameters

  • rowID: any

  • Optional index: number

  • Optional row: RowType

  • Optional pinned: boolean

  Returns IPinRowEventArgs

get_rec_by_id

• get_rec_by_id(id): any

• Represents a method declaration for retrieving the data associated with a specific record by its unique identifier (of any type, taken as a parameter).

  Parameters

  • id: any

  Returns any

get_rec_id_by_index

• get_rec_id_by_index(index, dataCollection?): any

• Represents a method declaration for retrieving the index of a record in the grid's data collection using its index.

  Parameters

  • index: number

  • Optional dataCollection: any[]

  Returns any

get_rec_index_by_id

• get_rec_index_by_id(pk, dataCollection?): number

• Represents a method declaration for retrieving the index of a record in the grid's data collection using its unique identifier.

  Parameters

  • pk: string | number

  • Optional dataCollection: any[]

  Returns number

get_row_by_index

• get_row_by_index(rowSelector): RowType

• Represents a method declaration for retrieving the row object associated with a specific index (taken as a parameter) in the grid

  Parameters

  • rowSelector: any

  Returns RowType

get_row_by_key

• get_row_by_key(rowSelector): RowType

• Represents a method declaration for retrieving the row object associated with a specific key (taken as a parameter) in the grid

  Parameters

  • rowSelector: any

  Returns RowType

get_row_expansion_state

• get_row_expansion_state(id): boolean

• Represents a method declaration for retrieving the row's current state of expantion (used for tree grids)

  Parameters

  • id: any

  Returns boolean

get_row_id

• get_row_id(rowData): any

• Represents a method declaration for retrieving the unique identifier of a specific row by its data.

  Parameters

  • rowData: any

  Returns any

get_row_index_in_data

• get_row_index_in_data(rowID, dataCollection?): number

• Parameters

  • rowID: any

  • Optional dataCollection: any[]

  Returns number

Optional get_selected_children

• get_selected_children(record, selectedRowIDs): void

• Parameters

  • record: ITreeGridRecord

  • selectedRowIDs: any[]

  Returns void

get_summary_data

• get_summary_data(): any[]

• Returns any[]

prepare_sorting_expression

• prepare_sorting_expression(stateCollections, expression): void

• Parameters

  • stateCollections: any[][]

  • expression: ISortingExpression<any>

  Returns void

Optional registerChildRowIsland

• registerChildRowIsland(rowIsland): void

• Parameters

  • rowIsland: GridType

  Returns void

Optional remove_grouping_expression

• remove_grouping_expression(fieldName): void

• Parameters

  • fieldName: string

  Returns void

row_deleted_transaction

• row_deleted_transaction(id): boolean

• Parameters

  • id: any

  Returns boolean

Optional set_grouprow_expansion_state

• set_grouprow_expansion_state(groupRow, value): void

• Represents a method declaration that sets the expansion state of a group row (used for tree grids) It takes the value for the expantion as a parameter (expanded or collapsed)

  Parameters

  • groupRow: IGroupByRecord

  • value: boolean

  Returns void

set_row_expansion_state

• set_row_expansion_state(id, expanded, event?): void

• Represents a method declaration for setting a new expantion state. It can be triggered by an event

  Parameters

  • id: any

  • expanded: boolean

  • Optional event: Event

  Returns void

sort

• sort(expression): void

• Represents a method declaration for sorting by only one expression The expression contains fieldName, sorting directory, whether case should be ignored and optional sorting strategy

  Parameters

  • expression: ISortingExpression<any>

  Returns void

sortDataByExpressions

• sortDataByExpressions(data, expressions): any[]

• Parameters

  • data: any[]

  • expressions: ISortingExpression<any>[]

  Returns any[]

sort_multiple

• sort_multiple(expressions): void

• Represents a method declaration for sorting by multiple expressions The expressions contains fieldName, sorting directory, whether case should be ignored and optional sorting strategy

  Parameters

  • expressions: ISortingExpression<any>[]

  Returns void

Optional unsetChildRowIsland

• unsetChildRowIsland(rowIsland): void

• Parameters

  • rowIsland: GridType

  Returns void

update_cell

• update_cell(cell): IGridEditEventArgs

• Parameters

  • cell: IgxCell

  Returns IGridEditEventArgs

update_row

• update_row(row, value, event?): IGridEditEventArgs

• Parameters

  • row: IgxEditRow

  • value: any

  • Optional event: Event

  Returns IGridEditEventArgs