Usage
Typescript Import Format
//To use this interface, import as below.
import {FetchByOffsetGridParameters} from "ojs/ojdatagridprovider";
For additional information visit:
Interface defining the parameters passed into a DataGridProvider#fetchByOffset call.
Fields
-
columnCount :number
-
The number of columns to fetch. If fewer than that number of columns exist, the fetch will succeed but be truncated in the column direction.
- Since:
- 11.0.0
-
columnOffset :number
-
The absolute column index offset to be used in the fetch call.
- Since:
- 11.0.0
-
fetchRegions :Set<FetchByOffsetGridParameters.FetchRegionValues>=
-
A Set representing the regions of data to fetch. Iterate over the set to get the fetch regions. If not set the request is 'all'.
- Since:
- 11.0.0
-
rowCount :number
-
The number of rows to fetch. If fewer than that number of rows exist, the fetch will succeed but be truncated in the row direction.
- Since:
- 11.0.0
-
rowOffset :number
-
The absolute row index offset to be used in the fetch call.
- Since:
- 11.0.0
Type Definitions
-
FetchRegionValues
Signature:
('all'|'databody'|'rowHeader'|'rowEndHeader'|'columnHeader'|'columnEndHeader'|'rowHeaderLabel'|'rowEndHeaderLabel'|'columnHeaderLabel'|'columnEndHeaderLabel')
- Since:
- 11.0.0
Supported Values:
| Value | Description |
|---|---|
all |
all the regions supported |
columnEndHeader |
|
columnEndHeaderLabel |
|
columnHeader |
|
columnHeaderLabel |
|
databody |
|
rowEndHeader |
|
rowEndHeaderLabel |
|
rowHeader |
|
rowHeaderLabel |