About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Class ColumnRemovalCollection

Represents a collection of columns to remove.

Since

2.0

Hierarchy (view full)

Spotfire.Object
- ColumnRemovalCollection

Index

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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from Object.Cast

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.

Inherited from Object.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from Object.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from Object.ToString

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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from Object.TryCast

[iterator]

[iterator](): Iterator<ColumnRemoval, any, undefined>
Returns Iterator<ColumnRemoval, any, undefined>

`Static`Equals

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.

Inherited from Object.Equals

Default capability

`Readonly`Item

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

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(columnSelection): ColumnRemoval
Adds a selection of columns to remove.
Parameters
- columnSelection: ColumnSelection
  Represents the columns to remove.
Returns ColumnRemoval
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: ColumnRemoval
  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<ColumnRemoval>
  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<ColumnRemoval>
Returns an enumerator that iterates through a collection.

Returns System.Collections.Generic.IEnumerator<ColumnRemoval>
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: ColumnRemoval
  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: ColumnRemoval
  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: ColumnRemoval
  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