VisualInsightAgent Class

Spotfire 15.0 API Reference
Defines the contract for a custom insight agent that analyzes a visualization. Implementations run in a background thread with asynchronous progress and operate on a document snapshot provided by the VisualInsightAgentContext.
Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.Application.InsightsInsightAgent
    Spotfire.Dxp.Application.InsightsVisualInsightAgent
      Spotfire.Dxp.Application.ExtensionCustomVisualInsightAgent

Namespace:  Spotfire.Dxp.Application.Insights
Assembly:  Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 71.0.22122.5390 (71.0.22122.5390)
Syntax

C#
public abstract class VisualInsightAgent : InsightAgent

The VisualInsightAgent type exposes the following members.

Methods

  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodExecuteCore
Override execution of the insight agent. This method finds insight using a snapshot of the document and presents them to the user as a collection of agent insights. This method is not allowed to make changes to the document since it only has access to a snapshot of the document.
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks

Custom implementations should inherit from CustomVisualInsightAgent.
Version Information

Supported in: 15.0
See Also

Reference