Constructors

Section titled "Constructors"

IgxGridSelectionService 

new IgxGridSelectionService(): IgxGridSelectionService

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:74

Returns IgxGridSelectionService

Properties

Section titled "Properties"

activeElement

Section titled "activeElement" 
activeElement: ISelectionNode | null

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:16

columnSelection

Section titled "columnSelection" 
columnSelection: Set<string>

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:25

columnsState

Section titled "columnsState" 
columnsState: IColumnSelectionState

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:19

dragMode

Section titled "dragMode" 
dragMode: boolean = false

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:15

grid

Section titled "grid" 
grid: GridType

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:14

indeterminateRows

Section titled "indeterminateRows" 
indeterminateRows: Set<any>

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:24

keyboardState

Section titled "keyboardState" 
keyboardState: ISelectionKeyboardState

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:17

pointerState

Section titled "pointerState" 
pointerState: ISelectionPointerState

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:18

rowSelection

Section titled "rowSelection" 
rowSelection: Set<any>

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:23

selection

Section titled "selection" 
selection: Map<number, Set<number>>

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:21

temp

Section titled "temp" 
temp: Map<number, Set<number>>

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:22

Accessors

Section titled "Accessors"

allData

Section titled "allData"

Returns all data in the grid, with applied filtering and sorting and without deleted rows.

 
get allData(): any[]

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:697

Returns any[]

filteredSelectedRowIds

Section titled "filteredSelectedRowIds" 
get filteredSelectedRowIds(): any[]

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:629

Returns any[]

primaryButton

Section titled "primaryButton" 
get primaryButton(): boolean

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:66

Returns boolean 

set primaryButton(value: boolean): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:70

Parameters

  • value: boolean

Returns void

ranges

Section titled "ranges"

Returns the current selected ranges in the grid from both keyboard and pointer interactions

 
get ranges(): GridSelectionRange[]

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:51

Returns GridSelectionRange[]

Methods

Section titled "Methods"

add

Section titled "add"

Adds a single node. Single clicks | Ctrl + single clicks on cells is the usual case.

 
add(node: ISelectionNode, addToRange: boolean): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:113

Parameters

Returns void

addKeyboardRange

Section titled "addKeyboardRange"

Adds the active keyboard range selection (if any) to the ranges meta.

 
addKeyboardRange(): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:128

Returns void

addRangeMeta

Section titled "addRangeMeta" 
addRangeMeta(node: ISelectionNode, state: SelectionState): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:169

Parameters

Returns void

areAllRowSelected

Section titled "areAllRowSelected" 
areAllRowSelected(newSelection: any): boolean

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:612

Parameters

  • newSelection: any

Returns boolean

clear

Section titled "clear" 
clear(clearAcriveEl: boolean): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:367

Parameters

  • clearAcriveEl: boolean

Returns void

clearAllSelectedColumns

Section titled "clearAllSelectedColumns"

Clear columnSelection

 
clearAllSelectedColumns(): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:827

Returns void

clearAllSelectedRows

Section titled "clearAllSelectedRows"

Clear rowSelection and update checkbox state

 
clearAllSelectedRows(): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:689

Returns void

clearHeaderCBState

Section titled "clearHeaderCBState" 
clearHeaderCBState(): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:676

Returns void

clearRowSelection

Section titled "clearRowSelection"

Clears row selection, if filtering is applied clears only selected rows from filtered data.

 
clearRowSelection(event: MouseEvent): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:425

Parameters

  • event: MouseEvent

Returns void

clearTextSelection

Section titled "clearTextSelection" 
clearTextSelection(): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:376

Returns void

deselectColumn

Section titled "deselectColumn"

Deselect the specified column and emit event.

 
deselectColumn(field: string, event: MouseEvent): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:789

Parameters

  • field: string
  • event: MouseEvent

Returns void

deselectColumns

Section titled "deselectColumns"

Deselect specified columns. And emit event.

 
deselectColumns(fields: string[], event: KeyboardEvent | MouseEvent): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:801

Parameters

  • fields: string[]
  • event: KeyboardEvent | MouseEvent

Returns void

deselectColumnsWithNoEvent

Section titled "deselectColumnsWithNoEvent"

Deselect specified columns. No event is emitted.

 
deselectColumnsWithNoEvent(fields: string[]): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:796

Parameters

  • fields: string[]

Returns void

deselectPivotRowByID

Section titled "deselectPivotRowByID" 
deselectPivotRowByID(rowID: any, event: KeyboardEvent | MouseEvent): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:490

Parameters

  • rowID: any
  • event: KeyboardEvent | MouseEvent

Returns void

deselectRow

Section titled "deselectRow"

Deselect the specified row and emit event.

 
deselectRow(rowID: any, event: KeyboardEvent | MouseEvent): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:475

Parameters

  • rowID: any
  • event: KeyboardEvent | MouseEvent

Returns void

deselectRows

Section titled "deselectRows" 
deselectRows(keys: any[], event: MouseEvent): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:542

Parameters

  • keys: any[]
  • event: MouseEvent

Returns void

deselectRowsWithNoEvent

Section titled "deselectRowsWithNoEvent"

Deselect specified rows. No event is emitted.

 
deselectRowsWithNoEvent(rowIDs: any[]): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:568

Parameters

  • rowIDs: any[]

Returns void

dragSelect

Section titled "dragSelect" 
dragSelect(node: ISelectionNode, state: SelectionState): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:360

Parameters

Returns void

emitColumnSelectionEvent

Section titled "emitColumnSelectionEvent" 
emitColumnSelectionEvent(newSelection: any, added: any, removed: any, event: KeyboardEvent | MouseEvent): boolean

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:808

Parameters

  • newSelection: any
  • added: any
  • removed: any
  • event: KeyboardEvent | MouseEvent

Returns boolean

emitRowSelectionEvent

Section titled "emitRowSelectionEvent" 
emitRowSelectionEvent(newSelection: any, added: any, removed: any, event: KeyboardEvent | MouseEvent, currSelection: any): boolean

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:635

Parameters

  • newSelection: any
  • added: any
  • removed: any
  • event: KeyboardEvent | MouseEvent
  • currSelection: any

Returns boolean

generateRange

Section titled "generateRange"

Generates a new selection range from the given node. If state is passed instead it will generate the range based on the passed node and the start node of the state.

 
generateRange(node: ISelectionNode, state: SelectionState): GridSelectionRange

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:182

Parameters

Returns GridSelectionRange

getIndeterminateRows

Section titled "getIndeterminateRows"

Returns array of the rows in indeterminate state.

 
getIndeterminateRows(): any[]

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:420

Returns any[]

getPivotRowsByIds

Section titled "getPivotRowsByIds" 
getPivotRowsByIds(ids: any[]): any[]

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:661

Parameters

  • ids: any[]

Returns any[]

getRecordKey

Section titled "getRecordKey" 
getRecordKey(record: any): any

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:684

Parameters

  • record: any

Returns any

getRowDataById

Section titled "getRowDataById" 
getRowDataById(rowID: any): any

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:668

Parameters

  • rowID: any

Returns any

getRowIDs

Section titled "getRowIDs" 
getRowIDs(data: any): any[]

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:680

Parameters

  • data: any

Returns any[]

getSelectedColumns

Section titled "getSelectedColumns"

Returns array of the selected columns fields.

 
getSelectedColumns(): any[]

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:709

Returns any[]

getSelectedRows

Section titled "getSelectedRows"

Returns array of the selected row id's.

 
getSelectedRows(): any[]

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:415

Returns any[]

getSelectedRowsData

Section titled "getSelectedRowsData" 
getSelectedRowsData(): any[]

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:392

Returns any[]

hasSomeRowSelected

Section titled "hasSomeRowSelected" 
hasSomeRowSelected(): boolean

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:623

Returns boolean

initColumnsState

Section titled "initColumnsState"

Resets the columns state

 
initColumnsState(): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:104

Returns void

initKeyboardState

Section titled "initKeyboardState"

Resets the keyboard state

 
initKeyboardState(): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:83

Returns void

initPointerState

Section titled "initPointerState"

Resets the pointer state

 
initPointerState(): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:93

Returns void

isActiveLayout

Section titled "isActiveLayout" 
isActiveLayout(current: IMultiRowLayoutNode, target: IMultiRowLayoutNode): boolean

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:165

Parameters

Returns boolean

isActiveNode

Section titled "isActiveNode" 
isActiveNode(node: ISelectionNode): boolean

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:153

Parameters

Returns boolean

isColumnSelected

Section titled "isColumnSelected" 
isColumnSelected(field: string): boolean

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:713

Parameters

  • field: string

Returns boolean

isInMap

Section titled "isInMap" 
isInMap(node: ISelectionNode): boolean

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:144

Parameters

Returns boolean

isPivotRowSelected

Section titled "isPivotRowSelected" 
isPivotRowSelected(rowID: any): boolean

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:578

Parameters

  • rowID: any

Returns boolean

isRowInIndeterminateState

Section titled "isRowInIndeterminateState" 
isRowInIndeterminateState(rowID: any): boolean

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:590

Parameters

  • rowID: any

Returns boolean

isRowSelected

Section titled "isRowSelected" 
isRowSelected(rowID: any): boolean

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:574

Parameters

  • rowID: any

Returns boolean

keyboardStateOnFocus

Section titled "keyboardStateOnFocus" 
keyboardStateOnFocus(node: ISelectionNode, emitter: EventEmitter<GridSelectionRange>, dom: HTMLElement): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:221

Parameters

Returns void

keyboardStateOnKeydown

Section titled "keyboardStateOnKeydown" 
keyboardStateOnKeydown(node: ISelectionNode, shift: boolean, shiftTab: boolean): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:206

Parameters

Returns void

mergeMap

Section titled "mergeMap" 
mergeMap(target: Map<number, Set<number>>, source: Map<number, Set<number>>): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:275

Parameters

  • target: Map<number, Set<number>>
  • source: Map<number, Set<number>>

Returns void

pointerDown

Section titled "pointerDown" 
pointerDown(node: ISelectionNode, shift: boolean, ctrl: boolean): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:243

Parameters

Returns void

pointerDownShiftKey

Section titled "pointerDownShiftKey" 
pointerDownShiftKey(node: ISelectionNode): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:270

Parameters

Returns void

pointerEnter

Section titled "pointerEnter" 
pointerEnter(node: ISelectionNode, event: PointerEvent): boolean

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:294

Parameters

Returns boolean

pointerUp

Section titled "pointerUp" 
pointerUp(node: ISelectionNode, emitter: EventEmitter<GridSelectionRange>, firedOutsideGrid: boolean): boolean

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:317

Parameters

Returns boolean

remove

Section titled "remove" 
remove(node: ISelectionNode): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:134

Parameters

Returns void

removeRangeMeta

Section titled "removeRangeMeta" 
removeRangeMeta(node: ISelectionNode, state: SelectionState): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:173

Parameters

Returns void

restoreTextSelection

Section titled "restoreTextSelection" 
restoreTextSelection(): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:385

Returns void

selectAllRows

Section titled "selectAllRows"

Select all rows, if filtering is applied select only from filtered data.

 
selectAllRows(event: MouseEvent): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:441

Parameters

  • event: MouseEvent

Returns void

selectColumn

Section titled "selectColumn"

Select the specified column and emit event.

 
selectColumn(field: string, clearPrevSelection: boolean, selectColumnsRange: boolean, event: MouseEvent): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:718

Parameters

  • field: string
  • clearPrevSelection: boolean
  • selectColumnsRange: boolean
  • event: MouseEvent

Returns void

selectColumns

Section titled "selectColumns"

Select specified columns. And emit event.

 
selectColumns(fields: string[], clearPrevSelection: boolean, selectColumnsRange: boolean, event: KeyboardEvent | MouseEvent): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:735

Parameters

  • fields: string[]
  • clearPrevSelection: boolean
  • selectColumnsRange: boolean
  • event: KeyboardEvent | MouseEvent

Returns void

selectColumnsRange

Section titled "selectColumnsRange"

Select range from last clicked column to the current specified column.

 
selectColumnsRange(field: string, event: KeyboardEvent | MouseEvent): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:755

Parameters

  • field: string
  • event: KeyboardEvent | MouseEvent

Returns void

selectColumnsWithNoEvent

Section titled "selectColumnsWithNoEvent"

Select specified columns. No event is emitted.

 
selectColumnsWithNoEvent(fields: string[], clearPrevSelection: boolean): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:779

Parameters

  • fields: string[]
  • clearPrevSelection: boolean

Returns void

selected

Section titled "selected" 
selected(node: ISelectionNode): boolean

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:149

Parameters

Returns boolean

selectMultipleRows

Section titled "selectMultipleRows"

Select range from last selected row to the current specified row.

 
selectMultipleRows(rowID: any, rowData: any, event: MouseEvent): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:595

Parameters

  • rowID: any
  • rowData: any
  • event: MouseEvent

Returns void

selectPivotRowById

Section titled "selectPivotRowById" 
selectPivotRowById(rowID: any, clearPrevSelection: boolean, event: KeyboardEvent | MouseEvent): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:466

Parameters

  • rowID: any
  • clearPrevSelection: boolean
  • event: KeyboardEvent | MouseEvent

Returns void

selectRange

Section titled "selectRange" 
selectRange(node: ISelectionNode, state: SelectionState, collection: Map<number, Set<number>>): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:342

Parameters

Returns void

selectRowById

Section titled "selectRowById"

Select the specified row and emit event.

 
selectRowById(rowID: any, clearPrevSelection: boolean, event: KeyboardEvent | MouseEvent): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:450

Parameters

  • rowID: any
  • clearPrevSelection: boolean
  • event: KeyboardEvent | MouseEvent

Returns void

selectRows

Section titled "selectRows"

Select the specified rows and emit event.

 
selectRows(keys: any[], clearPrevSelection: boolean, event: MouseEvent): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:523

Parameters

  • keys: any[]
  • clearPrevSelection: boolean
  • event: MouseEvent

Returns void

selectRowsWithNoEvent

Section titled "selectRowsWithNoEvent"

Select specified rows. No event is emitted.

 
selectRowsWithNoEvent(rowIDs: any[], clearPrevSelection: boolean): void

Defined in projects/igniteui-angular/grids/core/src/selection/selection.service.ts:558

Parameters

  • rowIDs: any[]
  • clearPrevSelection: boolean

Returns void