Class ColumnReplacementCollection

[iterator]

• "[iterator]"(): Iterator<ColumnReplacement>

  Returns Iterator<ColumnReplacement>

ReadonlyItem

Count

• get Count(): number

  The number of items in the collection.

  Returns number

  Since

  2.0

IsReadOnly

• get IsReadOnly(): boolean

  Gets a value indicating whether the collection is read-only.

  Returns boolean

  Since

  2.0

Add

• Add(expression: string | String, selection: ColumnSelection): ColumnReplacement

  Replace the columns in selection with one created from expression.

  Parameters

  • expression: string | String

    The expression used to compute the column.

  • selection: ColumnSelection

    The columns to replace.

  Returns ColumnReplacement

  Remark

  Use Spotfire.Dxp.Data.Transformations.ExpressionTransformation.ColumnNameSymbol in the expression if you wish to refer to the current column in selection. If expression does not contain an as-clause, then the old column name will be used. If selection contains more than one column, the resulting names will be uniquified.

  Since

  2.0

• Add(
      expression: string | String,
      selection: ColumnSelection,
      formatter: IDataFormatter,
  ): ColumnReplacement

  Replace the columns in selection with one created from expression.

  Parameters

  • expression: string | String

    The expression used to compute the column.

  • selection: ColumnSelection

    The columns to replace.

  • formatter: IDataFormatter

    The formatter to use for the resulting column.

  Returns ColumnReplacement

  Remark

  Use Spotfire.Dxp.Data.Transformations.ExpressionTransformation.ColumnNameSymbol in the expression if you wish to refer to the current column in selection. If expression does not contain an as-clause, then the old column name will be used. If selection contains more than one column, the resulting names will be uniquified.

  Since

  2.0

• Add(
      nameExpression: string | String,
      expression: string | String,
      selection: ColumnSelection,
  ): ColumnReplacement

  Replace the columns in selection with one created from expression.

  Parameters

  • nameExpression: string | String

    The name of the column.

  • expression: string | String

    The expression used to compute the column.

  • selection: ColumnSelection

    The columns to replace.

  Returns ColumnReplacement

  Remark

  Use Spotfire.Dxp.Data.Transformations.ExpressionTransformation.ColumnNameSymbol in the name or expression if you wish to refer to the current column in selection. If selection contains more than one column the resulting names will be uniquified.

  Since

  2.0

• Add(
      nameExpression: string | String,
      expression: string | String,
      selection: ColumnSelection,
      formatter: IDataFormatter,
  ): ColumnReplacement

  Replace the columns in selection with one created from expression.

  Parameters

  • nameExpression: string | String

    The name of the column.

  • expression: string | String

    The expression used to compute the column.

  • selection: ColumnSelection

    The columns to replace.

  • formatter: IDataFormatter

    The formatter to use for the resulting column.

  Returns ColumnReplacement

  Remark

  Use Spotfire.Dxp.Data.Transformations.ExpressionTransformation.ColumnNameSymbol in the name or expression if you wish to refer to the current column in selection. If selection contains more than one column the resulting names will be uniquified.

  Since

  2.0

Clear

• Clear(): void

  Clears the collection.

  Returns void

  Since

  2.0

Contains

• Contains(item: ColumnReplacement): boolean

  Determines whether the collection contains a specific value.

  Parameters

  • item: ColumnReplacement

    The item to look for.

  Returns boolean

  True if item was found, false otherwise.

  Since

  2.0

CopyTo

• CopyTo(array: TypedArray<ColumnReplacement>, arrayIndex: number | Int32): void

  Copies the elements of the collection to an Array, starting at a particular Array index.

  Parameters

  • array: TypedArray<ColumnReplacement>

    The one-dimensional Array that is the destination of the elements copied from this collection. The Array must have zero-based indexing.

  • arrayIndex: number | Int32

    The zero-based index in array at which copying begins.

  Returns void

  Since

  2.0

GetEnumerator

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

  Returns an enumerator that iterates through a collection.

  Returns System.Collections.Generic.IEnumerator<ColumnReplacement>

  An IEnumerator object that can be used to iterate through the collection.

  Since

  2.0

IndexOf

• IndexOf(item: ColumnReplacement): number

  Returns the index of the item.

  Parameters

  • item: ColumnReplacement

    The item to look for.

  Returns number

  The index of the item, if it was found. Otherwise -1.

  Since

  2.0

Insert

• Insert(index: number | Int32, item: ColumnReplacement): void

  Inserts an item at the specified index.

  Parameters

  • index: number | Int32

    The zero-based index at which item should be inserted.

  • item: ColumnReplacement

    The object to insert.

  Returns void

  Since

  2.0

Remove

• Remove(item: ColumnReplacement): boolean

  Removes the first occurrence of a specific object from the collection.

  Parameters

  • item: ColumnReplacement

    The object to remove from the collection.

  Returns boolean

  True if item was successfully removed from the collection; otherwise, false. This method also returns false if item is not found in the original collection.

  Since

  2.0

RemoveAt

• RemoveAt(index: number | Int32): void

  Removes the item at the specified index.

  Parameters

  • index: number | Int32

    The zero-based index of the item to remove.

  Returns void

  Since

  2.0