Class JSONModel

A data model implementation for in-memory JSON data.

Hierarchy

DataModel
- JSONModel

Index

Constructors

Properties

_bodyFields _data _headerFields _missingValues

Accessors

Methods

columnCount data emitChanged group groupCount metadata rowCount

Constructors

constructor

new JSONModel(options): JSONModel
Create a data model with static JSON data.
Parameters
- options: JSONModel.IOptions
  
  The options for initializing the data model.
Returns JSONModel
Overrides DataModel.constructor
- Defined in packages/datagrid/src/jsonmodel.ts:23

Properties

`Private` _bodyFields

_bodyFields: Field[]

`Private` _data

_data: DataSource

`Private` _headerFields

_headerFields: Field[]

`Private` _missingValues

_missingValues: null | MissingValuesMap

Accessors

changed

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

Returns ISignal<this, ChangedArgs>
Inherited from DataModel.changed
- Defined in packages/datagrid/src/datamodel.ts:24

Methods

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.
Overrides DataModel.columnCount
- Defined in packages/datagrid/src/jsonmodel.ts:53

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
A missingValue as defined by the schema is converted to null.
Overrides DataModel.data
- Defined in packages/datagrid/src/jsonmodel.ts:74

`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
Inherited from DataModel.emitChanged
- Defined in packages/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.
Inherited from DataModel.group
- Defined in packages/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
Inherited from DataModel.groupCount
- Defined in packages/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 of interest.
- column: number
  
  The column index of the cell of interest.
Returns Metadata
The metadata for the cell.
Overrides DataModel.metadata
- Defined in packages/datagrid/src/jsonmodel.ts:122

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.
Overrides DataModel.rowCount
- Defined in packages/datagrid/src/jsonmodel.ts:39

Generated using TypeDoc