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

Class DataColumnProperties

Represents a collection of the properties in a column.

Remark

This collection can be retrieved from a Spotfire.Dxp.Data.IDataColumn, Spotfire.Dxp.Data.DataColumn or Spotfire.Dxp.Data.DataRowReaderColumn.

Since

2.0

Hierarchy (View Summary)

Spotfire.Object
- DataColumnProperties

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

CalculatedExpression

get CalculatedExpression(): string
Gets the derived expression of the column. The calculated expression is the expression text after preprocessing the original expression (Spotfire.Dxp.Data.DataColumnProperties.Expression).

Returns string
Remark
Automatic column name changes, e.g., changing case of column names have also been applied to the calculated expression.

Since
2.0

ColumnType

get ColumnType(): DataColumnType
Gets or sets the column type of the column.

Returns DataColumnType
Since
2.0
set ColumnType(value: DataColumnType): void
Parameters
- value: DataColumnType
Returns void

Comparer

get Comparer(): System.Collections.IComparer
Gets or sets the value comparer of the column.

Returns System.Collections.IComparer
Since
2.0
set Comparer(value: System.Collections.IComparer): void
Parameters
- value: System.Collections.IComparer
Returns void

ContentType

get ContentType(): string
Gets or sets a more specific type of the data contained in a column of a certain DataType.

Returns string
Since
2.0
set ContentType(value: string): void
Parameters
- value: string
Returns void

DataType

get DataType(): DataType
Gets or sets the data type of the column.

Returns DataType
Since
2.0
set DataType(value: DataType): void
Parameters
- value: DataType
Returns void

Description

get Description(): string
Gets or sets a textual description of the column.

Returns string
Since
2.0
set Description(value: string): void
Parameters
- value: string
Returns void

Expression

get Expression(): string
Gets the defining expression of the column.

Returns string
Since
2.0

ExternalId

get ExternalId(): string
Gets or sets the external identifier of the column.

Returns string
Remark
This is an external identifier of some sort that identifies the column.

Since
2.0
set ExternalId(value: string): void
Parameters
- value: string
Returns void

ExternalName

get ExternalName(): string
Gets or sets the external name of the column.

Returns string
Remark
The external name is the name that the column originally had in the original Spotfire.Dxp.Data.DataSource.

Since
2.0
set ExternalName(value: string): void
Parameters
- value: string
Returns void

Formatter

get Formatter(): IDataFormatter
Gets or sets the value formatter of the column.

Returns IDataFormatter
Remark
The Spotfire.Dxp.Data.Formatters.IDataFormatter return is read-only. If modifications to the formatter's properties are required then first clone the formatter and then set the new formatter.

Since
2.0
set Formatter(value: IDataFormatter): void
Parameters
- value: IDataFormatter
Returns void

IsValid

get IsValid(): boolean
Gets a value indicating whether the column has valid values: true if the column has valid values; otherwise, false.

Returns boolean
Since
2.0

Name

get Name(): string
Gets or sets the name of the column.

Returns string
Since
2.0
set Name(value: string): void
Parameters
- value: string
Returns void

PreferredAggregationMethod

get PreferredAggregationMethod(): null | string
Gets or sets the preferred aggregation method. If set to the name of an aggregation method, for instance "sum" or "avg", this method is used by plot heuristics when creating aggregated expressions from this column.

Returns null | string
Since
2.0
set PreferredAggregationMethod(value: null | string): void
Parameters
- value: null | string
Returns void

PropertyNames

get PropertyNames(): System.Collections.Generic.IEnumerable<string>
Gets an enumeration of the names of all the properties in the column.

Returns System.Collections.Generic.IEnumerable<string>
Since
2.0

Get

Get(propertyName: string | String): unknown
Gets the value of a named property. Binary data properties are returned as UInt8Array.
Parameters
- propertyName: string | String
  The property name.
Returns unknown
The value of the property.

Since
2.0

PropertyExists

PropertyExists(name: string | String): boolean
Checks if a property with a given name exists.
Parameters
- name: string | String
  The name of the property.
Returns boolean
true if the property exists; otherwise, false.

Remark
The property value may still be undefined even if it exists.

Since
2.0

Set

Set(propertyName: string | String, value: any): void
Sets the value of a named property. Setting a binary data property expects the value to be an UInt8Array.
Parameters
- propertyName: string | String
  The property name.
- value: any
  The value to set.
Returns void
Since
2.0

SetCustomSortOrder

SetCustomSortOrder(
values: any[] | OrExplicit<System.Collections.IEnumerable>,
): void
Sets a custom sort order. The values in values must be of the same type as the values in the column. Column values not present in values will be sorted last.
Parameters
- values: any[] | OrExplicit<System.Collections.IEnumerable>
  The values in their custom order.
Returns void
Since
2.0

TryGetCustomSortOrder

TryGetCustomSortOrder(
values: OutParam<OrExplicit<System.Collections.IList>>,
): boolean
Tries to get the custom sort order of the column, if any.
Parameters
- values: OutParam<OrExplicit<System.Collections.IList>>
  The sort order.
Returns boolean
True if the column has a custom sort order; otherwise false.

Since
2.0