DkGrid
  • Overview
  • Getting Started
    • Quick Start Tutorial
  • Fundamentals
    • Grid Structure
      • Grid Size
      • Header
      • Row Filter
      • Rows
      • Panels
      • Gutters
      • Edition Toolbar
      • Paginator
      • Borders
      • Column Context Menu
      • Waiting Indicator
    • DataSource
      • In-Memory DataSource
      • Custom DataSource
    • Theming
  • Columns
    • Column Definitions
    • Column Grouping
    • Column Sizing
    • Column Moving
    • Column Pinning
  • Rows
    • Row Sorting
    • Row Selection
    • Row Grouping
    • Row Pagination
  • Filtering
    • Column Filters
    • Filter types
    • In-line Filters
  • Editing
    • Row Edition
    • Edition templates
    • Edition validation
    • Multiple rows edition
  • Reference
    • DkGrid API
      • DkGridColumnDef
      • DkGridSorting
      • DkGridSelection
      • DkGridRowGrouping
      • DkGridPagination
      • DkGridWaitingIndicator
      • DkGridFactoryDataSource
      • DkGridFilter
      • DkGridEdition
    • Components
      • DkGridComponent
      • DkGridColumnComponent
    • Classes
      • DataSource
      • Columns
      • Rows
      • Filtering
      • Editing
    • Interfaces
      • Columns
      • Sorting
      • Row Grouping
      • Filtering
      • Editing
    • Injection Tokens
      • Grid Structure
      • Filtering
      • Editing
      • Theming
    • Type aliases
      • DataSource
      • Columns
      • Selection
      • Filtering
      • Editing
    • Type Guards
Powered by GitBook
On this page
  • Generics
  • Properties
  • Methods
  • Events
  1. Reference
  2. DkGrid API

DkGridEdition

You can access this instance through the property named edition of the DkGridComponent.

Generics

<T> represents the object's shape coming from the data source.

Properties

Property
Description

rowsInEdition

It is a read-only property that returns all the rows in edition state.

Type: DkGridDataRowEntry<T>[].

modifiedRows

It is a read-only property that returns all the modified rows.

Type: DkGridDataRowEntry<T>[].

removedRows

It is a read-only property that returns all the deleted rows.

Type: DkGridDataRowEntry<T>[].

editionFilterState

It is a read-only property that returns true if the user navigates the edition filters.

Type: boolean.

Methods

Method
Description

editRow()

It changes the row status to edition state.

Params:

  1. row: DkGridDataRowEntry<T>.

Return: void.

updateRow()

It saves the changes in the given row. The given row must be valid and not pristine. After updating, DkGrid sets the row status to Modified.

Params:

  1. row: DkGridDataRowEntry<T>.

Return: void.

cancelRowEdition()

It changes the row status to Read status. This method discards all the changes in the given row.

Params:

  1. row: DkGridDataRowEntry<T>.

Return: void.

removeRow()

It changes the row status to Deleted status.

Params:

  1. row: DkGridDataRowEntry<T>.

Return: void.

restoreRow()

It reverts any change that the user has made.

Params:

  1. row: DkGridDataRowEntry<T>.

Return: void.

updateRowsInEdition()

It takes all valid rows which are not pristine and saves their changes.

Params: None

Return: void.

removeRows()

It deletes the given rows that are not in the edition state.

Params:

  1. rows: DkGridDataRowEntry<T>[].

Return: void.

cancelRowsInEdition()

It cancels the current edition state for every row, losing all the changes you have made.

Params: None.

Return: void.

restoreRows()

It takes those modified or removed rows from the given rows and restores them to their immediate previous state.

Params:

  1. rows: DkGridDataRowEntry<T>[].

Return: void.

setEditionFilter()

It displays the corresponding subset of rows editing.

Params:

  1. value: RowStatus.

Return: void.

cancelEditionFilter()

It makes DkGrid shows the standard view.

Params: None

Return: void.

Events

Event
Description

editionRowChange

It emits the row that has been changed to edition mode.

Params: None.

Return: Observable<DkGridDataRowEntry<T>>.

updateRowChange

It emits the modified rows.

Params: None.

Return: Observable<DkGridDataRowEntry<T> | DkGridDataRowEntry<T>[]>.

cancelRowEditionChange

It emits the rows that have been canceled for edition.

Params: None.

Return: Observable<DkGridDataRowEntry<T> | DkGridDataRowEntry<T>[]>.

removeRowChange

It emits the rows that have been deleted.

Params: None.

Return: Observable<DkGridDataRowEntry<T> | DkGridDataRowEntry<T>[]>.

removeRowChange

It emits the rows that have been deleted.

Params: None.

Return: Observable<DkGridDataRowEntry<T> | DkGridDataRowEntry<T>[]>.

restoreRowChange

It emits the rows whose changes were reverted.

Params: None.

Return: Observable<DkGridDataRowEntry<T> | DkGridDataRowEntry<T>[]>.

editionFilterStateChange

It emits every time you navigate between the standard and the edition view.

Params: None.

Return: Observable<boolean>.

PreviousDkGridFilterNextComponents

Last updated 2 years ago