About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Class DataRelation

This class describes a relation between two Spotfire.Dxp.Data.DataTables. The relations are contained in a Spotfire.Dxp.Data.DataRelationCollection, use the Add(leftTable, rightTable, relationExpression) method to add new relations.

Since

2.0

Hierarchy (View Summary)

DocumentNode
- DataRelation

Implements

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Context Expression IsAttached IsValid LeftTable RightTable Transactions ConnectsTable GetRelatedTable

Methods

Cast

Cast<T1, T2>(this: T2, type: TypeRef<T1>): T1
Casts this object to the specified type. Throws error on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from DocumentNode.Cast

Equals

Equals(obj: any): boolean
Determines whether the specified object is equal to the current object.
Parameters
- obj: any
  The object to compare with the current object.
Returns boolean
true if the specified object is equal to the current object; otherwise, false.

Inherited from DocumentNode.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from DocumentNode.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from DocumentNode.ToString

TryCast

TryCast<T1, T2>(this: T2, type: TypeRef<T1>): null | T1
Casts this object to the specified type. Returns null on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from DocumentNode.TryCast

`Static`Equals

Equals(objA: any, objB: any): boolean
Determines whether the specified object instances are considered equal.
Parameters
- objA: any
  The first object to compare.
- objB: any
  The second object to compare.
Returns boolean
true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Inherited from DocumentNode.Equals

Default capability

Context

get Context(): INodeContext
Gets the context of this node.

Returns INodeContext
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Context

Expression

get Expression(): string
Gets or sets the expression used to define the relation.

Returns string
Since
2.0
set Expression(value: string): void
Parameters
- value: string
Returns void

IsAttached

get IsAttached(): boolean
Gets a value indicating whether this node is attached.

Returns boolean
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.IsAttached

IsValid

get IsValid(): boolean
Gets a value indicating whether the relation is valid, false otherwise..

Returns boolean
Since
2.0

LeftTable

get LeftTable(): DataTable
Gets the left data table.

Returns DataTable
Since
2.0

RightTable

get RightTable(): DataTable
Gets the right data table.

Returns DataTable
Since
2.0

Transactions

get Transactions(): ITransactions
Gets a collection of methods for executing transactions on the document.

Returns ITransactions
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Transactions

ConnectsTable

ConnectsTable(dataTable: DataTable): boolean
Check if the relation connects the data table.
Parameters
- dataTable: DataTable
  The table to check if the relation connects to it.
Returns boolean
True if the table is part of the relation, false otherwise.

Since
2.0

GetRelatedTable

GetRelatedTable(dataTable: DataTable): DataTable
Get the data table that the given data table relates to in the relation.
Parameters
- dataTable: DataTable
  A data table which is either the right or the left table.
Returns DataTable
The other table that the relation refers to.

Since
2.0