Action
    Preparing search index...

    Class InformationLinkParameter

    Defines a runtime parameter in an information link execution.

    There are three kinds of parameters that may be defined by this class; named parameters, filter parameters and referenced (procedure) parameters.

    A named parameter points to a predefined named parameter in an information link. The parameter name is identified by the Spotfire.Dxp.Data.Import.InformationLinkParameter.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 Spotfire - User's Manual.

    A filter parameter adds a filter to a column in an information link. The column is identified by the Spotfire.Dxp.Data.Import.InformationLinkParameter.ElementId property. The filter is defined by the Spotfire.Dxp.Data.Import.InformationLinkParameter.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 Spotfire.Dxp.Data.Import.InformationLinkParameter.ElementId property and the parameter name is identified by the Spotfire.Dxp.Data.Import.InformationLinkParameter.ParameterId property.

    The following data types are supported: StringRepresentation type: System.String IntegerRepresentation type: System.Int32 RealRepresentation type: System.Double DateRepresentation type: System.DateTime TimeRepresentation type: System.DateTime DateTimeRepresentation type: System.DateTime ClobRepresentation type: System.String BlobRepresentation type: System.byte[]

    2.0

    Hierarchy (View Summary)

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Extended capability 'LibraryRead'

    ElementIdentifier Expression ExternalDataType ParameterId Values CreateFilterParameter CreateNamedParameter CreateReferencedParameter

    Methods

    • 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

      Returns T1

    • 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.

    • Serves as the default hash function.

      Returns number

      A hash code for the current object.

    • Returns a string that represents the current object.

      Returns string

      A string that represents the current object.

    • 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

      Returns null | T1

    • 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.

    Extended capability 'LibraryRead'

    • get ElementIdentifier(): Guid

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

      Returns Guid

      This property is always Guid.Empty for named parameters.

      2.0

    • get Expression(): string

      Gets the expression for a filter parameter.

      Returns string

      Applicable for filter parameters only. This property is always null for named and referenced parameters.

      2.0

    • get ParameterId(): string

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

      Returns string

      ParameterId denotes the parameter name for a named parameter or procedure parameter name for a referenced parameter. This property is always null for filter parameters.

      2.0

    Settings

    Member Visibility

    On This Page

    Methods
    Extended capability 'LibraryRead'