import FlexDataGridVirtualScrollEvent from 'flexicious-react-datagrid/js/flexgrid/events/FlexDataGridVirtualScrollEvent.js'FlexDataGridVirtualScrollEvent
Extends:
When grid.enableVirtualScroll=true, the grid dispatches a virtualScroll event when the grid scrolls. This event contains a recordsToLoad array, which contains an series of VirtualScrollLoadInfo records. This provides the application a list of record indexes to load, and which levels to load them at.
In flat grids, the FlexDataGridVirtualScrollEvent.recordsToLoad will always contain a list of VirtualScrollLoadInfo records were level=1. For nested grids, depending on where the user scrolls and which items are open, you could get a list of records from multiple levels, for example. Records 1-3 from level 1, All children of record 3 from level 2, and then Record 4-10 from level 1.
Setting enableVirtualScroll requires that you specify childrenCountField as well as selectedKeyField. Additionally, enableVirtualScroll also requires that you set filterPageSortMode=server and itemLoadMode=server. Finally, virtual scroll does not work with variableRowHeights.
Constructor Summary
| Public Constructor | ||
| public |
constructor(type: *, grid: *, recordsToLoad: *, bubbles: *, cancelable: *) |
|
Member Summary
| Public Members | ||
| public |
The FlexDataGrid object |
|
| public |
This event contains a recordsToLoad array, which contains an series of VirtualScrollLoadInfo records. |
|
Method Summary
| Public Methods | ||
| public |
getClassNames(): string[] |
|
Inherited Summary
| From class TypedObject | ||
| public |
typeCache: {} |
|
| public |
|
|
| public |
Returns a list of strings that represent the object hierarchy for this object. |
|
| public |
implementsOrExtends(name: *): Boolean Returns true if the class name to check is in the list of class names defined for this class. |
|
| From class BaseEvent | ||
| public |
Ignored property |
|
| public |
Whether or not this event can be cancelled. |
|
| public |
Has the default for this event been prevented |
|
| public |
Type of this event. |
|
| public |
getClassNames(): string[] |
|
| public |
Has the default for this event been prevented. |
|
| public |
If this event is cancelable, then the default prevented flag is set to true. |
|
| public |
If this event is cancelable, then the default prevented flag is set to true. |
|
Public Constructors
public constructor(type: *, grid: *, recordsToLoad: *, bubbles: *, cancelable: *) source
Override:
BaseEvent#constructorParams:
| Name | Type | Attribute | Description |
| type | * | ||
| grid | * | ||
| recordsToLoad | * | ||
| bubbles | * | ||
| cancelable | * |
Public Members
public grid: FlexDataGrid source
The FlexDataGrid object
Properties:
| Name | Type | Attribute | Description |
| grid | * |
Public Methods
public getClassNames(): string[] source
Returns a list of strings that represent the object hierarchy for this object.