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

Class DataRelationshipsColumnCollection

Represents a collection of Spotfire.Dxp.Data.DataColumns selected as input for a Spotfire.Dxp.Application.Calculations.DataRelationships.DataRelationshipsCalculation.

Since

2.0

Hierarchy (View Summary)

Spotfire.Object
- DataRelationshipsColumnCollection

Implements

Index

Methods

[iterator] Cast Equals GetHashCode ToString TryCast Equals

Default capability

Count IsReadOnly Add AddRange Clear Contains CopyTo GetEnumerator Remove ReplaceAll

Methods

[iterator]

"[iterator]"(): Iterator<DataColumn>
Returns Iterator<DataColumn>

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 Object.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 Object.Equals

GetHashCode

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

Returns number
A hash code for the current object.

Inherited from Object.GetHashCode

ToString

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

Returns string
A string that represents the current object.

Inherited from Object.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 Object.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 Object.Equals

Default capability

Count

get Count(): number
The number of Spotfire.Dxp.Data.DataColumns in the collection.

Returns number
Since
2.0

IsReadOnly

get IsReadOnly(): boolean
Determines if the collection is readonly.

Returns boolean
Since
2.0

Add

Add(item: DataColumn): void
Add a Spotfire.Dxp.Data.DataColumn to this collection
Parameters
- item: DataColumn
  The Spotfire.Dxp.Data.DataColumn to add.
Returns void
Since
2.0

AddRange

AddRange(
columns: OrExplicit<System.Collections.Generic.IEnumerable<DataColumn>>,
): void
Adds the Spotfire.Dxp.Data.DataColumns to this collection.
Parameters
- columns: OrExplicit<System.Collections.Generic.IEnumerable<DataColumn>>
  The Spotfire.Dxp.Data.DataColumns to add.
Returns void
Since
2.0

Clear

Clear(): void
Clears the collection of all Spotfire.Dxp.Data.DataColumns.

Returns void
Since
2.0

Contains

Contains(item: DataColumn): boolean
Checks if a Spotfire.Dxp.Data.DataColumn exists in the collection.
Parameters
- item: DataColumn
  The Spotfire.Dxp.Data.DataColumn to look for.
Returns boolean
True if item exists, false otherwise.

Since
2.0

CopyTo

CopyTo(array: TypedArray<DataColumn>, arrayIndex: number | Int32): void
Copies the included Spotfire.Dxp.Data.DataColumns to the given array.
Parameters
- array: TypedArray<DataColumn>
  The array to copy the Spotfire.Dxp.Data.DataColumns to.
- arrayIndex: number | Int32
  The zero-based index in array at which copying begins.
Returns void
Since
2.0

GetEnumerator

GetEnumerator(): System.Collections.Generic.IEnumerator<DataColumn>
Gets an enumerator.

Returns System.Collections.Generic.IEnumerator<DataColumn>
The enumerator

Since
2.0

Remove

Remove(item: DataColumn): boolean
Removes a Spotfire.Dxp.Data.DataColumn from the collection.
Parameters
- item: DataColumn
  The Spotfire.Dxp.Data.DataColumn to remove.
Returns boolean
True if successful, false otherwise.

Since
2.0

ReplaceAll

ReplaceAll(
columns: OrExplicit<System.Collections.Generic.IEnumerable<DataColumn>>,
): void
Replaces all current Spotfire.Dxp.Data.DataColumns, if any, with the given columns.
Parameters
- columns: OrExplicit<System.Collections.Generic.IEnumerable<DataColumn>>
  The Spotfire.Dxp.Data.DataColumns to replace with.
Returns void
Since
2.0