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

Class StdfValueType

Represents the type of a data value or metadata property in STDF.

Since

2.1

Hierarchy (View Summary)

Spotfire.Object
- StdfValueType

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>): T1 | null
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 T1 | null
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: Spotfire.Dxp.Data.Formats.Stdf.StdfValueType

The Binary value type.

Since

2.1

`Static` `Readonly`Bool

Bool: Spotfire.Dxp.Data.Formats.Stdf.StdfValueType

The Boolean value type.

Since

2.1

`Static` `Readonly`Date

Date: Spotfire.Dxp.Data.Formats.Stdf.StdfValueType

The Date value type.

Since

2.1

`Static` `Readonly`DateTime

DateTime: Spotfire.Dxp.Data.Formats.Stdf.StdfValueType

The DateTime value type.

Since

2.1

`Static` `Readonly`Decimal

Decimal: Spotfire.Dxp.Data.Formats.Stdf.StdfValueType

The Decimal value type.

Since

2.1

`Static` `Readonly`Double

Double: Spotfire.Dxp.Data.Formats.Stdf.StdfValueType

The Double value type.

Since

2.1

`Static` `Readonly`Float

Float: Spotfire.Dxp.Data.Formats.Stdf.StdfValueType

The Float value type.

Since

2.1

`Static` `Readonly`Int

Int: Spotfire.Dxp.Data.Formats.Stdf.StdfValueType

The Integer value type.

Since

2.1

`Static` `Readonly`Long

Long: Spotfire.Dxp.Data.Formats.Stdf.StdfValueType

The Long integer value type.

Since

2.1

`Static` `Readonly`String

String: Spotfire.Dxp.Data.Formats.Stdf.StdfValueType

The String value type.

Since

2.1

`Static` `Readonly`Time

Time: Spotfire.Dxp.Data.Formats.Stdf.StdfValueType

The Time value type.

Since

2.1

`Static` `Readonly`TimeSpan

TimeSpan: Spotfire.Dxp.Data.Formats.Stdf.StdfValueType

The TimeSpan value type.

Since

2.1

DefaultValue

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

Returns unknown
Since
2.1

IsArrayType

get IsArrayType(): boolean
Gets a value indicating whether this is an array type.

Returns boolean
Since
2.1

IsSimpleType

get IsSimpleType(): boolean
Gets a value indicating whether this is a simple value type.

Returns boolean
Since
2.1

IsSupportedInStdfVersionOne

get IsSupportedInStdfVersionOne(): boolean
Gets a value indicating whether this value type was supported in STDF 1.0.

Returns boolean
Since
2.1

NullValue

get NullValue(): unknown
Gets an object representing a null value.

Returns unknown
Since
2.1

RuntimeType

get RuntimeType(): System.Type
Gets the runtime type corresponding to this StdfValueType instance.

Returns System.Type
Since
2.1

TypeId

get TypeId(): Spotfire.Dxp.Data.Formats.Stdf.StdfValueTypeId
Gets the type identifier of this value type.

Returns Spotfire.Dxp.Data.Formats.Stdf.StdfValueTypeId
Since
2.1

TypeName

get TypeName(): string
Gets the name of this value type in the latest version of the format.

Returns string
Since
2.1

TypeNameInStdfVersionOne

get TypeNameInStdfVersionOne(): string
Gets the name of this value type used in version 1.0 of the format.

Returns string
Since
2.1

ErrorValue

ErrorValue(error: string | System.String): unknown
Returns an object representing an error value.
Parameters
- error: string | System.String
  The specific error string.
Returns unknown
An object representing an error value.

Since
2.1

FormatValue

FormatValue(value: any): string
Returns the STDF string encoding of a given value.
Parameters
- value: any
  The value to be formatted.
Returns string
A formatted string, not including the terminating semicolon.

Since
2.1

GetErrorString

GetErrorString(value: any): string
Gets the error string from the error value held in value.
Parameters
- value: any
  The error value.
Returns string
The error string.

Since
2.1

IsErrorValue

IsErrorValue(value: any): boolean
Determines if value is an error value.
Parameters
- value: any
  The object to examine.
Returns boolean
true if the object is an error value, false otherwise.

Since
2.1

IsInvalidValue

IsInvalidValue(value: any): boolean
Determines if value is an invalid value (null or error).
Parameters
- value: any
  The object to examine.
Returns boolean
true if the object is a null value or an error value; otherwise, false.

Since
2.1

IsNullValue

IsNullValue(value: any): boolean
Determines if value is an null/missing value.
Parameters
- value: any
  The object to examine.
Returns boolean
true if the object is a null value; otherwise, false.

Since
2.1

TryParseValue

TryParseValue(
s: string | System.String,
value: OutParam<System.Object>,
): boolean
Tries to create a value of this type from a text string.
Parameters
- s: string | System.String
  The text string.
- value: OutParam<System.Object>
  The parsed value.
Returns boolean
True if the value was successfully parsed; otherwise, false.

Since
2.1

`Static`FromRuntimeType

FromRuntimeType(type: System.Type): Spotfire.Dxp.Data.Formats.Stdf.StdfValueType
Constructs a StdfValueType from a System.Type.
Parameters
- type: System.Type
  The type object.
Returns Spotfire.Dxp.Data.Formats.Stdf.StdfValueType
A corresponding StdfValueType instance.

Remark
An StdfValueType with Spotfire.Dxp.Data.Formats.Stdf.StdfValueTypeId.UnknownType is returned for unknown types.

Since
2.1

`Static`GetValueType

GetValueType(
typeName: string | System.String,
): Spotfire.Dxp.Data.Formats.Stdf.StdfValueType
Gets a StdfValueType from a string representation.
Parameters
- typeName: string | System.String
  The name of the value type.
Returns Spotfire.Dxp.Data.Formats.Stdf.StdfValueType
An StdfValueType instance.

Since
2.1

`Static`GetValueTypeFromId

GetValueTypeFromId(
typeId: Spotfire.Dxp.Data.Formats.Stdf.StdfValueTypeId,
): Spotfire.Dxp.Data.Formats.Stdf.StdfValueType
Gets a value type instance for a given type identifier.
Parameters
- typeId: Spotfire.Dxp.Data.Formats.Stdf.StdfValueTypeId
  The type identifier.
Returns Spotfire.Dxp.Data.Formats.Stdf.StdfValueType
A StdfValueType instance.

Since
2.1

`Static`IsArrayTypeId

IsArrayTypeId(typeId: Spotfire.Dxp.Data.Formats.Stdf.StdfValueTypeId): boolean
Gets a value indicating whether a given type identifier corresponds to an array type.
Parameters
- typeId: Spotfire.Dxp.Data.Formats.Stdf.StdfValueTypeId
  The type identifier.
Returns boolean
True for an array type; otherwise, false.

Since
2.1

`Static`IsSimpleTypeId

IsSimpleTypeId(typeId: Spotfire.Dxp.Data.Formats.Stdf.StdfValueTypeId): boolean
Gets a value indicating whether a given type identifier corresponds to a simple type.
Parameters
- typeId: Spotfire.Dxp.Data.Formats.Stdf.StdfValueTypeId
  The type identifier.
Returns boolean
True for a simple type; otherwise, false.

Since
2.1