Action
    Preparing search index...

    Class DataFunctionDefinition

    Represents a definition of an data function.

    The definition describes the information needed to invoke the function and enough information to provide a user interface for specifying how the inputs and outputs should be handled. If the function definition represents a script it also contains the script definition.

    The function definition provides methods to save and load the definition from the Spotfire library.

    2.0

    Hierarchy (View Summary)

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Default capability

    AllowCaching Category Description DisplayName FunctionName InputParameters IsApprovedByCurrentUser LibraryIdentifier OutputParameters ServiceType Settings

    Extended capability 'LibraryRead'

    Load

    Extended capability 'LibraryWrite'

    Save SaveAs

    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.

    Default capability

    • get AllowCaching(): boolean

      Gets a value indicating whether caching of the result of the function is allowed or not.

      Returns boolean

      This is needed when the function is dependent on state outside of the Spotfire document.

      2.0

    • get Description(): string

      Gets the description.

      Returns string

      2.0

    • get DisplayName(): string

      Gets the display name.

      Returns string

      If no display name is set then it returns the function name.

      2.0

    • get FunctionName(): string

      Gets the name of the function.

      Returns string

      2.0

    • get IsApprovedByCurrentUser(): boolean

      Gets a value indicating whether this data function is approved by the current Windows user.

      Returns boolean

      The approval information is associated with the current Windows user. The user concept defined by the Spotfire system is not involved.

      This property only works correctly in Spotfire Analyst and other Windows desktop versions of Spotfire. When called in a server side version of Spotfire, like the Web Player or Automation Services, it will always return false.

      When this property returns true, this data function instance will be allowed to execute. Note that when this property returns false it might still be trusted in the Spotfire Library and thereby be allowed to execute.

      2.0

    • get LibraryIdentifier(): Guid

      Gets the identifier to the function definition as stored in the library.

      Returns Guid

      May be Guid.Empty if the function definition is not stored in the library.

      2.0

    • get ServiceType(): TypeIdentifier

      Gets the type identifier for the provider responsible for executing the function.

      Returns TypeIdentifier

      2.0

    Extended capability 'LibraryRead'

    Extended capability 'LibraryWrite'

    • Updates the function definition in the library.

      Returns LibraryItem

      The library item for this function.

      2.0

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability
    Extended capability 'LibraryRead'
    Extended capability 'LibraryWrite'