Interface: FetchByOffsetGridResults

Oracle® JavaScript Extension Toolkit (JET)
15.1.0
F83698-01

Since:
  • 11.0.0
Module:
  • ojdatagridprovider

QuickNav

Fields

Description

Interface defining the return value of promise results from a DataGridProvider#fetchByOffset call.


Usage

Signature:

interface FetchByOffsetGridResults<D>

Generic Parameters
ParameterDescription
DType of Data
Typescript Import Format
//To use this interface, import as below.
import {FetchByOffsetGridResults} from "ojs/ojdatagridprovider";

For additional information visit:


Interface defining the return value of promise results from a DataGridProvider#fetchByOffset call.

Fields

columnCount :number

The number of columns returned in the fetch result.
Since:
  • 11.0.0

columnDone :boolean

Indicates whether there are more column items which can be fetched after the given block. This flag should only be set when the results of the fetch are empty along the column edge. There is potential that this flag may be set, but mutations to the DataGridProvider would result in future calls returning values. If false, fetching by offset at offset greater than the end of the current result may or may not return an empty array.
Since:
  • 11.0.0

columnOffset :number

The absolute column index of the start of the fetch result region.
Since:
  • 11.0.0

fetchParameters :FetchByOffsetGridParameters

The original fetch parameters used in the fetchByOffset call.
Since:
  • 11.0.0

(nullable) next :Promise.<FetchByOffsetGridResults.<D>>

Optional promise to return results not included in this fetch.

The next promise allows for categorical iteration of the results. For example if headers are available immediately but not the data body, the results object can contain just headers. A promise would be returned here for next to return the data body cells later.

The next promise is not used to return a partial count of the requested fetch. For example returning 10 rows in results then setting next to return 10 more rows is not supported. This case should be handled by the consumer requesting more data if necessary.

Since:
  • 11.0.0

results :Object

An object containing properties with the resulting items bounded by the result
Properties:
Name Type Argument Description
columnEndHeader Array.<GridHeaderItem.<D>> <optional>
 results to be displayed in the column end header region. The array is expected to contain items in sorted order by level innermost to outermost (high to low), then index low to high.
columnEndHeaderLabel Array.<GridItem.<D>> <optional>
 results to be displayed in the column end header label region. The array is expected to contain items in sorted order by index innermost to outermost (high to low).
columnHeader Array.<GridHeaderItem.<D>> <optional>
 results to be displayed in the column header region. The array is expected to contain items in sorted order by level innermost to outermost (high to low), then index low to high.
columnHeaderLabel Array.<GridItem.<D>> <optional>
 results to be displayed in the column header label region. The array is expected to contain items in sorted order by index innermost to outermost (high to low).
databody Array.<GridBodyItem.<D>> <optional>
 results to be displayed in the databody. The array is expected to contain items in sorted order by row start index low to high, then column index low to high.
rowEndHeader Array.<GridHeaderItem.<D>> <optional>
 results to be displayed in the row end header region. The array is expected to contain items in sorted order by level innermost to outermost (high to low), then index low to high.
rowEndHeaderLabel Array.<GridItem.<D>> <optional>
 results to be displayed in the row end header label region. The array is expected to contain items in sorted order by index innermost to outermost (high to low).
rowHeader Array.<GridHeaderItem.<D>> <optional>
 results to be displayed in the row header region. The array is expected to contain items in sorted order by level innermost to outermost (high to low), then index low to high.
rowHeaderLabel Array.<GridItem.<D>> <optional>
 results to be displayed in the row header label region. The array is expected to contain items in sorted order by index innermost to outermost (high to low).
Since:
  • 11.0.0

rowCount :number

The number of rows returned in the fetch result.
Since:
  • 11.0.0

rowDone :boolean

Indicates whether there are more row items which can be fetched after the given block. This flag should only be set when the results of the fetch are empty along the row edge. There is potential that this flag may be set, but mutations to the DataGridProvider would result in future calls returning values. If false, fetching by offset at offset greater than the end of the current result may or may not return an empty array.
Since:
  • 11.0.0

rowOffset :number

The absolute row index of the start of the fetch result region.
Since:
  • 11.0.0

totalColumnCount :number

The total number of columns in the data set as a best estimate, -1 indicates unknown.
Since:
  • 11.0.0

totalRowCount :number

The total number of rows in the data set as a best estimate, -1 indicates unknown.
Since:
  • 11.0.0

version :number

Optional version of the result, currently supports number via monotonically increasing versions. In cases where mutations can occur on the DataGridProvider, provide a version that increases with each mutation to ensure consumers can handle mutations in an ordered manner.
Since:
  • 11.0.0