Spotfire.Dxp.Application.Calculations Namespace

Spotfire 14.5 API Reference
The Spotfire.Dxp.Application.Calculations namespace contains classes used by data calculations.

More specific functionality is provided in the Spotfire.Dxp.Application.Calculations.DataRelationships namespace.

Classes

  ClassDescription
Public classCalculation<TSettings, TResults>
Base class for calculations.
Public classCalculation<TSettings, TResults>.PropertyNames
Public classCalculationCollection
A collection of calculation instances.
Public classCalculationCollection.PropertyNames
Contains property name constants for the public properties of CalculationCollection.
Public classCalculationDependency
Abstract base class for a single dependency for a calculation.
Public classCalculationDependency.PropertyNames
Contains property name constants for the public properties of CalculationDependency.
Public classCalculationDependency<T>
Abstract base class for typed CalculationDependency
Public classCalculationDependency<T>.PropertyNames
Public classCalculationDependencyCollection
Abstract base class for dependencies for a calculation.
Public classCalculationDependencyCollection.PropertyNames
Contains property name constants for the public properties of CalculationDependencyCollection.
Public classCalculationDependencyCollection<T>
Abstract typed base class for dependencies for a calculation.
Public classCalculationDependencyCollection<T>.PropertyNames
Public classCalculationDependencyIdentifier
Used to uniquely identify a dependency of a calculation.
Public classCalculationFactory
Abstract base class for CalculationFactories.
Public classCalculationFactory<TCalculation>
Abstract typed base class for CalculationFactories.
Public classCode exampleCalculationResults
Abstract base class for calculation results. After a calculation has been executed the results can be found here. This class must be extended to implement a specialized results class that is suited for a concrete calculations implementation.
Public classCode exampleCalculationResults.CalculationResultsIdentifiers
Implement this to contain CalculationResultsIdentifier objects to uniquely identify each result in this CalculationResults.
Public classCalculationResults.PropertyNames
Contains property name constants for the public properties of CalculationResults.
Public classCalculationResultsIdentifier
Used to uniquely identify a result in CalculationResults.
Public classCode exampleCalculationSettings
Base class for calculation settings. Holds the input to a calculation and uses it to determine when the calculation needs to be rerun, invalidated etc. This class must be extended to implement a specialized settings class that is suited for a concrete calculations implementation.
Public classCode exampleCalculationSettings.CalculationDependencyIdentifiers
Implement this to contain CalculationDependencyIdentifier objects to uniquely identify each result in this CalculationSettings.
Public classCalculationSettings.PropertyNames
Contains property name constants for the public properties of CalculationSettings.
Public classCalculationSettingsValidationResult
Report from the CalculationSettings validation. Contains any errors or warnings that this resulted in. These can then be displayed to the user or added to if the implementation wants to do additional checks.
Public classCalculationTypeIdentifiers
Defines the type identifiers for built-in calculations
Public classColumnsCalculationResult
Keeps references to columns resulting from a calculation and corresponding to a particular CalculationResultsIdentifier.
Public classColumnsCalculationResult.PropertyNames
Contains property name constants for the public properties of ColumnsCalculationResult.
Public classDataColumnCalculationDependency
A calculation dependency on a single column.
Public classDataColumnCalculationDependency.PropertyNames
Contains property name constants for the public properties of DataColumnCalculationDependency.
Public classDataColumnCalculationDependencyCollection
A calculation dependency on a group of columns.
Public classDataColumnCalculationDependencyCollection.PropertyNames
Contains property name constants for the public properties of DataColumnCalculationDependencyCollection.
Public classDataSelectionCalculationDependency
Represents a calculation dependency on a DataSelection
Public classDataSelectionCalculationDependency.PropertyNames
Contains property name constants for the public properties of DataSelectionCalculationDependency.
Public classCode exampleResultAccumulator
Accumulator used to add the results of a calculation.