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

DkGridSelection

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

Generics

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

Properties

Property
Description

selectableRows

It gets or sets the function to define the selectable rows.

Type: SelectableFn<T>.

Methods

Method
Description

selectOne()

It marks the given row as selected.

Params:

  1. row: DkGridDataRowEntry<T>.

Return: void.

select()

It marks the given rows as selected.

Params:

  1. rows: DkGridDataRowEntry<T>[].

Return: void.

deselectOne()

It unchecks the given row as selected.

Params:

  1. row: DkGridDataRowEntry<T>.

Return: void.

deselect()

It unchecks the given rows as selected.

Params:

  1. rows: DkGridDataRowEntry<T>[].

Return: void.

getSelectedRows()

It returns all the selected rows.

Params: None.

Return: DkGridDataRowEntry<T>[].

getSelectedEntries()

It returns all the selected entries without the DkGridDataRowEntry wrapper.

Params: None.

Return: T[].

selectAll()

It marks all the selectable rows coming from the data source.

Params: None.

Return: void.

deselectAll()

It unchecks all the selected rows.

Params: None.

Return: void.

Events

Event
Description

selectedRowChange

It emits the selected row.

Params: None.

Return: Observable<DkGridDataRowEntry<T>>.

deselectedRowChange

It emits the deselected row.

Params: None.

Return: Observable<DkGridDataRowEntry<T>>.

selectionChange

It emits all the selected rows.

Params: None.

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

PreviousDkGridSortingNextDkGridRowGrouping

Last updated 2 years ago