Class DataType

This class contains information about a Spotfire data type and the properties of that data type. This is an enumeration class with one static instance for each of the supported data types.

Since

2.0

Hierarchy (View Summary)

Spotfire.Object
- DataType

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

`Static` `Readonly`Binary

Binary: DataType

Binary type.

Since

2.0

`Static` `Readonly`Boolean

Boolean: DataType

Boolean type.

Since

2.0

`Static` `Readonly`Currency

Currency: DataType

Currency type.

Since

2.0

`Static` `Readonly`Date

Date: DataType

Date type.

Since

2.0

`Static` `Readonly`DateTime

DateTime: DataType

DateTime type (both date and a time stamp).

Since

2.0

`Static` `Readonly`Integer

Integer: DataType

Integer type.

Since

2.0

`Static` `Readonly`LongInteger

LongInteger: DataType

Long integer type.

Since

2.0

`Static` `Readonly`Real

Real: DataType

Real (double) type.

Since

2.0

`Static` `Readonly`SingleReal

SingleReal: DataType

Short Real (float) type.

Since

2.0

`Static` `Readonly`String

String: DataType

String type.

Since

2.0

`Static` `Readonly`Time

Time: DataType

Timestamp type (not including date).

Since

2.0

`Static` `Readonly`TimeSpan

TimeSpan: DataType

Time span type.

Since

2.0

`Static` `Readonly`Undefined

Undefined: DataType

Undefined type. This is not a real data type but can be used in some places when any type is acceptable.

Since

2.0

DefaultComparer

get DefaultComparer(): System.Collections.IComparer
Gets the default comparer for this DataType.

Returns System.Collections.IComparer
Since
2.0

DefaultValue

get DefaultValue(): unknown
Gets the default value for the underlying type.

Returns unknown
Since
2.0

Formatter

get Formatter(): IDataFormatter
Gets a default, user localized, read-only formatter for this data type.

Returns IDataFormatter
Since
2.0

InvariantFormatter

get InvariantFormatter(): DataFormatterBase
Gets a read-only formatter for this data type that does invariant formatting. This formatting is independent of localization and uses System.Globalization.CultureInfo.InvariantCulture.

Returns DataFormatterBase
Since
2.0

IsNumeric

get IsNumeric(): boolean
Gets a value indicating whether the data type is numeric or not, that is, Integer, Currency, Real, LongInteger or SingleReal

Returns boolean
Since
2.0

IsSimple

get IsSimple(): boolean
Gets a value indicating whether the data type is considered simple or not. E.g. String and int (etc) are simple, Binary is not.

Returns boolean
Since
2.0

IsTime

get IsTime(): boolean
Gets a value indicating whether the data type represents time or not, that is, Date, Time or DateTime.

Returns boolean
Since
2.0

Name

get Name(): string
Gets the type name.

Returns string
Since
2.0

NullValue

get NullValue(): unknown
Gets a null (empty) value for the underlying type.

Returns unknown
Since
2.0

RepresentationType

get RepresentationType(): Type
Gets the representation type of the data type. This is the .NET type that values of this data type are stored as.

Returns Type
Since
2.0

`Static`AvailableDataTypes

get AvailableDataTypes(): System.Collections.Generic.IList<DataType>
Gets the available data types.

Returns System.Collections.Generic.IList<DataType>
Since
2.0

CreateCultureSpecificFormatter

CreateCultureSpecificFormatter(cultureName: string | String): DataFormatterBase
Creates a culture specific formatter for this data type.

A formatter may configured by casting it to the corresponding formatter class. For numeric types (DataType.Integer, DataType.Long and DataType.Real) the formatter class is Spotfire.Dxp.Data.Formatters.NumberFormatter. For date/time types (DataType.Date, DataType.Time and DataType.DateTime it is Spotfire.Dxp.Data.Formatters.DateTimeFormatter. The formatter class for DataType.String is Spotfire.Dxp.Data.Formatters.StringFormatter.
Parameters
- cultureName: string | String
  The name of the culture for this formatter.
Returns DataFormatterBase
A formatter.

Remark
Formatters created with this method will always have a fixed culture. Use Spotfire.Dxp.Data.DataType.CreateLocalizedFormatter instead, when the formatting should be dynamically adapted to the culture of the current thread.

Since
2.0

CreateLocalizedFormatter

CreateLocalizedFormatter(): IDataFormatter
Creates a user localized formatter for this data type.

A formatter may configured by casting it to the corresponding formatter class. For numeric types (DataType.Integer, DataType.Long and DataType.Real) the formatter class is Spotfire.Dxp.Data.Formatters.NumberFormatter. For date/time types (DataType.Date, DataType.Time and DataType.DateTime it is Spotfire.Dxp.Data.Formatters.DateTimeFormatter. The formatter class for DataType.String is Spotfire.Dxp.Data.Formatters.StringFormatter.

Returns IDataFormatter
A formatter.

Remark
The formatter will use the CultureInfo of the current thread, including any user-selected culture settings.

Since
2.0

Validate

Validate(value: any, error: OutParam<String>): boolean
Validates a value with the representation type.
Parameters
- value: any
  The value to validate.
- error: OutParam<String>
  Contains an error description if the result was false.
Returns boolean
true if the value is valid; otherwise false.

Since
2.0

`Static`FromExternalDataType

FromExternalDataType(type: ExternalDataType): DataType
Converts a DataSourceDataType to a DataType.
Parameters
- type: ExternalDataType
  The DataSourceDataType-type.
Returns DataType
The DataType.

Since
2.0

`Static`FromImportType

FromImportType(type: Type): DataType
Converts the type from an import source to the DataType used in the Data Manager.
Parameters
- type: Type
  The import source .Net-type.
Returns DataType
The converted DataType, DataType.Undefined if no conversion was possible.

Remark
Note that this is not always possible to correctly determine the Spotfire.Dxp.Data.DataType from type since all the date and time types share the same representation type.

Since
2.0

`Static`FromName

FromName(name: string | String): DataType
Looks up a data type by name.
Parameters
- name: string | String
  The type name.
Returns DataType
The data type.

Since
2.0

`Static`GetDataType

GetDataType(name: string | String): DataType
Gets the DataType with the given name.
Parameters
- name: string | String
  Name representation for a DataType.
Returns DataType
The DataType with the given name, or Spotfire.Dxp.Data.DataType.Undefined if corresponding type not found.

Since
2.0

`Static`TryConvertFromNumeric

TryConvertFromNumeric(
    numericValue: number | Double,
    value: OutParam<System.Object>,
    dataType: DataType,
): boolean
Converts a value from a numeric (double) representation, to the value representation defined by dataType.
Parameters
- numericValue: number | Double
  A numeric value.
- value: OutParam<System.Object>
  The converted value.
- dataType: DataType
  A data type that determines the type of the converted value.
Returns boolean
true if conversion was possible; otherwise false.

Since
2.0

`Static`TryConvertToNumeric

TryConvertToNumeric(value: any, numericValue: OutParam<Double>): boolean
Converts a value to a numeric (double) representation.
Parameters
- value: any
  A value of any type.
- numericValue: OutParam<Double>
  The converted numeric value.
Returns boolean
true if conversion was possible; otherwise false.

Since
2.0

Class DataType

Since

Hierarchy (View Summary)

Index

Methods

Default capability

Methods

Cast

Type Parameters

Parameters

Returns T1

Equals

Parameters

Returns boolean

GetHashCode

Returns number

ToString

Returns string

TryCast

Type Parameters

Parameters

Returns null | T1

StaticEquals

Parameters

Returns boolean

Default capability

Static ReadonlyBinary

Since

Static ReadonlyBoolean

Since

Static ReadonlyCurrency

Since

Static ReadonlyDate

Since

Static ReadonlyDateTime

Since

Static ReadonlyInteger

Since

Static ReadonlyLongInteger

Since

Static ReadonlyReal

Since

Static ReadonlySingleReal

Since

Static ReadonlyString

Since

Static ReadonlyTime

Since

Static ReadonlyTimeSpan

Since

Static ReadonlyUndefined

Since

DefaultComparer

Returns System.Collections.IComparer

Since

DefaultValue

Returns unknown

Since

Formatter

Returns IDataFormatter

Since

InvariantFormatter

Returns DataFormatterBase

Since

IsNumeric

Returns boolean

Since

IsSimple

Returns boolean

Since

IsTime

Returns boolean

Since

Name

Returns string

Since

NullValue

Returns unknown

Since

RepresentationType

`Static`Equals

`Static` `Readonly`Binary

`Static` `Readonly`Boolean

`Static` `Readonly`Currency

`Static` `Readonly`Date

`Static` `Readonly`DateTime

`Static` `Readonly`Integer

`Static` `Readonly`LongInteger

`Static` `Readonly`Real

`Static` `Readonly`SingleReal

`Static` `Readonly`String

`Static` `Readonly`Time

`Static` `Readonly`TimeSpan

`Static` `Readonly`Undefined

`Static`AvailableDataTypes

`Static`FromExternalDataType

`Static`FromImportType

`Static`FromName

`Static`GetDataType

`Static`TryConvertFromNumeric

`Static`TryConvertToNumeric