Class RecordComponent<TName, TKey, TRecord, TInput>

Represents a component of type Record

Type Parameters

TName extends CmpName = CmpName
TKey extends CmpSimpleValue = CmpSimpleValue
TRecord extends RecordValue = RecordValue
TInput extends RecordValue = TRecord

Hierarchy (View Summary)

ValueComponent<CmpName, TRecord, TInput>
- RecordComponent

Implements

ValueComponent

Index

Constructors

constructor

new RecordComponent<
    TName extends string = string,
    TKey extends string | number | boolean = string | number | boolean,
    TRecord extends RecordValue = RecordValue,
    TInput extends RecordValue = TRecord,
>(
    name: string,
    zodType: ZodType<unknown>,
): RecordComponent<TName, TKey, TRecord, TInput>
Type Parameters
- TName extends string = string
- TKey extends string | number | boolean = string | number | boolean
- TRecord extends RecordValue = RecordValue
- TInput extends RecordValue = TRecord
Parameters
- name: string
- zodType: ZodType<unknown>
Returns RecordComponent<TName, TKey, TRecord, TInput>
Inherited from ValueComponent.constructor

Properties

`Readonly`name

name: string

`Readonly`zodType

zodType: ZodType<unknown>

Methods

getAllRecords

getAllRecords(): Promise<undefined | TRecord[]>
Returns Promise<undefined | TRecord[]>

getRecordByKey

getRecordByKey(key: TKey): Promise<undefined | TRecord>
Returns the data of a specific record
Parameters
- key: TKey
  The key value of the wanted record
Returns Promise<undefined | TRecord>
The record (key-value-pair) or undefined if no record with the given key was found

getSelectedKey

getSelectedKey(): Promise<undefined | TKey>
Get the key of the currently selected record

Returns Promise<undefined | TKey>

getValue

getValue(): Promise<undefined | TRecord>
Function for receiving the value of a component.

Returns Promise<undefined | TRecord>
Implementation of ValueComponent.getValue
Inherited from ValueComponent.getValue

onRecordsChanged

onRecordsChanged(
listener: CmpRecordsChangedListener<TRecord[]>,
callImmediately?: boolean,
): void
With this function a listener can be assigned which is executed whenever the data of a record component changes
Parameters
- listener: CmpRecordsChangedListener<TRecord[]>
  Called whenever the records of the given record cmp has changed
- callImmediately: boolean = false
  True: The listener is immediately called with the current records of the record cmp at the time, the listener is added
  False: The listener will be called for the first time when the records of the cmp actually change
Returns void

onSelectedKeyChanged

onSelectedKeyChanged(
    listener: CmpRecordKeyChangedListener<TKey, TRecord>,
    callImmediately?: boolean,
    condition?: CmpRecordKeyChangedCondition<TKey, TRecord>,
): void
With this function a listener can be assigned which is executed whenever the selected key of a record component changes
Parameters
- listener: CmpRecordKeyChangedListener<TKey, TRecord>
  Called whenever the selected key of the given record component has changed
- callImmediately: boolean = false
  True: The listener is immediately called with the current key and value of the cmp at the time, the listener is added
  False: The listener will be called for the first time when the key of the cmp actually changes
- Optionalcondition: CmpRecordKeyChangedCondition<TKey, TRecord>
  A predicate function which is given the new cmp key and value.
  The function can decide on whether the listener is called or not by returning true or false.
Returns void

onValueChanged

onValueChanged(
    listener: CmpValueChangedListener<TRecord>,
    callImmediately?: boolean,
    condition?: CmpValueChangedCondition<TRecord>,
): void
Parameters
- listener: CmpValueChangedListener<TRecord>
  Called whenever the value of the given cmp has changed
- callImmediately: boolean = false
  True: The listener is immediately called with the current value of the cmp at the time, the listener is added
  False: The listener will be called for the first time when the value of the cmp actually changes
- Optionalcondition: CmpValueChangedCondition<TRecord>
  A predicate function which is given the new cmp value.
  The function can decide on whether the listener is called or not by returning true or false.
Returns void
Implementation of ValueComponent.onValueChanged
Inherited from ValueComponent.onValueChanged

setInput

setInput(value: undefined | TInput): Promise<void>
Sends the ChangeConfigurationValue request to the server
Parameters
- value: undefined | TInput
Returns Promise<void>
Implementation of ValueComponent.setInput
Inherited from ValueComponent.setInput

setSelectedKey

setSelectedKey(key: TKey): Promise<void>
Parameters
- key: TKey
Returns Promise<void>

Class RecordComponent<TName, TKey, TRecord, TInput>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns RecordComponent<TName, TKey, TRecord, TInput>

Properties

Readonlyname

ReadonlyzodType

Methods

getAllRecords

Returns Promise<undefined | TRecord[]>

getRecordByKey

Parameters

Returns Promise<undefined | TRecord>

getSelectedKey

Returns Promise<undefined | TKey>

getValue

Returns Promise<undefined | TRecord>

onRecordsChanged

Parameters

Returns void

onSelectedKeyChanged

Parameters

Returns void

onValueChanged

Parameters

Returns void

setInput

Parameters

Returns Promise<void>

setSelectedKey

Parameters

Returns Promise<void>

Settings

On This Page

`Readonly`name

`Readonly`zodType