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

Class InputParameter

Represents an input parameter to a data function.

Since

2.0

Hierarchy (view full)

Spotfire.Object
- InputParameter

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

AllowedDataTypes Description DisplayName IsOptional Name ParameterType Settings IsAllowedDataType

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

AllowedDataTypes

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

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

Description

get Description(): string
Gets the description of the parameter.

Returns string
Since
2.0

DisplayName

get DisplayName(): string
Gets the display name.

Returns string
Since
2.0

IsOptional

get IsOptional(): boolean
Gets a value indicating whether the parameter is optional or not.

Returns boolean
Since
2.0

Name

get Name(): string
Gets the name of the parameter.

Returns string
Since
2.0

ParameterType

get ParameterType(): ParameterType
Gets the parameter type.

Returns ParameterType
Since
2.0

Settings

get Settings(): System.Collections.Generic.IDictionary<string, String>
Gets the implementation specific settings.

Returns System.Collections.Generic.IDictionary<string, String>
Since
2.0

IsAllowedDataType

IsAllowedDataType(dataType): boolean
Check if the data type is allowed as a data type for this parameter.
Parameters
- dataType: DataType
  The data type.
Returns boolean
True if the data type is allowed; false otherwise.

Since
2.0