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.

Since

2.0

Hierarchy (view full)

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

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

    Returns T1

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.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

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

    Returns null | T1

StaticEquals

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

Default capability

AllowCaching

  • get AllowCaching(): boolean

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

    Returns boolean

    Since

    2.0

Category

Description

  • get Description(): string

  • Gets the description.

    Returns string

    Since

    2.0

DisplayName

  • get DisplayName(): string

  • Gets the display name.

    Returns string

    Since

    2.0

FunctionName

  • get FunctionName(): string

  • Gets the name of the function.

    Returns string

    Since

    2.0

InputParameters

IsApprovedByCurrentUser

  • get IsApprovedByCurrentUser(): boolean

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

    Returns boolean

    Since

    2.0

LibraryIdentifier

  • get LibraryIdentifier(): Guid

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

    Returns Guid

    Since

    2.0

OutputParameters

ServiceType

  • get ServiceType(): TypeIdentifier

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

    Returns TypeIdentifier

    Since

    2.0

Settings

Extended capability 'LibraryRead'

StaticLoad

Extended capability 'LibraryWrite'

Save

  • Save(): LibraryItem

  • Updates the function definition in the library.

    Returns LibraryItem

    The library item for this function.

    Since

    2.0

SaveAs

Settings

Member Visibility

On This Page

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