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

Class ActionModInsight

Represents an insight produced by an agent in an action mod.

Since

2.5

Hierarchy (View Summary)

AgentInsight
- ActionModInsight

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

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

GetHashCode

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

Returns number
A hash code for the current object.

Inherited from AgentInsight.GetHashCode

ToString

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

Returns string
A string that represents the current object.

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

Default capability

constructor

new ActionModInsight(
    title: string | String,
    explanation: string | String | null,
    action: ActionModScriptInvocation,
    image?: InsightImage | null,
): ActionModInsight
Initializes a new instance of the Spotfire.Dxp.Application.Insights.ActionModInsight class.
Parameters
- title: string | String
  The insight title.
- explanation: string | String | null
  The insight explanation.
- action: ActionModScriptInvocation
  The action mod script invocation.
- Optionalimage: InsightImage | null
  The preview image.
Returns ActionModInsight
Since
2.5

Overrides AgentInsight.constructor

Id

get Id(): Guid
Gets the identifier of the insight.

Returns Guid
Since
2.5

Inherited from AgentInsight.Id