Class MetaRow

The 'MetaRow' class represents each row of the data table and manages the events associated with the data. This class handles tasks such as adding, modifying, or deleting data and informs you of changes through events.

Hierarchy (view full)

Constructors

constructor

Properties

_entity _guid _list _type $keys count _NS _PARAM _UNION

Methods

_onChanged _onChanging clone equal getObject getTypes instanceOf setObject

Events

onChanged onChanging

Constructors

constructor

  • new MetaRow(entity): MetaRow

  • Creates a 'MetaRow' object.

    Parameters

    • entity: BaseEntity

      This is the 'BaseEntity' object to which 'MetaRow' belongs.

    Returns MetaRow

    Example

    const row = new MetaRow(entity);

Properties

Readonly_entity

_entity: BaseEntity

Returns the entity to which this 'MetaRow' belongs.

Returns

The object 'BaseEntity' that owns this row.

_guid

_guid: string

Unique identifier of the object (GUID). Uniquely identifies the object.

Readonly_list

_list: any[]

Returns a list of elements in a row.

Returns

An array of elements.

_type

_type: Function

The generator function of the object. The function used when the object was created.

Readonly$keys

$keys: string[]

Returns the element key in the row.

Returns

The key arrangement of the element.

Readonlycount

count: number

Returns the number of elements in the row.

Returns

The total number of elements.

Static Readonly_NS

_NS: string

Indicates the namespace.

Default

'Meta'

Static Readonly_PARAM

_PARAM: []

List of parameters used for the constructor.

Static Readonly_UNION

_UNION: []

List of implemented interfaces.

Default

[IObject, IMarshal]

Methods

_onChanged

  • _onChanged(idx, nVal, oVal): void

  • Processes events after element changes.

    Parameters

    • idx: number

      Index where the change occurred.

    • nVal: any

      This is a newly changed value.

    • oVal: any

      This is the previous value.

    Returns void

    Listens

    MetaRow#onChanged

_onChanging

  • _onChanging(idx, nVal, oVal): void

  • Processes events before element changes.

    Parameters

    • idx: number

      Index where the change occurred.

    • nVal: any
    • oVal: any

      Existing value.

    Returns void

    Listens

    MetaRow#onChanging

clone

  • clone(entity?): this

  • Create a new object by replicating the current 'MetaRow' object.

    Parameters

    • Optionalentity: BaseEntity

      'BaseEntity' of the target to be replicated. (Optional)

    Returns this

    Replicated 'MetaRow' object.

    Example

    const clone = row.clone(entity);

equal

  • equal(target): boolean

  • Compare the current object with the specified object.

    Parameters

    • target: object

      the object to be compared to.

    Returns boolean

    Returns whether the two objects are the same.

getObject

  • getObject(vOpt?, owned?): object

  • Converts the current 'MetaRow' object to a serialized GUID type object. In the serialization process, the cyclic reference is replaced by the value '$ref'.

    Parameters

    • OptionalvOpt: number

      Specifies the serialization option.

      • '0': Convert to a reference structure (including '_guid' and '$ref')
      • '1': Converting to a redundant structure (including '_guid' and '$ref')
      • '2': Conversion to non-coordinated structure (excluding '_guid' and '$ref')
    • Optionalowned: object | object[]

      The parent objects that currently own the object. You can receive an object or array of objects.

    Returns object

    Serialized object.

    Example

    const serialized = row.getObject(2); // import serialized objects in a non-coordinated structure

getTypes

  • getTypes(): Function[]

  • Returns the creators of the current object and all the creators of the prototype chain to the array.

    Returns Function[]

    Returns the array of generator functions.

    Example

    const types = obj.getTypes();
    console.log(types); // [Function: MetaObject]

instanceOf

  • instanceOf(target): boolean

  • Verify that the current object is an instance of the specified type (including _UNION)

    Parameters

    • target: string | object

      The type of object to be checked (object or string).

    Returns boolean

    Returns whether it is an instance of the specified type.

setObject

  • setObject(oGuid, origin?): void

  • Sets the serialized GUID type object to the current 'MetaRow' object. During this process, the object is initialized.

    Parameters

    • oGuid: object

      object of serialized GUID type.

    • Optionalorigin: object

      This is the original object that sets the current object. Default is 'oGuid'.

    Returns void

    Example

    row.setObject(serializedObject); // set serialized objects in current row

Events

onChanged

onChanged: ((idx: number, nVal: any, oVal: any, _this: this) => void)

Event after element change.

MetaRow#onChanged

Type declaration

    • (idx, nVal, oVal, _this): void

    • Parameters

      • idx: number

        Index where the change occurred.

      • nVal: any

        This is a newly changed value.

      • oVal: any

        This is the previous value.

      • _this: this

        The object that caused the event.

      Returns void

Example

row.onChanged = (idx, nVal, oVal, _this) => { console.log('Value has changed'); };

onChanging

onChanging: ((idx: number, nVal: any, oVal: any, _this: this) => void)

Event before element change.

MetaRow#onChanging

Type declaration

    • (idx, nVal, oVal, _this): void

    • Parameters

      • idx: number

        Index where the change occurred.

      • nVal: any

        This is the new value to be changed.

      • oVal: any

        Existing value.

      • _this: this

        The object that caused the event.

      Returns void

Example

row.onChanging = (idx, nVal, oVal, _this) => { console.log('Value is about to change'); };

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
Events