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

Class ResultProperties

Represents the metadata about the result from a data source, transformation or calculation. These properties are used to set properties on the resulting data table.

Since

2.0

Hierarchy (view full)

Spotfire.Object
- ResultProperties

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

constructor PropertyNames GetProperty HasPropertyValue Propagate PropertyExists SetProperty

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

constructor

new ResultProperties(): ResultProperties
Initializes a new instance of the Spotfire.Dxp.Data.ResultProperties class. Creates an empty result properties collection.

Returns ResultProperties
Since
2.0

Overrides Object.constructor

PropertyNames

get PropertyNames(): System.Collections.Generic.IEnumerable<string>
Gets a list of the names of all properties for this instance.

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

GetProperty

GetProperty(name): unknown
Gets the value of a named property.
Parameters
- name: string | String
  The property name.
Returns unknown
The value of the property.

Since
2.0

HasPropertyValue

HasPropertyValue(name): boolean
Checks a value exists for a named property.
Parameters
- name: string | String
  The property name.
Returns boolean
True if there is a value for the property; otherwise, false.

Since
2.0

Propagate

Propagate(importContext): ResultProperties
Create a new collection of result properties where all the correct properties are forwarded.
Parameters
- importContext: ImportContext
  The import context.
Returns ResultProperties
A copy of the properties that should be propagated.

Since
2.0

PropertyExists

PropertyExists(name): 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.

Since
2.0

SetProperty

SetProperty(name, value): void
Sets the value of a named property.
Parameters
- name: string | String
  The property name.
- value: any
  The property value.
Returns void
Since
2.0