Class DataRelationCollection

A collection of Spotfire.Dxp.Data.DataRelation objects.

Since

2.0

Hierarchy (View Summary)

Spotfire.Dxp.Framework.DocumentModel.DocumentNode
- DataRelationCollection

Index

Methods

[iterator] Cast Equals GetEnumerator GetHashCode ToString TryCast Equals

Default capability

Item Context Count IsAttached Transactions Add FindRelation FindRelations ForEachNodeInSubTree Remove RemoveAll

Methods

[iterator]

"[iterator]"(): Iterator<Spotfire.Dxp.Data.DataRelation>
Returns Iterator<Spotfire.Dxp.Data.DataRelation>

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

GetEnumerator

GetEnumerator(): System.Collections.Generic.IEnumerator<
Spotfire.Dxp.Data.DataRelation,
>
Returns an enumerator that iterates through the collection.

Returns System.Collections.Generic.IEnumerator<Spotfire.Dxp.Data.DataRelation>
An enumerator that can be used to iterate through the collection.

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>): T1 | null
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 T1 | null
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

`Readonly`Item

Item: PropertyGet<number | System.Int32, Spotfire.Dxp.Data.DataRelation>

Gets the relation at the given index.

Param: index

The index of the relation.

Returns

The relation at the specified index.

Since

2.0

Context

get Context(): Spotfire.Dxp.Framework.DocumentModel.INodeContext
Gets the context of this node.

Returns Spotfire.Dxp.Framework.DocumentModel.INodeContext
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Context

Count

get Count(): number
The number of relations in this collection.

Returns number
Since
2.0

IsAttached

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

Returns boolean
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.IsAttached

Transactions

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

Returns Spotfire.Dxp.Framework.DocumentModel.ITransactions
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Transactions

Add

Add(
    leftTable: Spotfire.Dxp.Data.DataTable,
    rightTable: Spotfire.Dxp.Data.DataTable,
    relationExpression: string | System.String,
): Spotfire.Dxp.Data.DataRelation
Adds a relation to this collection.
Parameters
- leftTable: Spotfire.Dxp.Data.DataTable
  The left table.
- rightTable: Spotfire.Dxp.Data.DataTable
  The right table.
- relationExpression: string | System.String
  The relation expression.
Returns Spotfire.Dxp.Data.DataRelation
The new data relation.

Since
2.0

FindRelation

FindRelation(
table1: Spotfire.Dxp.Data.DataTable,
table2: Spotfire.Dxp.Data.DataTable,
): Spotfire.Dxp.Data.DataRelation
Finds a relation between two given data tables.
Parameters
- table1: Spotfire.Dxp.Data.DataTable
  The first table.
- table2: Spotfire.Dxp.Data.DataTable
  The second table.
Returns Spotfire.Dxp.Data.DataRelation
The relation between the tables; otherwise null.

Since
2.0

FindRelations

FindRelations(
dataTable: Spotfire.Dxp.Data.DataTable,
): System.Collections.Generic.IList<Spotfire.Dxp.Data.DataRelation>
Finds all valid relations where a given data table is involved.
Parameters
- dataTable: Spotfire.Dxp.Data.DataTable
  The data table.
Returns System.Collections.Generic.IList<Spotfire.Dxp.Data.DataRelation>
A list of valid data relations.

Since
2.0
FindRelations(
dataTable: Spotfire.Dxp.Data.DataTable,
includeInvalidRelations: boolean | System.Boolean,
): System.Collections.Generic.IList<Spotfire.Dxp.Data.DataRelation>
Finds all relations where a given data table is involved.
Parameters
- dataTable: Spotfire.Dxp.Data.DataTable
  The data table.
- includeInvalidRelations: boolean | System.Boolean
  True if invalid relations should be included in the result; otherwise, false.
Returns System.Collections.Generic.IList<Spotfire.Dxp.Data.DataRelation>
A list of data relations.

Since
2.0

ForEachNodeInSubTree

ForEachNodeInSubTree<TNode>(
typeTNode: TypeRefParam<TNode>,
action: System.Action<TNode>,
): void
Applies the specified action to all nodes of the specified type in the subtree spanned from this node, including this node.
Type Parameters
- TNode
Parameters
- typeTNode: TypeRefParam<TNode>
  Generic type argument
- action: System.Action<TNode>
  The action to apply.
Returns void
Since
2.1

Inherited from DocumentNode.ForEachNodeInSubTree

Remove

Remove(dataRelation: Spotfire.Dxp.Data.DataRelation): void
Removes a relation from this collection.
Parameters
- dataRelation: Spotfire.Dxp.Data.DataRelation
  The relation to be removed.
Returns void
Since
2.0

RemoveAll

RemoveAll(match: System.Predicate<Spotfire.Dxp.Data.DataRelation>): void
Removes all relations that satisfy a given predicate from this collection.
Parameters
- match: System.Predicate<Spotfire.Dxp.Data.DataRelation>
  The predicate.
Returns void
Since
2.0

Class DataRelationCollection

Since

Hierarchy (View Summary)

Implements

Index

Methods

Default capability

Methods

[iterator]

Returns Iterator<Spotfire.Dxp.Data.DataRelation>

Cast

Type Parameters

Parameters

Returns T1

Equals

Parameters

Returns boolean

GetEnumerator

Returns System.Collections.Generic.IEnumerator<Spotfire.Dxp.Data.DataRelation>

GetHashCode

Returns number

ToString

Returns string

TryCast

Type Parameters

Parameters

Returns T1 | null

StaticEquals

Parameters

Returns boolean

Default capability

ReadonlyItem

Param: index

Returns

Since

Context

Returns Spotfire.Dxp.Framework.DocumentModel.INodeContext

Since

Count

Returns number

Since

IsAttached

Returns boolean

Since

Transactions

Returns Spotfire.Dxp.Framework.DocumentModel.ITransactions

Since

Add

Parameters

Returns Spotfire.Dxp.Data.DataRelation

Since

FindRelation

Parameters

Returns Spotfire.Dxp.Data.DataRelation

Since

FindRelations

Parameters

Returns System.Collections.Generic.IList<Spotfire.Dxp.Data.DataRelation>

Since

Parameters

Returns System.Collections.Generic.IList<Spotfire.Dxp.Data.DataRelation>

Since

ForEachNodeInSubTree

Type Parameters

Parameters

Returns void

Since

Remove

Parameters

Returns void

Since

RemoveAll

Parameters

Returns void

Since

Settings

On This Page

`Static`Equals

`Readonly`Item