Class MetaSet

constructor

• new MetaSet(name): MetaSet

• Creates a 'MetaSet' object.

  Parameters

  • name: string

    Name of the meta set.

  Returns MetaSet

autoChanges

setName

tables

views

acceptChanges

• acceptChanges(): void

• Allow and commit changes to the meta set.

  Returns void

  Example

  metaSet.acceptChanges(); // Commit changes
  Copy

clear

• clear(): void

• Initializes the rows of all views and all tables.

  Returns void

  Example

  metaSet.clear(); // Initialize rows of all views and tables
  Copy

clone

• clone(): this

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

  Returns this

  Replicated 'MetaSet' object.

  Example

  const clone = metaSet.clone();
  Copy

getObject

• getObject(vOpt?, owned?): object

• Converts the current 'MetaSet' 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 = metaSet.getObject(2); // Import serialized objects in a non-coordinated structure
  Copy

hasChanges

• hasChanges(): boolean

• Verify that there are changes to the meta set.

  Returns boolean

  Return 'true' if there is any change or 'false' if there is no change.

  Example

  const hasChanges = metaSet.hasChanges(); // Check if there are any changes
  Copy

load

• load(obj, parse?): void

• Import or import data (not for merge purposes) Initialize existing data and import new data.

  Parameters

  • obj: string | object

    Data to be retrieved. You can receive an object or string.
  • Optionalparse: Function

    Optional parser function.

  Returns void

  Example

  metaSet.load (dataObject, JSON.path); // import data object
  Copy

output

• output(vOpt?, stringify?, space?): string

• Output (serialize) the meta set object.

  Parameters

  • OptionalvOpt: number

    Serialization option.

    • '0': Output to reference structure
    • '1': Output in duplicate structure
    • '2': Output in a non-coordinated structure
  • Optionalstringify: Function

    Optional serialization function. Default is 'JSON.stringify'.
  • Optionalspace: string

    Optional blank string; default is 'undefined'.

  Returns string

  Serialized string.

  Example

  const jsonString = metaSet.output(2, JSON.stringify, ''); // serialized string output
  Copy

read

• read(obj, opt): void

• Read the object and load the meta set. Follow JSON schema rules.

  Parameters

  • obj: object

    Metaset objects, entities, or other objects.
  • opt: number

    Optional; default is '3'.

  Returns void

  Example

  metaSet.read(dataObject, 3); // read data objects and load the meta set
  Copy

readData

• readData(obj): void

• Read the data to set the row of the meta set.

  Parameters

  • obj: object

    Data to read.

  Returns void

  Example

  metaSet.readData(dataObject); // Set the row of the metaset by reading the data object
  Copy

readSchema

• readSchema(obj, createRow?): void

• Read the schema and apply it to the meta set. If not, set whether an empty column should be created.

  Parameters

  • obj: object

    Schema object or GUID object.
  • OptionalcreateRow: boolean

    If 'true', add a column based on the first row.

  Returns void

  Example

  metaSet.readSchema(schemaObject, true); // Read schema and apply to metaset
  Copy

rejectChanges

• rejectChanges(): void

• Cancel the changes to the meta set.

  Returns void

  Example

  metaSet.rejectChanges(); // Cancel the changes
  Copy

reset

• reset(): void

• Performs a full initialization operation.

  Returns void

  Example

  metaSet.reset(); // initializing the metaset globally
  Copy

setObject

• setObject(oGuid, origin?): void

• Sets the serialized GUID type object to the current 'MetaSet' 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

  metaSet.setObject(serializedObject); // Set serialized objects to the current meta set
  Copy

write

• write(vOpt?): object

• Export the meta set as an object of schema type.

  Parameters

  • OptionalvOpt: number

    Export option.

  Returns object

  Exported schema object.

  Example

  const schemaObject = metaSet.write(1); // Exporting the meta set as schema object
  Copy

writeData

• writeData(vOpt?): object

• Export the data (low) of the meta set as an object of schema type.

  Parameters

  • OptionalvOpt: number

    Export option.

  Returns object

  The exported data object.

  Example

  const dataObject = metaSet.writeData(1); // Export data (low) as schema object
  Copy

writeSchema

• writeSchema(vOpt?): object

• Export the schema (column) of the meta set as an object of schema type.

  Parameters

  • OptionalvOpt: number

    Export option.

  Returns object

  Returns Exported

  schema object.

  Example

  const schemaObject = metaSet.writeSchema(1); // Export schema (column) as schema object
  Copy

StatictransformSchema

• transformSchema(oGuid): object

• Converts the meta set to a schema object.

  Parameters

  • oGuid: object

    serialized object obtained by 'getObject()'.

  Returns object

  The transformed schema object.

  Example

  const schema = MetaSet.transformSchema(serializedObject);
  Copy