Class ColumnAdditionCollection

[iterator]

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

• Returns Iterator<ColumnAddition, any, undefined>

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): ColumnAddition

• Adds a column computed from the expression.

  Parameters

  • expression: string | String

    The expression that defines the column.

  Returns ColumnAddition

  The newly created Spotfire.Dxp.Data.Transformations.ColumnAddition.

  Since

  2.0

• Add(columnNameExpression, expression): ColumnAddition

• Adds a column computed from the expression.

  Parameters

  • columnNameExpression: string | String

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

    The expression used to compute the column.

  Returns ColumnAddition

  The newly created Spotfire.Dxp.Data.Transformations.ColumnAddition.

  Since

  2.0

• Add(expression, formatter): ColumnAddition

• Adds a column computed from the expression.

  Parameters

  • expression: string | String

    The expression that defines the column.
  • formatter: IDataFormatter

    The formatter to use for the resulting column.

  Returns ColumnAddition

  The newly created Spotfire.Dxp.Data.Transformations.ColumnAddition.

  Since

  2.0

• Add(columnNameExpression, expression, formatter): ColumnAddition

• Adds a column computed from the expression.

  Parameters

  • columnNameExpression: string | String

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

    The expression used to compute the column.
  • formatter: IDataFormatter

    The formatter used by the resulting column.

  Returns ColumnAddition

  The newly created Spotfire.Dxp.Data.Transformations.ColumnAddition.

  Since

  2.0

Clear

• Clear(): void

• Clears the collection.

  Returns void

  Since

  2.0

Contains

• Contains(item): boolean

• Determines whether the collection contains a specific value.

  Parameters

  • item: ColumnAddition

    The item to look for.

  Returns boolean

  True if item was found, false otherwise.

  Since

  2.0

CopyTo

• CopyTo(array, arrayIndex): void

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

  Parameters

  • array: TypedArray<ColumnAddition>

    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 the Array, at which to begin copying.

  Returns void

  Since

  2.0

GetEnumerator

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

• Returns an enumerator that iterates through a collection.

  Returns System.Collections.Generic.IEnumerator<ColumnAddition>

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

  Since

  2.0

IndexOf

• IndexOf(item): number

• Returns the index of the item.

  Parameters

  • item: ColumnAddition

    The item to look for.

  Returns number

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

  Since

  2.0

Insert

• Insert(index, item): void

• Inserts an item at the specified index.

  Parameters

  • index: number | Int32

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

    The object to insert.

  Returns void

  Since

  2.0

Remove

• Remove(item): boolean

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

  Parameters

  • item: ColumnAddition

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