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

Class IndexedExpression

Indexed property of Expression

Since

2.0

Hierarchy (View Summary)

Spotfire.Object
- IndexedExpression

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Item RootValue Clear Contains

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>): 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: 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

`Readonly`Item

Item: PropertyGet<TypedArray<System.Object>, string> & PropertySet<
    TypedArray<System.Object>,
    string | String,
> & PropertyGet<CategoryKey, string> & PropertySet<
    CategoryKey,
    string
    | String,
>

Gets or sets the value corresponding to the key.

Param: key

The key.

Returns

Value corresponding to the key.

Since

2.0

RootValue

get RootValue(): string
Get or sets the root value.

Returns string
Since
2.0
set RootValue(value: string): void
Parameters
- value: string
Returns void

Clear

Clear(): void
Clears all values except the root value.

Returns void
Since
2.0

Contains

Contains(key: CategoryKey): boolean
Check if the dictionary for the indexed property contains a key.
Parameters
- key: CategoryKey
  The key.
Returns boolean
true if the key is found in the dictionary, otherwise false.

Since
2.0
Contains(...keys: any[]): boolean
Check if the dictionary for the indexed property contains a key.
Parameters
- ...keys: any[]
  The key as an object array.
Returns boolean
true if the key is found in the dictionary, otherwise false.

Since
2.0