Class RevRecordSchemaServer<SF>

Type Parameters

SF extends RevRecordField

Implements

RevSchemaServer<SF>

Constructors

constructor

new RevRecordSchemaServer<SF extends RevRecordField>(): RevRecordSchemaServer<
SF,
>
Type Parameters
- SF extends RevRecordField
Returns RevRecordSchemaServer<SF>

Accessors

fieldCount

get fieldCount(): number
Returns number

fields

get fields(): readonly SF[]
Returns readonly SF[]

schema

get schema(): readonly SF[]
Returns readonly SF[]

Methods

addField

addField(field: SF): SF
Parameters
- field: SF
Returns SF

addFields

addFields(addFields: readonly SF[]): number
Parameters
- addFields: readonly SF[]
Returns number

beginChange

beginChange(): void
Returns void

endChange

endChange(): void
Returns void

getActiveSchemaColumns

getActiveSchemaColumns(): readonly SF[]
Returns readonly SF[]

getColumnCount

getColumnCount(): number
Returns number

getField

getField(fieldIndex: number): SF
Parameters
- fieldIndex: number
Returns SF

getFieldByName

getFieldByName(fieldName: string): SF
Parameters
- fieldName: string
Returns SF

getFieldIndex

getFieldIndex(field: SF): number
Parameters
- field: SF
Returns number

getFieldIndexByName

getFieldIndexByName(fieldName: string): number
Parameters
- fieldName: string
Returns number

getFieldNames

getFieldNames(): string[]
Returns string[]

getFields

getFields(): readonly SF[]
Get list of fields.

The order of these fields defines the orders of field columns in Columns Manager.

Returns readonly SF[]
Implementation of RevSchemaServer.getFields

getFieldValueDependsOnRecordIndexFieldIndexes

getFieldValueDependsOnRecordIndexFieldIndexes(): readonly number[]
Returns readonly number[]

getFilteredFields

getFilteredFields(filterCallback: (field: SF) => boolean): SF[]
Parameters
- filterCallback: (field: SF) => boolean
Returns SF[]

hasField

hasField(name: string): boolean
Parameters
- name: string
Returns boolean

reset

reset(): void
Returns void

setFields

setFields(fields: readonly SF[]): void
Parameters
- fields: readonly SF[]
Returns void

subscribeSchemaNotifications

subscribeSchemaNotifications(
value: RevSchemaServer.NotificationsClient<SF>,
): void
Parameters
- value: RevSchemaServer.NotificationsClient<SF>
Returns void
Implementation of RevSchemaServer.subscribeSchemaNotifications