Class RevDataRowArrayDataServer<SF>

Type Parameters

SF extends RevSchemaField

Implements

RevDataServer<SF>

Index

Constructors

Accessors

Methods

addRow beginDataChange deleteRows endDataChange getRowCount getViewRow getViewValue insertRow invalidateAll reset setEditValue setViewRow subscribeDataNotifications unsubscribeDataNotifications

Constructors

constructor

new RevDataRowArrayDataServer<SF extends RevSchemaField>(): RevDataRowArrayDataServer<
SF,
>
Type Parameters
- SF extends RevSchemaField
Returns RevDataRowArrayDataServer<SF>

Accessors

data

get data(): ObjectViewRow[]
Returns ObjectViewRow[]

Methods

addRow

addRow(dataRow: ObjectViewRow): number
Parameters
- dataRow: ObjectViewRow
Returns number

beginDataChange

beginDataChange(): void
Returns void

deleteRows

deleteRows(index: number, count?: number): ObjectViewRow[]
Parameters
- index: number
- Optionalcount: number
Returns ObjectViewRow[]

endDataChange

endDataChange(): void
Returns void

getRowCount

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

Returns number
Number of data rows.

Implementation of RevDataServer.getRowCount

getViewRow

getViewRow(index: number): ObjectViewRow
IMPLEMENTATION OF THIS METHOD IS OPTIONAL.

Get a row of data.

The injected default implementation is an object of lazy getters.
Parameters
- index: number
Returns ObjectViewRow
The data row corresponding to the given rowIndex. If row does not exist, then throw error.

Implementation of RevDataServer.getViewRow

getViewValue

getViewValue(field: SF, y: number): unknown
Get a field's value at the specified row in a format suitable for display.
Parameters
- field: SF
- y: 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

insertRow

insertRow(index: number, dataRow: ObjectViewRow): void
Parameters
- index: number
- dataRow: ObjectViewRow
Returns void

invalidateAll

invalidateAll(): void
Returns void

reset

reset(data?: ObjectViewRow[]): void
Parameters
- Optionaldata: ObjectViewRow[]
Returns void

setEditValue

setEditValue(field: SF, y: 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
- y: number
- value: unknown
Returns void
Implementation of RevDataServer.setEditValue

setViewRow

setViewRow(index: number, dataRow: ObjectViewRow): void
Update or blank row in place.

Note parameter order is the reverse of addRow.
Parameters
- index: number
- dataRow: ObjectViewRow
  if omitted or otherwise falsy, row renders as blank
Returns void
Implementation of RevDataServer.setViewRow

subscribeDataNotifications

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

unsubscribeDataNotifications

unsubscribeDataNotifications(listener: RevDataServer.NotificationsClient): void
Unsubscribe from data notifications.
Parameters
- listener: RevDataServer.NotificationsClient
Returns void
Remarks
Unsubscribe is optional as it is not required when the client and server are closely bound together and destroyed at the same time.

Implementation of RevDataServer.unsubscribeDataNotifications