Interface: GridBodyItem

Oracle® JavaScript Extension Toolkit (JET)
13.0.1

F52697-01

Since:
  • 11.0.0
Module:
  • ojdatagridprovider

QuickNav

Fields

Description

GridBodyItem is the interface for databody items returned to the DataGrid from FetchByOffsetGridResults#results.


Usage

Signature:

interface GridBodyItem<D>

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

For additional information visit:


GridBodyItem is the interface for databody items returned to the DataGrid from FetchByOffsetGridResults#results.

Fields

columnExtent :number

The total number of columns the cell item being referenced spans. Should be 1 for unmerged cells.

Use this property to indicate cell merges across columns.

Since:
  • 11.0.0

columnIndex :number

The absolute zero-based start column index of the cell item being referenced.
Since:
  • 11.0.0

data :D

The data property for the cell returned to the DataGrid from DataGridProvider.

Data can be any type, however there are some recommendations.

If data is a primitive type, the default DataGrid renderer will be able to render that plain string/number/boolean. If data is complex type, the default DataGrid renderer will likely be unable to render the complex object in a meaningful way.

We recommend data be an object with any properties that your cell may need access to. Doing so will allow following the best editing practices and the best extensibility. In DataGrid demos you may find our samples show data is an object like {data: string}, but this is not required.

Since:
  • 11.0.0

metadata :Object

The metadata property for the cell returned to the DataGrid from DataGridProvider.

Metadata is an object that can be empty or have any keys. It is provided as a way to specify additional information about the cell that applications can access from contextual information about the cell.

Metadata has no keys the DataGrid will interpret for cell items today, but this may be extended in the future.

Since:
  • 11.0.0

rowExtent :number

The total number of rows the cell item being referenced spans. Should be 1 for unmerged cells.

Use this property to indicate cell merges across rows.

Since:
  • 11.0.0

rowIndex :number

The absolute zero-based start row index of the cell item being referenced.
Since:
  • 11.0.0