API Docs for: 1.0.6
Show:

DataRelation Class

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

creates a DataRelation

Constructor

DataRelation

(
  • relationName
  • parentTableName
  • parentColsName
  • childTableName
  • [childColsName=parentColsName]
)
DataRelation

Defined in src\jsDataSet.js:2363

Parameters:

Returns:

DataRelation:

Methods

getChild

(
  • parentRow
)
ObjectRow[]

Defined in src\jsDataSet.js:2442

Get any child of a given ObjectRow following this DataRelation

Parameters:

Returns:

ObjectRow[]:

getChildFilter

(
  • parentRow
  • [alias]
)

Defined in src\jsDataSet.js:2426

Gets a filter that will be applied to the child table and will find any child row of a given ObjectRow

Parameters:

  • parentRow ObjectRow
  • [alias] String optional

    when present is used to attach an alias for the parent table in the composed filter

getParents

(
  • childRow
)
ObjectRow[]

Defined in src\jsDataSet.js:2474

Get any parent of a given ObjectRow following this DataRelation

Parameters:

Returns:

ObjectRow[]:

getParentsFilter

(
  • childRow
  • [alias]
)

Defined in src\jsDataSet.js:2457

Gets a filter that will be applied to the parent table and will find any parent row of a given ObjectRow

Parameters:

  • childRow Object
  • [alias] String optional

    when present is used to attach an alias for the parent table in the composed filter

isEntityRelation

() Boolean

Defined in src\jsDataSet.js:2540

Establish if a relation links the key of a table into a subset of another table key

Returns:

Boolean:

makeChild

(
  • parentRow
  • childRow
)

Defined in src\jsDataSet.js:2563

Modifies childRow in order to make it child of parentRow. Sets to null corresponding fields if parentRow is null or undefined

Parameters:

Returns:

:

Properties

childCols

String | String[]

Defined in src\jsDataSet.js:2408

Array of child column names or comma separated column names

childTable

String

Defined in src\jsDataSet.js:2401

Child table name

dataSet

DataSet

Defined in src\jsDataSet.js:2383

DataSet to which this DataRelation belongs to. It is used to retrieve parent and child table

parentCols

String | String[]

Defined in src\jsDataSet.js:2390

Array of parent column names or comma separated column names

parentTable

String

Defined in src\jsDataSet.js:2376

Parent table name