Spotfire.Dxp.Data.DataFunctions Namespace TIBCO Spotfire 6.5 API Reference
The Spotfire.Dxp.Data.DataFunctions namespace contains classes enabling function definition, function execution in a background thread, and handling of function output.
Classes
  Class Description
Public class ColumnsOutput
Represents the settings for the handling of a OutputParameter of a DataFunction. This class will add columns to an existing table when first executed and when updated it will either update those column or add new columns depending on the settings.
Public class ColumnsOutput PropertyNames
Contains property name constants for the public properties of ColumnsOutput.
Public class ColumnsOutputBuilder
Represents a builder class for creating a ColumnsOutput for a DataFunction. Used as input in DataFunctionOutputCollection.
Public class DataFunction
Represents an execution of a data function defined from a DataFunctionDefinition.
Public class DataFunction PropertyNames
Contains property name constants for the public properties of DataFunction.
Public class DataFunctionCollection
Represents a list of DataFunction instances.
Public class DataFunctionCollection PropertyNames
Contains property name constants for the public properties of DocumentNodeListBase T .
Public class DataFunctionDefinition
Represents a definition of an data function.

The definition describes the information needed to invoke the function and enough information to provide a user interface for specifying how the inputs and outputs should be handled. If the function definition represents a script it also contains the script definition.

The function definition provides methods to save and load the definition from the Spotfire library.

Public class DataFunctionDefinitionBuilder
Responsible for building a DataFunctionDefinition.
Public class DataFunctionExecutorService
This is a global service that can be used to execute functions through data function executors without using the document directly.
Public class DataFunctionExecutorTypeIdentifiers
Type identifiers for function providers.
Public class DataFunctionExpressionFunction
Represents a data function expression function.
Public class DataFunctionExpressionFunctionCollection
This class represents a collection of data function expression functions. These functions calls data functions through the Spotfire expression language.
Public class DataFunctionExpressionFunctionCollection PropertyNames
Contains property name constants for the public properties of DataFunctionExpressionFunctionCollection.
Public class DataFunctionInput
Defines how to retrieve the input for an InputParameter in a DataFunction.

An input to a data function is an expression representing a list of columns and optionally a set of selections that can be used to define the rows that the expression should be calculated on. The expression is calculated on the intersection of all the included selections.

Instances of this class is created in the DataFunctionInputCollection class.

Public class DataFunctionInput PropertyNames
Contains property name constants for the public properties of DataFunctionInput.
Public class DataFunctionInputCollection
Represents the declarations on how to retrieve the values for InputParameters in a DataFunction.
Public class DataFunctionInputCollection PropertyNames
Contains property name constants for the public properties of DataFunctionInputCollection.
Public class DataFunctionInvocation
Represents an invocation of a data function.
Public class DataFunctionInvocationBuilder
A builder that is used to create a DataFunctionInvocation which is used as a transient object when executing the function defined by a DataFunctionDefinition using the DataFunctionExecutorService.
Public class DataFunctionOutput
The data function output mapping.
Public class DataFunctionOutput PropertyNames
Contains property name constants for the public properties of DataFunctionOutput.
Public class DataFunctionOutputBuilder
Represents a builder for output mappings.
Public class DataFunctionOutputCollection
Represents the declarations on how to handle the results for OutputParameters in a DataFunction.
Public class DataFunctionOutputCollection PropertyNames
Contains property name constants for the public properties of DataFunctionOutputCollection.
Public class InputParameter
Represents an input parameter to an data function.
Public class InputParameterBuilder
Responsible for building an input parameter to a data function.
Public class JoinOutput
Output mapping class for adding columns to a new table using a join.
Public class JoinOutput PropertyNames
Contains property name constants for the public properties of JoinOutput.
Public class JoinOutputBuilder
Represents a builder class for outputmappings that add columns to a table. Used as input in DataFunctionOutputCollection.
Public class OutputParameter
An output parameter from an data function.
Public class OutputParameterBuilder
Responsible for building an input argument to a data function.
Public class PropertyOutput
Output mapping class for setting the values of properties as output.
Public class PropertyOutput PropertyNames
Contains property name constants for the public properties of PropertyOutput.
Public class PropertyOutputBuilder
Represents a builder class for outputmappings that create a new table. Used as input in DataFunctionOutputCollection.
Public class ReplaceDataOutput
Output mapping class for replacing data.
Public class ReplaceDataOutput PropertyNames
Contains property name constants for the public properties of ReplaceDataOutput.
Public class ReplaceDataOutputBuilder
Represents a builder class for outputmappings that replace a datatable. Used as input in DataFunctionOutputCollection.
Public class RowsOutput
Represents the settings for the handling of a OutputParameter of a DataFunction. This class will add rows to an existing table when first executed and when updated it will either update those rows or add new rows depending on the settings.
Public class RowsOutput PropertyNames
Contains property name constants for the public properties of RowsOutput.
Public class RowsOutputBuilder
Represents a builder class for creating a RowsOutput for a DataFunction. Used as input in DataFunctionOutputCollection.
Public class TableOutput
Output mapping class for adding a new table.
Public class TableOutput PropertyNames
Contains property name constants for the public properties of TableOutput.
Public class TableOutputBuilder
Represents a builder class for outputmappings that create a new table. Used as input in DataFunctionOutputCollection.
Delegates
  Delegate Description
Public delegate DataFunctionCompletionCallback
A delegate the is used to provide a callback for the execution of a DataFunction.
Enumerations
  Enumeration Description
Public enumeration DataFunctionNameHandling
Specifies how name handling should be performed for a custom data function executor.
Public enumeration DataFunctionUpdateBehavior
The update behavior for a data function.
Public enumeration ParameterType
The type of a input or output parameter of a data function.