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

Class InformationLinkDescriptor

Container class for information around InformationLink. Spotfire.Dxp.Data.Import.InformationModelElementDescriptor for information on common element properties.

Since

2.0

Hierarchy (view full)

InformationModelElementDescriptor
- InformationLinkDescriptor

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Extended capability 'LibraryRead'

Description FilterParameters Identifier Name NamedParameters Path Properties ReferencedParameters GetReferencedElementDescriptor

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 InformationModelElementDescriptor.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 InformationModelElementDescriptor.Equals

GetHashCode

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

Returns number
A hash code for the current object.

Inherited from InformationModelElementDescriptor.GetHashCode

ToString

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

Returns string
A string that represents the current object.

Inherited from InformationModelElementDescriptor.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 InformationModelElementDescriptor.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 InformationModelElementDescriptor.Equals

Extended capability 'LibraryRead'

Description

get Description(): string
Get a description of the element.

Returns string
Since
2.0

Inherited from InformationModelElementDescriptor.Description

FilterParameters

get FilterParameters(): System.Collections.Generic.IList<InformationLinkParameter>
Get a read only list of the filter parameters for the InformationLink.

Returns System.Collections.Generic.IList<InformationLinkParameter>
Since
2.0

Identifier

get Identifier(): Guid
Gets the element identifier.

Returns Guid
Since
2.0

Inherited from InformationModelElementDescriptor.Identifier

Name

get Name(): string
Get the element name.

Returns string
Since
2.0

Inherited from InformationModelElementDescriptor.Name

NamedParameters

get NamedParameters(): System.Collections.Generic.IList<InformationLinkParameter>
Get a read only list of the named parameters for the InformationLink.

Returns System.Collections.Generic.IList<InformationLinkParameter>
Since
2.0

Path

get Path(): string
Get current path for the element.

Returns string
Since
2.0

Inherited from InformationModelElementDescriptor.Path

Properties

get Properties(): System.Collections.Generic.IDictionary<string, String>
Get element metadata as a read only Dictionary of key value pairs.

Returns System.Collections.Generic.IDictionary<string, String>
Since
2.0

Inherited from InformationModelElementDescriptor.Properties

ReferencedParameters

get ReferencedParameters(): System.Collections.Generic.IList<InformationLinkParameter>
Get a read only list of the referenced parameters for the InformationLink. That is, parameters for procedures referenced by the InformationLink.

Returns System.Collections.Generic.IList<InformationLinkParameter>
Since
2.0

GetReferencedElementDescriptor

GetReferencedElementDescriptor(id): InformationModelElementDescriptor
Get descriptor for element referenced by the InformationLink.
Parameters
- id: Guid
  identifier of referenced element
Returns InformationModelElementDescriptor
Descriptor of referenced element, or null if not found

Since
2.0