Class DataColumnCollection

This is a collection of Spotfire.Dxp.Data.DataColumn columns in a Spotfire.Dxp.Data.DataTable. This class is used to retrieve columns and to add new columns.

Since

2.0

Hierarchy (View Summary)

Spotfire.Dxp.Framework.DocumentModel.DocumentNode
- DataColumnCollection

Methods

[iterator]

"[iterator]"(): Iterator<Spotfire.Dxp.Data.DataColumn>
Returns Iterator<Spotfire.Dxp.Data.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 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>): 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<string | System.String, Spotfire.Dxp.Data.DataColumn> & PropertyGet<
    number
    | System.Int32,
    Spotfire.Dxp.Data.DataColumn,
>

Get a column with a given index.

Param: index

The index of the column to retrieve.

Returns

The column at the given 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
Gets the number of columns in the 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

AddCalculatedColumn

AddCalculatedColumn(
name: string | System.String,
expression: string | System.String,
): Spotfire.Dxp.Data.DataColumn
Add a new calculated column.
Parameters
- name: string | System.String
  The name of the calculated column.
- expression: string | System.String
  The expression describing how the calculated column should be calculated.
Returns Spotfire.Dxp.Data.DataColumn
The newly created calculated column.

Since
2.0

AddHierarchyColumn

AddHierarchyColumn(
name: string | System.String,
hierarchyDefinition: Spotfire.Dxp.Data.HierarchyDefinition,
): Spotfire.Dxp.Data.DataColumn
Add a new hierarchy column.
Parameters
- name: string | System.String
  The name of the hierarchy.
- hierarchyDefinition: Spotfire.Dxp.Data.HierarchyDefinition
  The hierarchy definition.
Returns Spotfire.Dxp.Data.DataColumn
The newly created hierarchy column.

Since
2.0

AddTagsColumn

AddTagsColumn(
    name: string | System.String,
    tagValues: OrExplicit<
        System.Collections.Generic.IList<string | System.String>,
    >,
): Spotfire.Dxp.Data.DataColumn
Add a new tags column.
Parameters
- name: string | System.String
  The name of the new tags column.
- tagValues: OrExplicit<System.Collections.Generic.IList<string | System.String>>
  The initial list of tag values. The list cannot contain duplicates and if the empty string is not part of the list it will be added to the end. A string in the tag values collection cannot be longer than 150 characters.
Returns Spotfire.Dxp.Data.DataColumn
The added tags column.

Since
2.0

Contains

Contains(name: string | System.String): boolean
Check if this collection contains a column with the given name.
Parameters
- name: string | System.String
  The name of the column.
Returns boolean
True if a column with the given name exists in the collection, false otherwise.

Since
2.0

CreateUniqueName

CreateUniqueName(columnName: string | System.String): string
Create a new unique column name from a suggestion. The suggested name is used if possible.
Parameters
- columnName: string | System.String
  The suggested column name.
Returns string
A column name which is unique in the collection.

Since
2.0

FindAll

FindAll(
match: System.Predicate<Spotfire.Dxp.Data.DataColumn>,
): System.Collections.Generic.IEnumerable<Spotfire.Dxp.Data.DataColumn>
Find all columns satisfying the Predicate.
Parameters
- match: System.Predicate<Spotfire.Dxp.Data.DataColumn>
  The Predicate delegate that defines the conditions of the elements to search for.
Returns System.Collections.Generic.IEnumerable<Spotfire.Dxp.Data.DataColumn>
The columns satisfying the Predicate.

Since
2.0
FindAll(
searchPattern: string | System.String,
): System.Collections.Generic.IEnumerable<Spotfire.Dxp.Data.DataColumn>
Find all columns which matches the given search pattern. For search syntax see Spotfire user manual.
Parameters
- searchPattern: string | System.String
  The search pattern.
Returns System.Collections.Generic.IEnumerable<Spotfire.Dxp.Data.DataColumn>
The columns which matches the search pattern.

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

GetEnumerator

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

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

Since
2.0

IsValidName

IsValidName(columnName: string | System.String): boolean
Check if the suggested column name is a valid unique name in the collection.
Parameters
- columnName: string | System.String
  The suggested column name.
Returns boolean
True if the suggested name is a valid name for a new column in the collection, false otherwise.

Since
2.0

Remove

Remove(dataColumn: Spotfire.Dxp.Data.DataColumn): void
Remove the column from this collection.
Parameters
- dataColumn: Spotfire.Dxp.Data.DataColumn
  The column to remove.
Returns void
Since
2.0
Remove(
    dataColumns: OrExplicit<
        System.Collections.Generic.IEnumerable<Spotfire.Dxp.Data.DataColumn>,
    >,
): void
Remove columns from this collection.
Parameters
- dataColumns: OrExplicit<System.Collections.Generic.IEnumerable<Spotfire.Dxp.Data.DataColumn>>
  The columns to remove.
Returns void
Since
2.0
Remove(name: string | System.String): void
Remove the column with the given name.
Parameters
- name: string | System.String
  The name of the column to remove.
Returns void
Since
2.0
Remove(
    names: OrExplicit<
        System.Collections.Generic.IEnumerable<string | System.String>,
    >,
): void
Remove the columns with the given names.
Parameters
- names: OrExplicit<System.Collections.Generic.IEnumerable<string | System.String>>
  The names of the columns to remove.
Returns void
Since
2.0

TryGetValue

TryGetValue(
name: string | System.String,
dataColumn: OutParam<Spotfire.Dxp.Data.DataColumn>,
): boolean
Try to get a column with a given name.
Parameters
- name: string | System.String
  The name of the column.
- dataColumn: OutParam<Spotfire.Dxp.Data.DataColumn>
  The column will be assigned to this parameter if found.
Returns boolean
True if the column was found in the collection and assigned to dataColumn parameter, false otherwise.

Since
2.0

Class DataColumnCollection

Since

Hierarchy (View Summary)

Implements

Index

Methods

Default capability

Methods

[iterator]

Returns Iterator<Spotfire.Dxp.Data.DataColumn>

Cast

Type Parameters

Parameters

Returns T1

Equals

Parameters

Returns boolean

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

AddCalculatedColumn

Parameters

Returns Spotfire.Dxp.Data.DataColumn

Since

AddHierarchyColumn

Parameters

Returns Spotfire.Dxp.Data.DataColumn

Since

AddTagsColumn

Parameters

Returns Spotfire.Dxp.Data.DataColumn

Since

Contains

Parameters

Returns boolean

Since

CreateUniqueName

Parameters

Returns string

Since

FindAll

Parameters

Returns System.Collections.Generic.IEnumerable<Spotfire.Dxp.Data.DataColumn>

Since

Parameters

Returns System.Collections.Generic.IEnumerable<Spotfire.Dxp.Data.DataColumn>

Since

ForEachNodeInSubTree

Type Parameters

Parameters

Returns void

Since

GetEnumerator

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

Since

`Static`Equals

`Readonly`Item