Class ObjectColumn

The 'Object Column' class inherits the 'Base Column' to define a column that addresses object properties. This class provides properties loading, serializing and setting of columns, and replicating columns.

Hierarchy (view full)

Constructors

constructor

Properties

_entity _guid _name _type _valueTypes $alias $key $value alias caption columnName default value _NS _PARAM _UNION

Methods

_load clone equal getObject getTypes instanceOf setObject

Constructors

constructor

  • new ObjectColumn(name, entity, prop): ObjectColumn

  • Creates an object 'ObjectColumn'.

    Parameters

    • name: string

      The name of the object column.

    • entity: BaseEntity

      'BaseEntity' object that owns this column.

    • prop: object

      Properties of the object column.

    Returns ObjectColumn

Properties

_entity

_entity: BaseEntity

Indicates the entity to which this column belongs. Object of type 'BaseEntity'.

_guid

_guid: string

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

_name

_name: string

The name of the element, which acts as a unique identifier for the MetaElement.

_type

_type: Function

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

_valueTypes

_valueTypes: any

Defines the value type for the column. This property is used to set the value type for the column.

$alias

$alias: string

Indicates the alias for the column. The alias is used as another name for the column.

$key

$key: string

Indicates the unique key for this column.

$value

$value: string

Internal value of the column value.

alias

alias: string

Sets or imports aliases for columns. Aliases are used to transfer data and set low values. Where to use (default = columnName)

  • Bind-command-ajax._execBind(): When transmitting data
  • BaseBind.setValue(row): When setting a low value to an entity
  • getValue(): Used for row

caption

caption: string

Provides a description of the column.

columnName

columnName: string

Indicates the name of the column. Same as '_name'.

default

default: string | number | boolean

Sets the default value for the column.

value

value: any

Gets or sets the current value of the column.

Static Readonly_NS

_NS: string

Indicates the namespace.

Default

'Meta'

Static Readonly_PARAM

_PARAM: []

List of parameters used for the constructor.

Default

['name']

Static Readonly_UNION

_UNION: []

List of implemented interfaces.

Default

[IElement]

Methods

_load

  • _load(prop): void

  • Loads the properties of the object.

    Parameters

    • prop: object

      Property object to load.

    Returns void

    Example

    objectColumn._load ({key: 'value'}); // Load the property and apply it to the column

clone

  • clone(entity?): this

  • Replicate the 'Object Column' object to create a new object.

    Parameters

    • Optionalentity: BaseEntity

      The entity to be replicated, if not specified, will be replicated to the current entity.

    Returns this

    Replicated 'ObjectColumn' object.

    Example

    const clone = objectColumn.clone(); // Replicate columns to current entity
    const clusteredWithEntity = objectColumn.clone; // Replicate columns to specified entities

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 'Object Column' object to a serialized GUID type object. In the serialization process, the cyclic reference is replaced by the value '$ref'.

    Parameters

    • OptionalvOpt: number

      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 = objectColumn.getObject(1); // Import serialized objects into reference structures

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 'Object Column' 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

    objectColumn.setObject(serializedObject); // Set serialized objects to the current column

Settings

Member Visibility

On This Page

Constructors
Properties
Methods