Class DSVModel

A data model implementation for in-memory delimiter-separated data.

Notes

This model handles data with up to 2**32 characters.

Hierarchy

DataModel
- DSVModel

Implements

IDisposable

Index

Constructors

constructor

new DSVModel(options: DSVModel.IOptions): DSVModel
Create a data model with static CSV data.
Parameters
- options: DSVModel.IOptions
  The options for initializing the data model.
Returns DSVModel
Overrides DataModel.constructor
- Defined in packages/csvviewer/src/model.ts:42

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 node_modules/@lumino/datagrid/types/datamodel.d.ts:14

delimiter

get delimiter(): string
The delimiter between entries on the same row.

Returns string
- Defined in packages/csvviewer/src/model.ts:139

doneParsing

get doneParsing(): boolean
A boolean determined by whether parsing has completed.

Returns boolean
- Defined in packages/csvviewer/src/model.ts:153

header

get header(): string[]
The header strings.

Returns string[]
- Defined in packages/csvviewer/src/model.ts:129
set header(value: string[]): void
Parameters
- value: string[]
Returns void
- Defined in packages/csvviewer/src/model.ts:132

initialRows

get initialRows(): number
The initial chunk of rows to parse.

Returns number
- Defined in packages/csvviewer/src/model.ts:119
set initialRows(value: number): void
Parameters
- value: number
Returns void
- Defined in packages/csvviewer/src/model.ts:122

isDisposed

get isDisposed(): boolean
Whether this model has been disposed.

Returns boolean
Implementation of IDisposable.isDisposed
- Defined in packages/csvviewer/src/model.ts:95

rawData

get rawData(): string
The string representation of the data.

Returns string
- Defined in packages/csvviewer/src/model.ts:109
set rawData(value: string): void
Parameters
- value: string
Returns void
- Defined in packages/csvviewer/src/model.ts:112

ready

get ready(): Promise<void>
A promise that resolves when the model has parsed all of its data.

Returns Promise<void>
- Defined in packages/csvviewer/src/model.ts:102

rowDelimiter

get rowDelimiter(): string
The delimiter between rows.

Returns string
- Defined in packages/csvviewer/src/model.ts:146

Methods

columnCount

columnCount(region: ColumnRegion): 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/csvviewer/src/model.ts:182

data

data(region: CellRegion, row: number, column: number): string
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 string
Overrides DataModel.data
- Defined in packages/csvviewer/src/model.ts:200

dispose

dispose(): void
Dispose the resources held by this model.

Returns void
Implementation of IDisposable.dispose
- Defined in packages/csvviewer/src/model.ts:236

`Protected`emitChanged

emitChanged(args: ChangedArgs): 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 node_modules/@lumino/datagrid/types/datamodel.d.ts:93

getOffsetIndex

getOffsetIndex(row: number, column: number): number
Get the index in the data string for the first character of a row and column.
Parameters
- row: number
  The row of the data item.
- column: number
  The column of the data item.
Returns number
- The index into the data string where the data item starts.
- Defined in packages/csvviewer/src/model.ts:271

group

group(region: CellRegion, groupIndex: number): 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 node_modules/@lumino/datagrid/types/datamodel.d.ts:85

groupCount

groupCount(region: CellRegion): 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 node_modules/@lumino/datagrid/types/datamodel.d.ts:59

metadata

metadata(region: CellRegion, row: number, column: number): 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 {}.
Inherited from DataModel.metadata
- Defined in node_modules/@lumino/datagrid/types/datamodel.d.ts:78

parseAsync

parseAsync(): void
Parse the data string asynchronously.

Notes
It can take several seconds to parse a several hundred megabyte string, so we parse the first 500 rows to get something up on the screen, then we parse the full data string asynchronously.

Returns void
- Defined in packages/csvviewer/src/model.ts:326

rowCount

rowCount(region: RowRegion): 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/csvviewer/src/model.ts:164

Class DSVModel

Notes

Hierarchy

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns DSVModel

Accessors

changed

Returns ISignal<this, ChangedArgs>

delimiter

Returns string

doneParsing

Returns boolean

header

Returns string[]

Parameters

Returns void

initialRows

Returns number

Parameters

Returns void

isDisposed

Returns boolean

rawData

Returns string

Parameters

Returns void

ready

Returns Promise<void>

rowDelimiter

Returns string

Methods

columnCount

Parameters

Returns number

data

Parameters

Returns string

dispose

Returns void

ProtectedemitChanged

Notes

Parameters

Returns void

getOffsetIndex

Parameters

Returns number

group

Parameters

Returns null | CellGroup

groupCount

Parameters

Returns number

metadata

Parameters

Returns Metadata

Notes

parseAsync

Notes

Returns void

rowCount

Parameters

Returns number

Settings

On This Page

`Protected`emitChanged