Class ColumnReplacementCollection

Represents a collection of columns to replace.

Since

2.0

Hierarchy (view full)

Implements

Methods

Cast Equals GetHashCode ToString TryCast [iterator] Equals

Default capability

Item Count IsReadOnly Add Clear Contains CopyTo GetEnumerator IndexOf Insert Remove RemoveAt

Methods

Cast

  • Cast<T1, T2>(this, type): 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

    Returns T1

Equals

  • Equals(obj): 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.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

TryCast

  • TryCast<T1, T2>(this, type): 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

    Returns null | T1

[iterator]

StaticEquals

  • Equals(objA, objB): 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.

Default capability

ReadonlyItem

Item: PropertyGet<number | Int32, ColumnReplacement> & PropertySet<number | Int32, ColumnReplacement>

Gets or sets the element at the specified index.

Param: index

The zero-based index of the element to get or set.

Returns

The element at the specified index.

Since

2.0

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

    Since

    2.0

  • Add(expression, selection, formatter): 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

    Since

    2.0

  • Add(nameExpression, expression, selection): 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

    Since

    2.0

  • Add(nameExpression, expression, selection, formatter): 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

    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

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

IndexOf

  • IndexOf(item): number

  • Returns the index of the item.

    Parameters

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

      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

    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

Settings

Member Visibility

On This Page

Methods
Default capability