Class DataColumnSignature

A data column signature is used to identify matching columns in the context of linked data. It contains certain key properties, such as the name, data type, and external id of a previously known column.

Since

2.0

Hierarchy (View Summary)

Spotfire.Object
- DataColumnSignature

Index

Methods

Cast GetHashCode ToString TryCast Equals

Default capability

constructor ContentType DataType ExternalIdentifier ExternalName Name Equals

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

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

constructor

new DataColumnSignature(column: IDataColumn): DataColumnSignature
Creates a column signature for a given column.
Parameters
- column: IDataColumn
  The column.
Returns DataColumnSignature
Since
2.0

Overrides Object.constructor
new DataColumnSignature(
dataRowReaderColumn: DataRowReaderColumn,
): DataColumnSignature
Creates a column signature for a column retrieved from a Spotfire.Dxp.Data.DataRowReader.
Parameters
- dataRowReaderColumn: DataRowReaderColumn
  The data row reader column.
Returns DataColumnSignature
Since
2.0

Overrides Object.constructor
new DataColumnSignature(
properties: Spotfire.Dxp.Data.DataColumnProperties,
): DataColumnSignature
Creates a column signature from a properties collection for a column.
Parameters
- properties: Spotfire.Dxp.Data.DataColumnProperties
  The properties collection.
Returns DataColumnSignature
Remark
At least the name property must be set.

Since
2.0

Overrides Object.constructor
new DataColumnSignature(
name: string | String,
dataType: DataType,
): DataColumnSignature
Creates a column signature from the name and data type of column.
Parameters
- name: string | String
  The name of the column.
- dataType: DataType
  The data type of the column.
Returns DataColumnSignature
Since
2.0

Overrides Object.constructor

ContentType

get ContentType(): string
The content type of the column.

Returns string
Since
2.0

DataType

get DataType(): DataType
The data type of the column.

Returns DataType
Since
2.0

ExternalIdentifier

get ExternalIdentifier(): string
The external identifier of the column, may be null. The external ID is typically a GUID that comes from IS.

Returns string
Since
2.0

ExternalName

get ExternalName(): string
The external name of the column, may be null. The external name is the name as it was originally named in the data source.

Returns string
Since
2.0

Name

get Name(): string
The name of the column, may not be null.

Returns string
Since
2.0

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.

Overrides Object.Equals
Equals(other: DataColumnSignature): boolean
Compares a signature instance to another for equality.
Parameters
- other: DataColumnSignature
  Another column signature instance.
Returns boolean
True if the signatures are equal; otherwise, false.

Remark
This method does not perform a match but checks if the signature are exactly equal. For example if two signature are equal but one has an external name and the other does not then they are not considered equal.

Since
2.0

Overrides Object.Equals

Class DataColumnSignature

Since

Hierarchy (View Summary)

Index

Methods

Default capability

Methods

Cast

Type Parameters

Parameters

Returns T1

GetHashCode

Returns number

ToString

Returns string

TryCast

Type Parameters

Parameters

Returns null | T1

StaticEquals

Parameters

Returns boolean

Default capability

constructor

Parameters

Returns DataColumnSignature

Since

Parameters

Returns DataColumnSignature

Since

Parameters

Returns DataColumnSignature

Remark

Since

Parameters

Returns DataColumnSignature

Since

ContentType

Returns string

Since

DataType

Returns DataType

Since

ExternalIdentifier

Returns string

Since

ExternalName

Returns string

Since

Name

Returns string

Since

Equals

Parameters

Returns boolean

Parameters

Returns boolean

Remark

Since

Settings

On This Page

`Static`Equals