About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Class LibraryItemSignature

Identifies an item in the library. Provides access to the subset of the metadata associated with the item that can be used to find the item in the library.

Since

2.0

Hierarchy (view full)

Spotfire.Object
- LibraryItemSignature

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Extended capability 'LibraryRead'

Description Id ItemType ParentId Path Title

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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from Object.Cast

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.

Inherited from Object.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from Object.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from Object.ToString

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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from Object.TryCast

`Static`Equals

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.

Inherited from Object.Equals

Extended capability 'LibraryRead'

Description

get Description(): string
Gets the description of this item.

Returns string
Since
2.0

Id

get Id(): Guid
Gets the id of this item. This value shall be used in search and other operations to refer to this item.

Returns Guid
Since
2.0

ItemType

get ItemType(): LibraryItemType
Returns the type of this item.

Returns LibraryItemType
Since
2.0

ParentId

get ParentId(): Guid
Gets the id of the parent item of this this item. The parent item is typically a folder in the library.

Returns Guid
Since
2.0

Path

get Path(): string
Gets the path of this item, or null if the path was not retrieved from the library when this item signature was created.

Returns string
Since
2.0

Title

get Title(): string
Gets the title of this item.

Returns string
Since
2.0