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

Class DataTableProperties

The collection of the properties (metadata) of a Spotfire.Dxp.Data.DataTable.

Since

2.0

Hierarchy (view full)

Spotfire.Object
- DataTableProperties

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Color Get HasPropertyValue Set

Methods

Cast

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

Color

get Color(): Color
Gets or sets the color of the data table. Note that this color is the same for all the related tables.

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

Get

Get(propertyName): 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

HasPropertyValue

HasPropertyValue(name): boolean
Gets a value indicating whether the property has a value or not.
Parameters
- name: string | String
  The name of the property.
Returns boolean
True if the property has a value, false otherwise.

Since
2.0

Set

Set(propertyName, value): 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