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

Class LibraryItemPropertyCollection

Holds a collection of library item properties.

Since

2.0

Hierarchy (view full)

Spotfire.Object
- LibraryItemPropertyCollection

Implements

Index

Methods

Cast Equals GetHashCode ToString TryCast [iterator] Equals

Default capability

Extended capability 'LibraryRead'

Count Keywords GetEnumerator TryGetProperty

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

[iterator]

[iterator](): Iterator<LibraryItemProperty, any, undefined>
Returns Iterator<LibraryItemProperty, any, undefined>

`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

Default capability

`Readonly`Item

Item: PropertyGet<string | String, LibraryItemProperty>

Gets the property with the specified name.

Param: name

The name of the property to get.

Returns

The property with the specified name.

Since

2.0

Extended capability 'LibraryRead'

Count

get Count(): number
Gets the number of properties in this collection.

Returns number
Since
2.0

Keywords

get Keywords(): LibraryItemProperty
Gets the keywords property.

Returns LibraryItemProperty
Since
2.0

GetEnumerator

GetEnumerator(): System.Collections.Generic.IEnumerator<LibraryItemProperty>
Enumerates the properties in this collection.

Returns System.Collections.Generic.IEnumerator<LibraryItemProperty>
Since
2.0

TryGetProperty

TryGetProperty(name, property): boolean
Tries to get the property with the specified name.
Parameters
- name: string | String
  The name of the property to get.
- property: OutParam<LibraryItemProperty>
  Will be assigned the property with the specified name, or null if no such property exists.
Returns boolean
true if a property with the specified name was found.

Since
2.0