Class InformationLinkParameter

Defines a runtime parameter in an information link execution.

Since

2.0

Hierarchy (view full)

Spotfire.Object
- InformationLinkParameter

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Extended capability 'LibraryRead'

ElementIdentifier Expression ExternalDataType ParameterId Values CreateFilterParameter CreateNamedParameter CreateReferencedParameter

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

Extended capability 'LibraryRead'

ElementIdentifier

get ElementIdentifier(): Guid
Gets the identifier for the element (column or procedure) in the information link that this parameter applies to.

Returns Guid
Since
2.0

Expression

get Expression(): string
Gets the expression for a filter parameter.

Returns string
Since
2.0

ExternalDataType

get ExternalDataType(): ExternalDataType
Gets the parameter data type.

Returns ExternalDataType
Since
2.0

ParameterId

get ParameterId(): string
Gets a parameter identifier local for the current element (see Spotfire.Dxp.Data.Import.InformationLinkParameter.ElementIdentifier).

Returns string
Since
2.0

Values

get Values(): TypedArray<unknown>
Gets the parameter values.

Returns TypedArray<unknown>
Since
2.0

`Static`CreateFilterParameter

CreateFilterParameter(elementId, expression, values): InformationLinkParameter
Creates a new InformationLinkParameter representing a filter parameter.
Parameters
- elementId: Guid
  The element id.
- expression: string | String
  The expression.
- values: TypedArray<System.Object> | TypedArray<any>
  The values.
Returns InformationLinkParameter
A new InformationLinkParameter.

Since
2.0
CreateFilterParameter(elementId, expression, values, dataType): InformationLinkParameter
Creates a new InformationLinkParameter representing a filter parameter.
Parameters
- elementId: Guid
  The element id.
- expression: string | String
  The expression.
- values: TypedArray<System.Object> | TypedArray<any>
  The values.
- dataType: ExternalDataType
  Type data type, one of String, Integer, Real, Date, Time, DateTime, Clob or Blob.
Returns InformationLinkParameter
A new InformationLinkParameter.

Since
2.0

`Static`CreateNamedParameter

CreateNamedParameter(parameterName, values): InformationLinkParameter
Creates a new InformationLinkParameter that represents a named parameter defined in the information model.
Parameters
- parameterName: string | String
  The parameter name.
- values: TypedArray<System.Object> | TypedArray<any>
  The values.
Returns InformationLinkParameter
A new InformationLinkParameter.

Since
2.0

`Static`CreateReferencedParameter

CreateReferencedParameter(elementId, parameterId, values): InformationLinkParameter
Creates a new InformationLinkParameter that represents a local parameter defined in the specified procedure element.
Parameters
- elementId: Guid
  The element id.
- parameterId: string | String
  The parameter id.
- values: TypedArray<System.Object> | TypedArray<any>
  The values.
Returns InformationLinkParameter
A new InformationLinkParameter.

Since
2.0

Class InformationLinkParameter

Since

Hierarchy (view full)

Index

Methods

Extended capability 'LibraryRead'

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

Extended capability 'LibraryRead'

ElementIdentifier

Returns Guid

Since

Expression

Returns string

Since

ExternalDataType

Returns ExternalDataType

Since

ParameterId

Returns string

Since

Values

Returns TypedArray<unknown>

Since

StaticCreateFilterParameter

Parameters

Returns InformationLinkParameter

Since

Parameters

Returns InformationLinkParameter

Since

StaticCreateNamedParameter

Parameters

Returns InformationLinkParameter

Since

StaticCreateReferencedParameter

Parameters

Returns InformationLinkParameter

Since

Settings

On This Page

`Static`Equals

`Static`CreateFilterParameter

`Static`CreateNamedParameter

`Static`CreateReferencedParameter