Class RevGenericTableField<TextFormattableValueTypeId, TextFormattableValueAttributeTypeId>

Type Parameters

TextFormattableValueTypeId
TextFormattableValueAttributeTypeId

Hierarchy (View Summary)

RevTableField<TextFormattableValueTypeId, TextFormattableValueAttributeTypeId>
- RevGenericTableField

Index

Constructors

constructor

new RevGenericTableField<
    TextFormattableValueTypeId,
    TextFormattableValueAttributeTypeId,
>(
    _textFormatter: RevTextFormatter<
        TextFormattableValueTypeId,
        TextFormattableValueAttributeTypeId,
    >,
    definition: RevTableField.Definition<
        TextFormattableValueTypeId,
        TextFormattableValueAttributeTypeId,
    >,
    heading: string,
): RevGenericTableField<
    TextFormattableValueTypeId,
    TextFormattableValueAttributeTypeId,
>
Type Parameters
- TextFormattableValueTypeId
- TextFormattableValueAttributeTypeId
Parameters
- _textFormatter: RevTextFormatter<
  TextFormattableValueTypeId,
  TextFormattableValueAttributeTypeId,
  >
- definition: RevTableField.Definition<
  TextFormattableValueTypeId,
  TextFormattableValueAttributeTypeId,
  >
- heading: string
Returns RevGenericTableField<
TextFormattableValueTypeId,
TextFormattableValueAttributeTypeId,
>
Inherited from RevTableField.constructor

Properties

`Readonly`definition

definition: RevRecordSourcedFieldDefinition

getEditValueEventer

getEditValueEventer: undefined | GetEditValueEventer

heading

heading: string

index

index: number

Used by servers to index data. Will be used by client to access data in circumstances when a complete row of data is retrieved with RevDataServer.getViewRow from the server.

`Readonly`name

name: string

Identifies a field in the schema. Will be unique within a schema (ie grid).

setEditValueEventer

setEditValueEventer: undefined | SetEditValueEventer

Accessors

valueTypeId

get valueTypeId(): TextFormattableValueTypeId
Returns TextFormattableValueTypeId
Inherited from RevTableField.valueTypeId

Methods

compare

compare(
    left: RevTableValuesRecord<
        TextFormattableValueTypeId,
        TextFormattableValueAttributeTypeId,
    >,
    right: RevTableValuesRecord<
        TextFormattableValueTypeId,
        TextFormattableValueAttributeTypeId,
    >,
): number
Parameters
- left: RevTableValuesRecord<
  TextFormattableValueTypeId,
  TextFormattableValueAttributeTypeId,
  >
- right: RevTableValuesRecord<
  TextFormattableValueTypeId,
  TextFormattableValueAttributeTypeId,
  >
Returns number
Inherited from RevTableField.compare

compareDesc

compareDesc(
    left: RevTableValuesRecord<
        TextFormattableValueTypeId,
        TextFormattableValueAttributeTypeId,
    >,
    right: RevTableValuesRecord<
        TextFormattableValueTypeId,
        TextFormattableValueAttributeTypeId,
    >,
): number
Parameters
- left: RevTableValuesRecord<
  TextFormattableValueTypeId,
  TextFormattableValueAttributeTypeId,
  >
- right: RevTableValuesRecord<
  TextFormattableValueTypeId,
  TextFormattableValueAttributeTypeId,
  >
Returns number
Inherited from RevTableField.compareDesc

getEditValue

getEditValue(record: IndexedRecord): unknown
Retrieves the value of a field for edit purposes
Parameters
- record: IndexedRecord
Returns unknown
Inherited from RevTableField.getEditValue

getViewValue

getViewValue(
    record: RevTableValuesRecord<
        TextFormattableValueTypeId,
        TextFormattableValueAttributeTypeId,
    >,
): RevTextFormattableValue<
    TextFormattableValueTypeId,
    TextFormattableValueAttributeTypeId,
>
Retrieves the value of a field for display purposes
Parameters
- record: RevTableValuesRecord<
  TextFormattableValueTypeId,
  TextFormattableValueAttributeTypeId,
  >
Returns RevTextFormattableValue<
TextFormattableValueTypeId,
TextFormattableValueAttributeTypeId,
>
Inherited from RevTableField.getViewValue

setEditValue

setEditValue(record: IndexedRecord, value: unknown): void
Set the value of a field
Parameters
- record: IndexedRecord
- value: unknown
Returns void
Inherited from RevTableField.setEditValue

Class RevGenericTableField<TextFormattableValueTypeId, TextFormattableValueAttributeTypeId>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns RevGenericTableField< TextFormattableValueTypeId, TextFormattableValueAttributeTypeId,>

Properties

Readonlydefinition

getEditValueEventer

heading

index

Readonlyname

setEditValueEventer

Accessors

valueTypeId

Returns TextFormattableValueTypeId

Methods

compare

Parameters

Returns number

compareDesc

Parameters

Returns number

getEditValue

Parameters

Returns unknown

getViewValue

Parameters

Returns RevTextFormattableValue< TextFormattableValueTypeId, TextFormattableValueAttributeTypeId,>

setEditValue

Parameters

Returns void

Settings

On This Page

Returns RevGenericTableField<
TextFormattableValueTypeId,
TextFormattableValueAttributeTypeId,
>

`Readonly`definition

`Readonly`name

Returns RevTextFormattableValue<
TextFormattableValueTypeId,
TextFormattableValueAttributeTypeId,
>