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

Class TableColumn

Represents a column visible in a table plot.

Since

2.0

Hierarchy (View Summary)

Spotfire.Object
- TableColumn

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

DataColumn Name ValueRendererSettings VirtualColumn Width

Methods

Cast

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

`Static`Equals

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

DataColumn

get DataColumn(): null | DataColumn
Gets the Spotfire.Dxp.Application.Visuals.TableColumn.DataColumn associated with this object. This property is null for virtual columns.

Returns null | DataColumn
Since
2.0

Name

get Name(): string
The name of the column.

Returns string
Since
2.0

ValueRendererSettings

get ValueRendererSettings(): ValueRendererSettings
Gets the column's value renderer model/settings.

Returns ValueRendererSettings
Since
2.0

VirtualColumn

get VirtualColumn(): null | VirtualColumn
Gets the Spotfire.Dxp.Application.Visuals.TableColumn.VirtualColumn associated with this object. This property is null if this table column is based on a Spotfire.Dxp.Application.Visuals.TableColumn.DataColumn.

Returns null | VirtualColumn
Since
2.0

Width

get Width(): number
Gets or sets the width.

Returns number
Since
2.0
set Width(value: number): void
Parameters
- value: number
Returns void