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

Class LibraryItemType

Represent the type of a library item.

Since

2.0

Hierarchy (View Summary)

Spotfire.Object
- LibraryItemType

Methods

Cast

Cast<T1, T2>(this: T2, type: TypeRef<T1>): 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: any): 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: T2, type: TypeRef<T1>): T1 | null
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 T1 | null
Inherited from Object.TryCast

`Static`Equals

Equals(objA: any, objB: any): 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

Default capability

`Static`ActionMod

get ActionMod(): Spotfire.Dxp.Framework.Library.LibraryItemType
Gets the library type for an action mod.

Returns Spotfire.Dxp.Framework.Library.LibraryItemType
Since
2.0

`Static`Analysis

get Analysis(): Spotfire.Dxp.Framework.Library.LibraryItemType
Gets the library type for a Spotfire analysis file.

Returns Spotfire.Dxp.Framework.Library.LibraryItemType
Since
2.0

`Static`AnalysisState

get AnalysisState(): Spotfire.Dxp.Framework.Library.LibraryItemType
Gets the library type for an analysis state.

Returns Spotfire.Dxp.Framework.Library.LibraryItemType
Since
2.0

`Static`AutomationServicesJob

get AutomationServicesJob(): Spotfire.Dxp.Framework.Library.LibraryItemType
Gets the library type for an automation services job.

Returns Spotfire.Dxp.Framework.Library.LibraryItemType
Since
2.0

`Static`Bookmark

get Bookmark(): Spotfire.Dxp.Framework.Library.LibraryItemType
Gets the library type for a bookmark.

Returns Spotfire.Dxp.Framework.Library.LibraryItemType
Since
2.0

`Static`ColorScheme

get ColorScheme(): Spotfire.Dxp.Framework.Library.LibraryItemType
Gets the library type for a color scheme.

Returns Spotfire.Dxp.Framework.Library.LibraryItemType
Since
2.0

`Static`Column

get Column(): Spotfire.Dxp.Framework.Library.LibraryItemType
Gets the library type for a column element in the information model in Information Services.

Returns Spotfire.Dxp.Framework.Library.LibraryItemType
Since
2.0

`Static`ConnectionDataSource

get ConnectionDataSource(): Spotfire.Dxp.Framework.Library.LibraryItemType
Gets the library type for a connector data source.

Returns Spotfire.Dxp.Framework.Library.LibraryItemType
Since
2.0

`Static`DataConnection

get DataConnection(): Spotfire.Dxp.Framework.Library.LibraryItemType
Gets the library type for a connector data connection.

Returns Spotfire.Dxp.Framework.Library.LibraryItemType
Since
2.0

`Static`DataFunction

get DataFunction(): Spotfire.Dxp.Framework.Library.LibraryItemType
Gets the library type for a data function.

Returns Spotfire.Dxp.Framework.Library.LibraryItemType
Since
2.0

`Static`DataSource

get DataSource(): Spotfire.Dxp.Framework.Library.LibraryItemType
Gets the library type for an Information Services data source.

Returns Spotfire.Dxp.Framework.Library.LibraryItemType
Since
2.0

`Static`Filter

get Filter(): Spotfire.Dxp.Framework.Library.LibraryItemType
Gets the library type for a filter element in the information model in Information Services.

Returns Spotfire.Dxp.Framework.Library.LibraryItemType
Since
2.0

`Static`Folder

get Folder(): Spotfire.Dxp.Framework.Library.LibraryItemType
Gets the library type for a folder in the library.

Returns Spotfire.Dxp.Framework.Library.LibraryItemType
Since
2.0

`Static`InformationLink

get InformationLink(): Spotfire.Dxp.Framework.Library.LibraryItemType
Gets the library type for an information link.

Returns Spotfire.Dxp.Framework.Library.LibraryItemType
Since
2.0

`Static`Join

get Join(): Spotfire.Dxp.Framework.Library.LibraryItemType
Gets the library type for a join element in the information model in Information Services.

Returns Spotfire.Dxp.Framework.Library.LibraryItemType
Since
2.0

`Static`Procedure

get Procedure(): Spotfire.Dxp.Framework.Library.LibraryItemType
Gets the library type for a procedure element in the information model in Information Services.

Returns Spotfire.Dxp.Framework.Library.LibraryItemType
Since
2.0

`Static`SbdfDataFile

get SbdfDataFile(): Spotfire.Dxp.Framework.Library.LibraryItemType
Gets the library type for a SBDF file.

Returns Spotfire.Dxp.Framework.Library.LibraryItemType
Since
2.0

`Static`Shapes

get Shapes(): Spotfire.Dxp.Framework.Library.LibraryItemType
Gets the library type for a shape collection.

Returns Spotfire.Dxp.Framework.Library.LibraryItemType
Since
2.1

`Static`VisualizationMod

get VisualizationMod(): Spotfire.Dxp.Framework.Library.LibraryItemType
Gets the library type for a visualization mod.

Returns Spotfire.Dxp.Framework.Library.LibraryItemType
Since
2.0