grid

index

addRowUI

• get addRowUI(): boolean

• Gets if this represents add row UI

  let isAddRow = row.addRowUI;
  Copy

  Returns boolean

data

• get data(): any

• The data record that populates the row.

  let rowData = row.data;
  Copy

  Returns any

deleted

• get deleted(): boolean

• Returns if the row is in delete state.

  Returns boolean

disabled

• get disabled(): boolean

• Optional Indicates whether the current row is disabled

  Returns boolean

expanded

• get expanded(): boolean

• Gets the row expanded/collapsed state.

  const isExpanded = row.expanded;
  Copy

  Returns boolean

• set expanded(val): void

• Expands/collapses the row.

  row.expanded = true;
  Copy

  Parameters

  • val: boolean

  Returns void

inEditMode

• get inEditMode(): boolean

• Returns if the row is currently in edit mode.

  Returns boolean

key

• get key(): any

• Gets the row key. A row in the grid is identified either by:

  • primaryKey data value,
  • the whole rowData, if the primaryKey is omitted.

  let rowKey = row.key;
  Copy

  Returns any

pinned

• get pinned(): boolean

• Gets whether the row is pinned. Default value is false.

  const isPinned = row.pinned;
  Copy

  Returns boolean

• set pinned(val): void

• Sets whether the row is pinned. Default value is false.

  row.pinned = !row.pinned;
  Copy

  Parameters

  • val: boolean

  Returns void

selected

• get selected(): boolean

• Gets whether the row is selected. Default value is false.

  row.selected = true;
  Copy

  Returns boolean

• set selected(val): void

• Sets whether the row is selected. Default value is false.

  row.selected = !row.selected;
  Copy

  Parameters

  • val: boolean

  Returns void

validation

• get validation(): IGridValidationState

• Gets the validation status and errors, if any.

  let validation = row.validation;
  let errors = validation.errors;
  Copy

  Returns IGridValidationState

delete

• delete(): void

• Removes the specified row from the grid's data source. This method emits onRowDeleted event.

  // delete the third selected row from the grid
  this.grid.selectedRows[2].delete();
  Copy

  Returns void

pin

• pin(): boolean

• Pins the specified row. This method emits onRowPinning event.

  // pin the selected row from the grid
  this.grid.selectedRows[0].pin();
  Copy

  Returns boolean

unpin

• unpin(): boolean

• Unpins the specified row. This method emits onRowPinning event.

  // unpin the selected row from the grid
  this.grid.selectedRows[0].unpin();
  Copy

  Returns boolean

update

• update(value): void

• Updates the specified row object and the data source record with the passed value.

  // update the second selected row's value
  let newValue = "Apple";
  this.grid.selectedRows[1].update(newValue);
  Copy

  Parameters

  • value: any

  Returns void