Class RevRecordDataServer<SF>

Type Parameters

SF extends RevRecordField

Implements

Index

Constructors

Accessors

allChangedRecentDuration continuousFiltering filterCallback isFiltered recentChanges recordCount recordInsertedRecentDuration recordStore recordUpdatedRecentDuration rowCount rowOrderReversed sortColumnCount sortFieldSpecifierCount sortFieldSpecifiers valueChangedRecentDuration

Constructors

constructor

new RevRecordDataServer<SF extends RevRecordField>(
_schemaServer: RevRecordSchemaServer<SF>,
_recordStore: RevRecordStore,
): RevRecordDataServer<SF>
Type Parameters
- SF extends RevRecordField
Parameters
- _schemaServer: RevRecordSchemaServer<SF>
- _recordStore: RevRecordStore
Returns RevRecordDataServer<SF>

Accessors

allChangedRecentDuration

get allChangedRecentDuration(): number
Returns number
set allChangedRecentDuration(value: number): void
Parameters
- value: number
Returns void

continuousFiltering

get continuousFiltering(): boolean
Returns boolean
set continuousFiltering(value: boolean): void
Parameters
- value: boolean
Returns void

filterCallback

get filterCallback(): undefined | RecordFilterCallback
Returns undefined | RecordFilterCallback
set filterCallback(value: undefined | RecordFilterCallback): void
Parameters
- value: undefined | RecordFilterCallback
Returns void

isFiltered

get isFiltered(): boolean
Returns boolean

recentChanges

get recentChanges(): RevRecordRecentChanges
Returns RevRecordRecentChanges

recordCount

get recordCount(): number
Returns number

recordInsertedRecentDuration

get recordInsertedRecentDuration(): number
Returns number
set recordInsertedRecentDuration(value: number): void
Parameters
- value: number
Returns void

recordStore

get recordStore(): RevRecordStore
Returns RevRecordStore

recordUpdatedRecentDuration

get recordUpdatedRecentDuration(): number
Returns number
set recordUpdatedRecentDuration(value: number): void
Parameters
- value: number
Returns void

rowCount

get rowCount(): number
Returns number

rowOrderReversed

get rowOrderReversed(): boolean
Returns boolean
set rowOrderReversed(value: boolean): void
Parameters
- value: boolean
Returns void

sortColumnCount

get sortColumnCount(): number
Returns number

sortFieldSpecifierCount

get sortFieldSpecifierCount(): number
Returns number

sortFieldSpecifiers

get sortFieldSpecifiers(): readonly SortFieldSpecifier[]
Returns readonly SortFieldSpecifier[]

valueChangedRecentDuration

get valueChangedRecentDuration(): number
Returns number
set valueChangedRecentDuration(value: number): void
Parameters
- value: number
Returns void

Methods

allRecordsDeleted

allRecordsDeleted(): void
Returns void
Implementation of RecordsEventers.allRecordsDeleted

beginChange

beginChange(): void
Returns void
Implementation of RecordsEventers.beginChange

clearSort

clearSort(): boolean
Returns boolean

clearSortFieldSpecifiers

clearSortFieldSpecifiers(): void
Returns void

destroy

destroy(): void
Returns void

endChange

endChange(): void
Returns void
Implementation of RecordsEventers.endChange

getEditValue

getEditValue(field: SF, rowIndex: number): unknown
Get a field's value at the specified row in a format suitable for editing.
Parameters
- field: SF
- rowIndex: number
Returns unknown
The value of the field at the specified row.

Remarks
This function only needs to be implemented if cells can be edited. See RevCellEditor for more information about editing data. The core of the client does not need to know the type of the return value. getEditValue() is called by the Cell Editor associated with the cell. A cell editor expects a certain type of view value and casts the result accordingly.

Implementation of RevDataServer.getEditValue

getFieldSortAscending

getFieldSortAscending(field: number | SF): undefined | boolean
Parameters
- field: number | SF
Returns undefined | boolean

getFieldSortPriority

getFieldSortPriority(field: number | SF): undefined | number
Parameters
- field: number | SF
Returns undefined | number

getRecordIndexFromRowIndex

getRecordIndexFromRowIndex(rowIndex: number): number
Parameters
- rowIndex: number
Returns number

getRecordRecentChangeTypeId

getRecordRecentChangeTypeId(
rowIndex: number,
): undefined | RevRecordRecentChangeTypeId
Parameters
- rowIndex: number
Returns undefined | RevRecordRecentChangeTypeId

getRowCount

getRowCount(): number
The current count of rows data in the server.

Returns number
Number of data rows.

Implementation of RevDataServer.getRowCount

getRowIdFromIndex

getRowIdFromIndex(rowIndex: number): unknown
IMPLEMENTATION OF THIS METHOD IS OPTIONAL.

Only called by Hypergrid when it receives the data-prereindex or data-postreindex events. These events are typically triggered before and after data model remaps the rows (in its apply method).

Parameters:
Parameters
- rowIndex: number
  Grid row index.
Returns unknown
Unique Id of row specified by rowIndex.

Implementation of RevDataServer.getRowIdFromIndex

getRowIndexFromId

getRowIndexFromId(rowId: unknown): undefined | number
Parameters
- rowId: unknown
Returns undefined | number
Implementation of RevDataServer.getRowIndexFromId

getRowIndexFromRecordIndex

getRowIndexFromRecordIndex(recordIndex: number): undefined | number
Parameters
- recordIndex: number
Returns undefined | number

getSortSpecifier

getSortSpecifier(index: number): SortFieldSpecifier
Parameters
- index: number
Returns SortFieldSpecifier

getValueRecentChangeTypeId

getValueRecentChangeTypeId(
field: SF,
rowIndex: number,
): undefined | RevRecordValueRecentChangeTypeId
Parameters
- field: SF
- rowIndex: number
Returns undefined | RevRecordValueRecentChangeTypeId

getViewValue

getViewValue(field: SF, rowIndex: number): unknown
Get a field's value at the specified row in a format suitable for display.
Parameters
- field: SF
- rowIndex: number
Returns unknown
The value of the field at the specified row.

Remarks
The core of the client does not need to know the type of the return value. getViewValue() is called by the Cell Painter associated with the cell/subgrid. The cell painter expects a certain type of view value and casts the result accordingly.

Implementation of RevDataServer.getViewValue

invalidateAll

invalidateAll(): void
Returns void
Implementation of RecordsEventers.invalidateAll

invalidateFields

invalidateFields(fieldIndexes: readonly number[]): void
Parameters
- fieldIndexes: readonly number[]
Returns void
Implementation of RecordsEventers.invalidateFields

invalidateFiltering

invalidateFiltering(): void
Returns void
Implementation of RecordsEventers.invalidateFiltering

invalidateRecord

invalidateRecord(recordIndex: number, recent?: boolean): void
Parameters
- recordIndex: number
- Optionalrecent: boolean
Returns void
Implementation of RecordsEventers.invalidateRecord

invalidateRecordAndValues

invalidateRecordAndValues(
    recordIndex: number,
    invalidatedValues: readonly RevRecordInvalidatedValue[],
    recordUpdateRecent?: boolean,
): void
Parameters
- recordIndex: number
- invalidatedValues: readonly RevRecordInvalidatedValue[]
- OptionalrecordUpdateRecent: boolean
Returns void
Implementation of RecordsEventers.invalidateRecordAndValues

invalidateRecordFields

invalidateRecordFields(
    recordIndex: number,
    fieldIndex: number,
    fieldCount: number,
): void
Parameters
- recordIndex: number
- fieldIndex: number
- fieldCount: number
Returns void
Implementation of RecordsEventers.invalidateRecordFields

invalidateRecords

invalidateRecords(recordIndex: number, count: number, recent?: boolean): void
Parameters
- recordIndex: number
- count: number
- Optionalrecent: boolean
Returns void
Implementation of RecordsEventers.invalidateRecords

invalidateRecordValues

invalidateRecordValues(
recordIndex: number,
invalidatedValues: readonly RevRecordInvalidatedValue[],
): void
Parameters
- recordIndex: number
- invalidatedValues: readonly RevRecordInvalidatedValue[]
Returns void
Implementation of RecordsEventers.invalidateRecordValues

invalidateValue

invalidateValue(
    fieldIndex: number,
    recordIndex: number,
    valueRecentChangeTypeId?: RevRecordValueRecentChangeTypeId,
): void
Parameters
- fieldIndex: number
- recordIndex: number
- OptionalvalueRecentChangeTypeId: RevRecordValueRecentChangeTypeId
Returns void
Implementation of RecordsEventers.invalidateValue

isAnyFieldInRangeSorted

isAnyFieldInRangeSorted(rangeFieldIndex: number, rangeCount: number): boolean
Parameters
- rangeFieldIndex: number
- rangeCount: number
Returns boolean

isAnyFieldSorted

isAnyFieldSorted(fieldIndexes: readonly number[]): boolean
Parameters
- fieldIndexes: readonly number[]
Returns boolean

isFieldSorted

isFieldSorted(fieldIndex: number): boolean
Parameters
- fieldIndex: number
Returns boolean

recordDeleted

recordDeleted(recordIndex: number): void
Parameters
- recordIndex: number
Returns void
Implementation of RecordsEventers.recordDeleted

recordInserted

recordInserted(recordIndex: number, recent?: boolean): void
Parameters
- recordIndex: number
- Optionalrecent: boolean
Returns void
Implementation of RecordsEventers.recordInserted

recordMoved

recordMoved(fromIndex: number, toIndex: number): void
Parameters
- fromIndex: number
- toIndex: number
Returns void
Implementation of RecordsEventers.recordMoved

recordReplaced

recordReplaced(recordIndex: number): void
Parameters
- recordIndex: number
Returns void
Implementation of RecordsEventers.recordReplaced

recordsDeleted

recordsDeleted(recordIndex: number, count: number): void
Parameters
- recordIndex: number
- count: number
Returns void
Implementation of RecordsEventers.recordsDeleted

recordsInserted

recordsInserted(
    firstInsertedRecordIndex: number,
    count: number,
    recent?: boolean,
): void
Parameters
- firstInsertedRecordIndex: number
- count: number
- Optionalrecent: boolean
Returns void
Implementation of RecordsEventers.recordsInserted

recordsLoaded

recordsLoaded(recent?: boolean): void
Parameters
- Optionalrecent: boolean
Returns void
Implementation of RecordsEventers.recordsLoaded

recordsMoved

recordsMoved(fromIndex: number, toIndex: number, moveCount: number): void
Parameters
- fromIndex: number
- toIndex: number
- moveCount: number
Returns void
Implementation of RecordsEventers.recordsMoved

recordsReplaced

recordsReplaced(recordIndex: number, count: number): void
Parameters
- recordIndex: number
- count: number
Returns void
Implementation of RecordsEventers.recordsReplaced

recordsSpliced

recordsSpliced(
    recordIndex: number,
    deleteCount: number,
    insertCount: number,
): void
Parameters
- recordIndex: number
- deleteCount: number
- insertCount: number
Returns void
Implementation of RecordsEventers.recordsSpliced

reset

reset(): void
Returns void

reverseRowIndex

reverseRowIndex(rowIndex: number): number
Parameters
- rowIndex: number
Returns number

reverseRowIndexIfRowOrderReversed

reverseRowIndexIfRowOrderReversed(rowIndex: number): number
Parameters
- rowIndex: number
Returns number

setEditValue

setEditValue(field: SF, rowIndex: number, value: unknown): void
IMPLEMENTATION OF THIS METHOD IS OPTIONAL.

Set a cell's value given its column schema & row indexes and a new value.
Parameters
- field: SF
- rowIndex: number
- value: unknown
Returns void
Implementation of RevDataServer.setEditValue

sort

sort(): void
Returns void

sortBy

sortBy(fieldIndex?: number, isAscending?: boolean): boolean
Parameters
- OptionalfieldIndex: number
- OptionalisAscending: boolean
Returns boolean

sortByMany

sortByMany(specifiers: readonly SortFieldSpecifier[]): boolean
Parameters
- specifiers: readonly SortFieldSpecifier[]
Returns boolean

subscribeDataNotifications

subscribeDataNotifications(value: RevDataServer.NotificationsClient): void
Subscribe to data notifications from the server.
Parameters
- value: RevDataServer.NotificationsClient
Returns void
Implementation of RevDataServer.subscribeDataNotifications

Class RevRecordDataServer<SF>

Type Parameters

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns RevRecordDataServer<SF>

Accessors

allChangedRecentDuration

Returns number

Parameters

Returns void

continuousFiltering

Returns boolean

Parameters

Returns void

filterCallback

Returns undefined | RecordFilterCallback

Parameters

Returns void

isFiltered

Returns boolean

recentChanges

Returns RevRecordRecentChanges

recordCount

Returns number

recordInsertedRecentDuration

Returns number

Parameters

Returns void

recordStore

Returns RevRecordStore

recordUpdatedRecentDuration

Returns number

Parameters

Returns void

rowCount

Returns number

rowOrderReversed

Returns boolean

Parameters

Returns void

sortColumnCount

Returns number

sortFieldSpecifierCount

Returns number

sortFieldSpecifiers

Returns readonly SortFieldSpecifier[]

valueChangedRecentDuration

Returns number

Parameters

Returns void

Methods

allRecordsDeleted

Returns void

beginChange

Returns void

clearSort

Returns boolean

clearSortFieldSpecifiers

Returns void

destroy

Returns void

endChange

Returns void

getEditValue

Parameters

Returns unknown

Remarks

getFieldSortAscending

Parameters

Returns undefined | boolean

getFieldSortPriority

Parameters

Returns undefined | number