Class DataModel`Abstract`

An object which provides the data for a data grid.

Notes

If the predefined data models are insufficient for a particular use case, a custom model can be defined which derives from this class.

Hierarchy (view full)

DataModel
- MutableDataModel
- JSONModel

Index

Constructors

Properties

Accessors

Methods

columnCount data emitChanged group groupCount metadata rowCount

Constructors

constructor

new DataModel(): DataModel
Returns DataModel

Properties

`Private` _changed

_changed: Signal<DataModel, ChangedArgs> = ...

Accessors

changed

get changed(): ISignal<this, ChangedArgs>
A signal emitted when the data model has changed.

Returns ISignal<this, ChangedArgs>
- Defined in datagrid/src/datamodel.ts:24

Methods

`Abstract` columnCount

columnCount(region): number
Get the column count for a region in the data model.
Parameters
- region: ColumnRegion
  The column region of interest.
Returns number
- The column count for the region.
Notes
This method is called often, and so should be efficient.
- Defined in datagrid/src/datamodel.ts:50

`Abstract` data

data(region, row, column): any
Get the data value for a cell in the data model.
Parameters
- region: CellRegion
  The cell region of interest.
- row: number
  The row index of the cell of interest.
- column: number
  The column index of the cell of interest.
Returns any
The data value for the specified cell.

Notes
The returned data should be treated as immutable.

This method is called often, and so should be efficient.
- Defined in datagrid/src/datamodel.ts:68

`Protected` emitChanged

emitChanged(args): void
Emit the changed signal for the data model.

Notes
Subclasses should call this method whenever the data model has changed so that attached data grids can update themselves.
Parameters
- args: ChangedArgs
Returns void
- Defined in datagrid/src/datamodel.ts:122

group

group(region, groupIndex): null | CellGroup
Get the merged cell group corresponding to a region and index number.
Parameters
- region: CellRegion
  the cell region of cell group.
- groupIndex: number
  the group index of the cell group.
Returns null | CellGroup
a cell group.
- Defined in datagrid/src/datamodel.ts:111

groupCount

groupCount(region): number
Get the count of merged cell groups pertaining to a given cell region.
Parameters
- region: CellRegion
  the target cell region.
Returns number
- Defined in datagrid/src/datamodel.ts:75

metadata

metadata(region, row, column): Metadata
Get the metadata for a cell in the data model.
Parameters
- region: CellRegion
  The cell region of interest.
- row: number
  The row index of the cell of interest.
- column: number
  The column index of the cell of interest.
Returns Metadata
The metadata for the specified cell.

Notes
The returned metadata should be treated as immutable.

This method is called often, and so should be efficient.

The default implementation returns {}.
- Defined in datagrid/src/datamodel.ts:97

`Abstract` rowCount

rowCount(region): number
Get the row count for a region in the data model.
Parameters
- region: RowRegion
  The row region of interest.
Returns number
- The row count for the region.
Notes
This method is called often, and so should be efficient.
- Defined in datagrid/src/datamodel.ts:38