API Docs for: 1.0.6
Show:

DataSet Class

Defined in: src\jsDataSet.js:2597
Module: DataSet

Stores and manages a set of DataTables and DataRelations

Methods

acceptChanges

()

Defined in src\jsDataSet.js:2752

Calls acceptChanges to all contained DataTables

addTable

(
  • table
)
DataTable

Defined in src\jsDataSet.js:2714

Adds a datatable to DataSet

Parameters:

Returns:

DataTable:

cascadeDelete

(
  • row
)

Defined in src\jsDataSet.js:2821

Deletes a row with all subentity child

Parameters:

Returns:

:

clone

() DataSet

Defined in src\jsDataSet.js:2667

Clones a DataSet replicating its structure but without copying any ObjectRow

Returns:

DataSet:

copy

() DataSet

Defined in src\jsDataSet.js:2736

Creates a copy of the DataSet, including both structure and data.

Returns:

DataSet:

DataSet

(
  • dataSetName
)
DataSet

Defined in src\jsDataSet.js:2602

Creates an empty DataSet

Parameters:

Returns:

DataSet:

deSerialize

(
  • d
  • deSerializeStructure
)

Defined in src\jsDataSet.js:2873

Restores data from an object obtained with serialize().

Parameters:

hasChanges

() Boolean

Defined in src\jsDataSet.js:2772

Check if any contained DataTable has any changes

Returns:

Boolean:

importData

(
  • d
)

Defined in src\jsDataSet.js:2955

Import data from a given dataset

Parameters:

mergeAsPatch

(
  • d
)

Defined in src\jsDataSet.js:2928

merges changes from DataSet d assuming they are unchanged and they are all present in this dataset. Rows are updated, but only fields actually present in d are modified. Other field are left unchanged. It is assumed that "this" dataset is unchanged at the beginning

Parameters:

mergeAsPost

(
  • d
)

Defined in src\jsDataSet.js:2914

merges changes from DataSet d assuming they are unchanged and they are not present in this dataset. Rows are all added 'as is' to this, in the state of ADDED It is assumed that "this" dataset is unchanged at the beginning

Parameters:

mergeAsPut

(
  • d
)

Defined in src\jsDataSet.js:2900

merges changes from DataSet d assuming they are unchanged and they can be present in this or not. If a row is not present, it is added. If it is present, it is updated. It is assumed that "this" dataset is unchanged at the beginning

Parameters:

newRelation

(
  • relationName
  • parentTableName
  • parentColsName
  • childTableName
  • childColsName
)
DataRelation

Defined in src\jsDataSet.js:2783

Creates a new DataRelation and attaches it to the DataSet

Parameters:

Returns:

DataRelation:

newTable

(
  • tableName
)
DataTable

Defined in src\jsDataSet.js:2696

Creates a new DataTable attaching it to the DataSet

Parameters:

Returns:

DataTable:

rejectChanges

()

Defined in src\jsDataSet.js:2762

Calls rejectChanges to all contained DataTables

serialize

(
  • [serializeStructure=false]
  • [filterRow]
)
Object

Defined in src\jsDataSet.js:2849

Creates a serializable version of this DataSet

Parameters:

  • [serializeStructure=false] Boolean optional

    when true serialized also structure, when false only row data

  • [filterRow] Function optional

    function to select which rows have to be serialized

Returns:

Object:

Properties

name

Unknown

Defined in src\jsDataSet.js:2613

DataSet name

optimisticLocking

OptimisticLocking

Defined in src\jsDataSet.js:2648

DataSet - level optimistic locking, this property is set in custom implementations

} relationsByChild

DataRelation[]

Defined in src\jsDataSet.js:2641

Gets all relations where the child table is the key of the hash relationsByChild['a'] is an array of all DataRelations where 'a' is the child

} relations

DataRelation

Defined in src\jsDataSet.js:2628

Collection of DataRelation where relations[relName] is a DataRelation named relName

} relationsByParent

DataRelation[]

Defined in src\jsDataSet.js:2634

Gets all relations where the parent table is the key of the hash relationsByParent['a'] is an array of all DataRelations where 'a' is the parent

} tables

DataTable public

Defined in src\jsDataSet.js:2620

Collection of DataTable where tables[tableName] is a DataTable named tableName