Spotfire.Dxp.Data.Import InformationLinkParameter
Namespace: Spotfire.Dxp.Data.Import
Assembly: Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 18.10.8513.5432 (18.10.8513.5432)
A named parameter points to a predefined named parameter in an information link. The parameter name is identified by the ParameterId property. Named parameters may also be passed in a configuration block when opening an analysis. Including a named parameter in the InformationLinkDataSource constructor will override any parameter with the same name passed in a configuration block. For information on how to set up named parameters in an information link see the 'Parameterized Information Link' topic in TIBCO Spotfire - User's Manual.
A filter parameter adds a filter to a column in an information link. The column is identified by the ElementId property. The filter is defined by the Expression property, which is essentially a SQL expression with placeholders for the column identifier and parameter values:
- %Column%
Placeholder for a source column identifier. The placeholder may occur one or several times in the expression, for example "%Column% in ... or %Column% = ...". - %Values%
Placeholder for the parameter values as a list, for example "%Column% in (%Values%)". - %Value[n]%, where n=0,1,..
Placeholder for one of the parameter values, for example "%Column% between %Values[0]% and %Values[1]%". - %Value%
Short for %Value[0]%. Placeholder for a single parameter value, for example "%Column% <= %Value%".
A referenced parameter represents a procedure parameter. The procedure is identified by the ElementId property and the parameter name is identified by the ParameterId property.
The following data types are supported:
- String
Representation type: System.String - Integer
Representation type: System.Int32 - Real
Representation type: System.Double - Date
Representation type: System.DateTime - Time
Representation type: System.DateTime - DateTime
Representation type: System.DateTime - Clob
Representation type: System.String - Blob
Representation type: System.byte[]