Class DataColumnCollection

[iterator]

• [iterator](): Iterator<DataColumn, any, undefined>

• Returns Iterator<DataColumn, any, undefined>

ReadonlyItem

Count

• get Count(): number

• Gets the number of columns in the collection.

  Returns number

  Since

  2.0

AddCalculatedColumn

• AddCalculatedColumn(name, expression): DataColumn

• Add a new calculated column.

  Parameters

  • name: string | String

    The name of the calculated column.
  • expression: string | String

    The expression describing how the calculated column should be calculated.

  Returns DataColumn

  The newly created calculated column.

  Since

  2.0

AddHierarchyColumn

• AddHierarchyColumn(name, hierarchyDefinition): DataColumn

• Add a new hierarchy column.

  Parameters

  • name: string | String

    The name of the hierarchy.
  • hierarchyDefinition: HierarchyDefinition

    The hierarchy definition.

  Returns DataColumn

  The newly created hierarchy column.

  Since

  2.0

AddTagsColumn

• AddTagsColumn(name, tagValues): DataColumn

• Add a new tags column.

  Parameters

  • name: string | String

    The name of the new tags column.
  • tagValues: OrExplicit<System.Collections.Generic.IList<string | 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 DataColumn

  The added tags column.

  Since

  2.0

Contains

• Contains(name): boolean

• Check if this collection contains a column with the given name.

  Parameters

  • name: string | 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

• Create a new unique column name from a suggestion. The suggested name is used if possible.

  Parameters

  • columnName: string | String

    The suggested column name.

  Returns string

  A column name which is unique in the collection.

  Since

  2.0

FindAll

• FindAll(match): System.Collections.Generic.IEnumerable<DataColumn>

• Find all columns satisfying the Predicate.

  Parameters

  • match: Predicate<DataColumn>

    The Predicate delegate that defines the conditions of the elements to search for.

  Returns System.Collections.Generic.IEnumerable<DataColumn>

  The columns satisfying the Predicate.

  Since

  2.0

• FindAll(searchPattern): System.Collections.Generic.IEnumerable<DataColumn>

• Find all columns which matches the given search pattern. For search syntax see Spotfire user manual.

  Parameters

  • searchPattern: string | String

    The search pattern.

  Returns System.Collections.Generic.IEnumerable<DataColumn>

  The columns which matches the search pattern.

  Since

  2.0

GetEnumerator

• GetEnumerator(): System.Collections.Generic.IEnumerator<DataColumn>

• Returns an enumerator that iterates through the collection.

  Returns System.Collections.Generic.IEnumerator<DataColumn>

  A System.Collections.Generic.IEnumerator that can be used to iterate through the collection.

  Since

  2.0

IsValidName

• IsValidName(columnName): boolean

• Check if the suggested column name is a valid unique name in the collection.

  Parameters

  • columnName: string | 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): void

• Remove the column from this collection.

  Parameters

  • dataColumn: DataColumn

    The column to remove.

  Returns void

  Since

  2.0

• Remove(dataColumns): void

• Remove columns from this collection.

  Parameters

  • dataColumns: OrExplicit<System.Collections.Generic.IEnumerable<DataColumn>>

    The columns to remove.

  Returns void

  Since

  2.0

• Remove(name): void

• Remove the column with the given name.

  Parameters

  • name: string | String

    The name of the column to remove.

  Returns void

  Since

  2.0

• Remove(names): void

• Remove the columns with the given names.

  Parameters

  • names: OrExplicit<System.Collections.Generic.IEnumerable<string | String>>

    The names of the columns to remove.

  Returns void

  Since

  2.0

TryGetValue

• TryGetValue(name, dataColumn): boolean

• Try to get a column with a given name.

  Parameters

  • name: string | String

    The name of the column.
  • dataColumn: OutParam<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