Spotfire.Dxp.Application.Extension Namespace TIBCO Spotfire 6.0 API Reference
The Spotfire.Dxp.Application.Extension namespace contains classes used to extend TIBCO Spotfire with new analytic capabilities.
Classes
  Class Description
Public class AddIn
Base class for TIBCO Spotfire AddIns. An AddIn is used to extend the application with new functionality.
Public class AddIn ApplicationEventHandlerRegistrar
This class is used when overriding the RegisterApplicationEventHandlers(AddIn ApplicationEventHandlerRegistrar) method to register new application event handlers.
Public class AddIn CalculationRegistrar
This class is used when overriding the RegisterCalculations(AddIn CalculationRegistrar) method to register new calculations.
Public class AddIn DataFunctionExecutorRegistrar
This class is used when overriding the RegisterDataFunctionExecutors(AddIn DataFunctionExecutorRegistrar) method to register new data function executors.
Public class AddIn DataMethodRegistrar
This class is used when overriding the RegisterDataMethods(AddIn DataMethodRegistrar) method to register new data methods (e.g. aggregation methods).
Public class AddIn DataSourceRegistrar
This class is used when overriding the RegisterDataSources(AddIn DataSourceRegistrar) method to register new data sources.
Public class AddIn DataTransformationRegistrar
This class is used when overriding the RegisterDataTransformations(AddIn DataTransformationRegistrar) method to register new data transformations.
Public class AddIn DataWriterRegistrar
This class is used when overriding the RegisterDataWriters(AddIn DataWriterRegistrar) method to register new data writers.
Public class AddIn FittingModelRegistrar
This class is used when overriding the RegisterFittingModels(AddIn FittingModelRegistrar) method to register new fitting models.
Public class AddIn HelpRegistrar
This class is used when overriding the RegisterHelp(AddIn HelpRegistrar) method to register new help items.
Public class AddIn PanelRegistrar
This class is used when overriding the RegisterPanels(AddIn PanelRegistrar) method to register new panels.
Public class AddIn PersistenceManagerRegistrar
This class is used when overriding RegisterTypeBindings(AddIn PersistenceManagerRegistrar) method to register type bindings for the deserialization engine.
Public class AddIn PreferenceRegistrar
This class is used when overriding the RegisterPreferences(AddIn PreferenceRegistrar) method to register new preferences.
Public class AddIn PropertyRegistrar
This class is used when overriding the RegisterProperties(AddIn PropertyRegistrar) method to register new properties.
Public class AddIn ServiceProvider
This class is used when overriding one of the OnGlobalServiceRegistered, OnUserServicesRegistered or OnAnalysisServicesRegistered methods.
Public class AddIn ServiceRegistrar
This class is used when overriding one of the RegisterGlobalServices, RegisterUserServices or RegisterAnalysisServices methods.
Public class AddIn ToolRegistrar
This class is used when overriding the RegisterTools(AddIn ToolRegistrar) method to register new tools.
Public class AddIn ValueRendererRegistrar
This class is used when overriding the RegisterValueRenderers(AddIn ValueRendererRegistrar) method to register new value renderers.
Public class AddIn ViewRegistrar
This class is used when overriding the RegisterViews(AddIn ViewRegistrar) method to register new views (e.g. a visualization Control).
Public class AddIn VirtualColumnRegistrar
This class is used when overriding the RegisterVirtualColumnProducers(AddIn VirtualColumnRegistrar) method to register new virtual column producers.
Public class AddIn VisualRegistrar
This class is used when overriding the RegisterVisuals(AddIn VisualRegistrar) method to register new visuals.
Public class ConfiguredVisualFactory T 
Factory base class for creating configured visuals. A configured visual gives a new unique CustomTypeIdentifier to an existing visual. Override this class to provide new AutoConfigure logic for the visual.
Public class CustomAggregationMethod
Base class for custom aggregation methods.
Public class CustomApplicationEventHandler
Base class for objects that monitor and react to major events in the application, such as when a new instance of AnalysisApplication has been created.
Public class CustomCalculation TSettings, TResults  Obsolete.
Base class for custom calculations. Extend this class to implement a custom calculation.
Public class CustomCalculationFactory TCalculation 
Use to register a CustomCalculation TSettings, TResults  with a AddIn CalculationRegistrar in an AddIn
Public class CustomColumnMethod T 
Base class for custom data methods that operate on columns.
Public class CustomControlState
Abstract base class for implementing state for custom web controls.
Public class CustomControlState TNode 
Base class for implementing state for custom web controls.
Public class CustomDataFunctionExecutor
Implement this class to provide a CustomDataFunctionExecutor that can be used to execute DataFunctions.
Public class CustomDataRowReader
Base class for custom data readers. Extend this class to implement a custom data reader. This can be used in for example a CustomDataSource or a CustomDataTransformation
Public class CustomDataSource
Base class for custom data sources. Extend this class to implement a custom data source.
Public class CustomDataTransformation
Base class for custom data transformations. To create a custom transformation you need to extend this class and CustomDataRowReader, register the transformation class in your AddIn by using the overriddenRegisterDataTransformations(AddIn DataTransformationRegistrar). If necessary create a UI and register in the overridden RegisterViews(AddIn ViewRegistrar) together with your transformation.
Public class CustomDataWriter
Base class for custom data writers. Extend this class to implement a custom data writer.
Public class CustomExportTool
This is the base class when creating a custom export tool.
Public class CustomFileDataSource
Base class for custom file data sources. Extend this class to implement a custom file data source.
Public class CustomFileDataSourceFactory T 
Base class for factories that create a CustomFileDataSource. data source.
Public class CustomFittingModel
Extension point for custom fitting models.
Public class CustomFittingModel PropertyNames
Contains property name constants for the public properties of CustomFittingModel.
Public class CustomFittingModelFactory T 
Base class for factories that create a CustomFittingModel.
Public class CustomLicense
Base class for custom licenses.
Public class CustomLicense Functions
Contains the functions of the CustomLicense.
Public class CustomMenuGroup
Represents a menu group that is associated with one or more CustomTool TContext . The menu group appears as a sub-menu in the user interface.
Public class CustomNode
Base class for custom nodes.
Public class CustomNode PropertyNames
Contains property name constants for the public properties of CustomNode.
Public class CustomPanel
Base class for custom panels.
Public class CustomPanelFactory T 
Base class for factories that create a CustomPanel.
Public class CustomPreference
Extend this class to implement a set of preferences that are persisted locally and on the TIBCO Spotfire Analytics server.
Public class CustomRowMethod T 
Base class for custom data methods that operate on rows.
Public class CustomShareTool TContext 
This is the base class when creating a custom share tool.
Public class CustomTool TContext 
This class is the base class to use when creating a custom tool.
Public class CustomTypeIdentifier
An instance of this class identifies a custom extension type. The identifier should be valid between versions of the extension, even if the actual extension type changes. A CustomTypeIdentifier is created by declaring a class that inherits from CustomTypeIdentifiers.
Public class CustomTypeIdentifiers
Base class for custom type identifier definitions.
Public class CustomValueRenderer
Extension point for custom value renderers.
Public class CustomValueRendererFactory TRenderer, TSettings 
Base class for factories that create a CustomValueRenderer.
Public class CustomValueRendererSettings
Extension point for custom value renderer settings.
Public class CustomValueRendererSettings PropertyNames
Contains property name constants for the public properties of CustomValueRendererSettings.
Public class CustomVirtualColumnProducer
An abstract class for implementing custom virtual column producers.
Public class CustomVirtualColumnProducer VirtualColumnInputIdentifiers
Implement this to contain VirtualColumnInputIdentifier objects to uniquely identify each input collection in this VirtualColumnProducer.
Public class CustomVirtualValueWorker TModel 
Derive from this class to implement a class that produces data values from other data values.
Public class CustomVisual
Base class for custom visuals.
Public class CustomVisual PropertyNames
Contains property name constants for the public properties of CustomVisual.
Public class CustomVisualFactory T 
Factory base class for creating custom visuals. A custom visual inherits from CustomVisual. Extend this class to provide AutoConfigure logic to your visual.
Public class CustomVisualization
Base class for custom visualizations.
Public class CustomVisualization PropertyNames
Contains property name constants for the public properties of CustomVisualization.
Public class CustomWorker TModel, TItem 
Base class for custom workers. To create a custom worker, inherit from this class and implement either DoWorkCore or DoBatchWorkCore
Public class CustomWorkerFactory TWorker, TModel 
Base class for factories that create a CustomWorker TModel, TItem .
Public class RenderArgs
Encapsulates the arguments to the RenderCore(RenderArgs) method.
Public class ValueRendererFactory
An abstract class defining a factory for value renderers.
Public class ValueRendererFactory TRenderer, TSettings 
An abstract class defining a factory for value renderers.
Public class VisualControlState TVisual, TValue 
Keeps the state and visual model for a custom visual web control. The state is used to preserve data related to layout and rendering of a web control, which is important for web controls since they are disposed after they have been rendered. Typically, this can be used to implement more efficient tooltips. The state is cleared when the model must be re-rendered, that is, when the TVisual's GetRenderTrigger  fires.
Public class VisualFactory
Do not use this class directly, instead see the CustomVisualFactory T .
Public class VisualFactory T 
Template base class for Visual Factory implementations.
Interfaces
  Interface Description
Public interface ILegendOwner
Interface used for legend integration in the TIBCO Spotfire Web Player. If a CustomVisualization or a CustomVisual implements this interface, the Web Player will display a button in the visualization title bar to show or hide the legend.
Enumerations
  Enumeration Description
Public enumeration RenderHint
RenderHint indicating what the result will be used for.
Public enumeration VisualCategory
Defines what category a visual belongs to.