Provides access to the Spotfire library. An instance of this class is available as a service on the user level.

2.0

Hierarchy (view full)

Methods

Extended capability 'LibraryRead'

Extended capability 'LibraryWrite'

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'

  • Gets a collection of methods for retrieving library items uri of different types.

    Returns LibraryLinks

    2.0

  • Gets a collection of items matching the specified search expression.

    Parameters

    • searchExpression: string | String

      An expression describing the items that shall be returned. The syntax used is the same as in the search field in the "Open from Library" dialog. See the topic "Searching the Library" in the Spotfire UserĀ“s Guide for a description of the search syntax.

    • Rest...retrievalOptions: LibraryItemRetrievalOption[]

      Specifies the kinds of metadata that the returned items shall be populated with.

    Returns LibraryItemCollection

    A collection of items matching the search.

    2.0

  • Tries to get the item associated with the specified id. Returns true if the item is found and false otherwise. On success, the item parameter is assigned and populated according to the specified metadata options.

    Parameters

    • id: Guid

      The id of the item to get.

    • item: OutParam<LibraryItem>

      Will be assigned with the library item or null if no item with the specified id can be found.

    • Rest...retrievalOptions: LibraryItemRetrievalOption[]

      Specifies the kinds of metadata that the returned item shall be populated with.

    Returns boolean

    true if an item was found, false otherwise.

    2.0

  • Tries to get the item associated with the specified path. Returns true if the item is found and false otherwise. On success, the item parameter is assigned and populated according to the specified metadata options.

    Parameters

    • path: string | String

      The path of the item to get.

    • itemType: LibraryItemType

      The type of the item. There can be several items with the same path but with different types.

    • item: OutParam<LibraryItem>

      Will be assigned with the library item or null if no item with the specified path and type can be found.

    • Rest...retrievalOptions: LibraryItemRetrievalOption[]

      Specifies the kinds of metadata that the returned item shall be populated with.

    Returns boolean

    true if an item was found, false otherwise.

    2.0

Extended capability 'LibraryWrite'

  • Creates a folder with the specified folderName in the library. The folder is created under the specified parentFolder.

    Parameters

    Returns LibraryItem

    An object describing the created library folder.

    2.0

  • Deletes the specified item in the library.

    Parameters

    Returns void

    2.0