Spotfire.Dxp.Application.Extension Namespace

Spotfire 14.3 API Reference
The Spotfire.Dxp.Application.Extension namespace contains classes used to extend Spotfire with new analytic capabilities.
Classes

  ClassDescription
Public classAddIn
Base class for Spotfire AddIns. An AddIn is used to extend the application with new functionality.
Public classAddInApplicationEventHandlerRegistrar
Public classAddInCalculationRegistrar
This class is used when overriding the RegisterCalculations method to register new calculations.
Public classAddInDataAdapterRegistrar
This class is used when overriding the RegisterDataAdapters(AddInDataAdapterRegistrar) method to register new data adapters.
Public classAddInDataFunctionExecutorRegistrar
Public classAddInDataMethodRegistrar
This class is used when overriding the RegisterDataMethods(AddInDataMethodRegistrar) method to register new data methods (e.g. aggregation methods).
Public classAddInDataSourceRegistrar
Public classAddInDataTransformationRegistrar
Public classAddInDataWriterRegistrar
Public classAddInFittingModelRegistrar
Public classAddInHelpRegistrar
This class is used when overriding the RegisterHelp(AddInHelpRegistrar) method to register new help items.
Public classAddInInsightModuleRegistrar
Public classAddInPanelRegistrar
Public classAddInPersistenceManagerRegistrar
This class is used when overriding RegisterTypeBindings(AddInPersistenceManagerRegistrar) method to register type bindings for the deserialization engine.
Public classAddInPreferenceRegistrar
Public classAddInPropertyRegistrar
Public classAddInServiceProvider
This class is used when overriding one of the OnGlobalServiceRegistered, OnUserServicesRegistered or OnAnalysisServicesRegistered methods.
Public classAddInServiceRegistrar
This class is used when overriding one of the RegisterGlobalServices, RegisterUserServices or RegisterAnalysisServices methods.
Public classAddInToolRegistrar
This class is used when overriding the RegisterTools(AddInToolRegistrar) method to register new tools.
Public classAddInValueRendererRegistrar
Public classAddInViewRegistrar
This class is used when overriding the RegisterViews(AddInViewRegistrar) method to register new views (e.g. a visualization Control).
Public classAddInVirtualColumnRegistrar
This class is used when overriding the RegisterVirtualColumnProducers(AddInVirtualColumnRegistrar) method to register new virtual column producers.
Public classAddInVisualRegistrar
Public classConfiguredVisualFactoryT
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 classCustomAggregationMethod
Base class for custom aggregation methods.
Public classCustomApplicationEventHandler
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 classCustomCalculationTSettings, TResults Obsolete.
Base class for custom calculations. Extend this class to implement a custom calculation.
Public classCustomCalculationFactoryTCalculation
Public classCustomColumnMethodT
Base class for custom data methods that operate on columns.
Public classCustomControlState Obsolete.
Abstract base class for implementing state for custom web controls.
Public classCustomControlStateTNode Obsolete.
Base class for implementing state for custom web controls.
Public classCustomDataFunctionExecutor
Implement this class to provide a CustomDataFunctionExecutor that can be used to execute DataFunctions.
Public classCode exampleCustomDataRowReader
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 classCustomDataSource
Base class for custom data sources. Extend this class to implement a custom data source.
Public classCode exampleCustomDataTransformation
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(AddInDataTransformationRegistrar). If necessary create a UI and register in the overridden RegisterViews(AddInViewRegistrar) together with your transformation.
Public classCustomDataWriter
Base class for custom data writers. Extend this class to implement a custom data writer.
Public classCustomExportTool
This is the base class when creating a custom export tool.
Public classCustomFileDataSource
Base class for custom file data sources. Extend this class to implement a custom file data source.
Public classCustomFileDataSourceFactoryT
Base class for factories that create a CustomFileDataSource. data source.
Public classCustomFittingModel
Extension point for custom fitting models.
Public classCustomFittingModelPropertyNames
Contains property name constants for the public properties of CustomFittingModel.
Public classCustomFittingModelFactoryT
Base class for factories that create a CustomFittingModel.
Public classCode exampleCustomLicense
Base class for custom licenses.
Public classCustomLicenseFunctions
Contains the functions of the CustomLicense.
Public classCustomMenuGroup
Represents a menu group that is associated with one or more CustomToolTContext. The menu group appears as a sub-menu in the user interface.
Public classCustomNode
Base class for custom nodes.
Public classCustomNodePropertyNames
Contains property name constants for the public properties of CustomNode.
Public classCustomPanel
Base class for custom panels.
Public classCustomPanelFactoryT
Base class for factories that create a CustomPanel.
Public classCustomPanelView
Base class for the view of a CustomPanel.
Public classCustomPanelViewT
Represents the view of a CustomPanel.
Public classCode exampleCustomPreference
Extend this class to implement a set of preferences that are persisted locally and on the Spotfire Server.
Public classCustomRowMethodT
Base class for custom data methods that operate on rows.
Public classCustomShareToolTContext
This is the base class when creating a custom share tool.
Public classCustomToolTContext
This class is the base class to use when creating a custom tool.
Public classCustomTypeIdentifier
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 classCode exampleCustomTypeIdentifiers
Base class for custom type identifier definitions.
Public classCustomValueRenderer
Extension point for custom value renderers.
Public classCustomValueRendererFactoryTRenderer, TSettings
Base class for factories that create a CustomValueRenderer.
Public classCustomValueRendererSettings
Extension point for custom value renderer settings.
Public classCustomValueRendererSettingsPropertyNames
Contains property name constants for the public properties of CustomValueRendererSettings.
Public classCustomVirtualColumnProducer
An abstract class for implementing custom virtual column producers.
Public classCode exampleCustomVirtualColumnProducerVirtualColumnInputIdentifiers
Implement this to contain VirtualColumnInputIdentifier objects to uniquely identify each input collection in this VirtualColumnProducer.
Public classCustomVirtualValueWorkerTModel
Derive from this class to implement a class that produces data values from other data values.
Public classCustomVisual
Base class for custom visuals.
Public classCustomVisualPropertyNames
Contains property name constants for the public properties of CustomVisual.
Public classCustomVisualFactoryT
Factory base class for creating custom visuals. A custom visual inherits from CustomVisual. Extend this class to provide AutoConfigure logic to your visual.
Public classCustomVisualization
Base class for custom visualizations.
Public classCustomVisualizationPropertyNames
Contains property name constants for the public properties of CustomVisualization.
Public classCustomVisualView
Base class for the view of a CustomVisual.
Public classCustomVisualViewT
Represents the view of a CustomVisual.
Public classCustomWorkerTModel, TItem
Base class for custom workers. To create a custom worker, inherit from this class and implement either DoWorkCore or DoBatchWorkCore
Public classCustomWorkerFactoryTWorker, TModel
Public classExtensionIcon
Represents an icon shown for custom extensions in menus and toolbars.
Public classRenderArgs Obsolete.
Encapsulates the arguments to the RenderCore(RenderArgs) method.
Public classValueRendererFactory
An abstract class defining a factory for value renderers.
Public classValueRendererFactoryTRenderer, TSettings
An abstract class defining a factory for value renderers.
Public classVisualControlStateTVisual, TValue Obsolete.
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 classVisualFactory
Public classVisualFactoryT
Template base class for Visual Factory implementations.
Interfaces

  InterfaceDescription
Public interfaceILegendOwner
Interface used for legend integration in the 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

  EnumerationDescription
Public enumerationRenderHint
RenderHint indicating what the result will be used for.
Public enumerationVisualCategory
Defines what category a visual belongs to.