Class Record

record model

Hierarchy

Constructors

constructor

Methods

_convertField clone getField getFieldIndex getFields getID getRaw serialize setField setRaw unSerialize validate

Constructors

constructor

Methods

Protected _convertField

  • _convertField(field: FieldInfo, input: any): any

  • field conversion

    Returns

    the field value in it's original form

    Parameters

    • field: FieldInfo

      field descriptor

    • input: any

      value to convert

    Returns any

clone

  • Parameters

    • Optional source: any

    Returns any

getField

  • get field value (as string)

    Example

    let value = record.get('field1');

    Parameters

    • name: string

      field name

    Returns string

getFieldIndex

  • Parameters

    • name: string

    Returns number

getFields

getID

  • get the record unique identifier by default the return value is the first field

    Returns

    unique identifier

    Returns any

getRaw

  • get raw value of a field

    Parameters

    • name: string | number

      field name or field index

    Returns any

serialize

  • default serializer

    Returns

    an object with known record values

    Returns any

setField

  • set field value

    Example

    record.set( 'field1', 7 );

    Parameters

    • name: string

      field name

    • value: any

      value to set

    Returns void

setRaw

  • Parameters

    • name: string
    • data: string

    Returns void

unSerialize

  • default unserializer

    Returns

    a new Record

    Parameters

    • data: any

      input data

    • Optional id: any

    Returns Record

validate

Settings

Member Visibility

Theme

Generated using TypeDoc