DataFunction Class

Spotfire 14.3 API Reference

Represents an execution of a data function defined from a DataFunctionDefinition.

Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Data.DataFunctionsDataFunction

Namespace: Spotfire.Dxp.Data.DataFunctions
Assembly: Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 65.0.19510.3242 (65.0.19510.3242)

Syntax

[SerializableAttribute]
[PersistenceVersionAttribute(6, 0)]
public sealed class DataFunction : DocumentNode

The DataFunction type exposes the following members.

Properties

	Name	Description
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	DataFunctionDefinition	Gets or sets the data function definition.
	Inputs	Gets the inputs of the function.
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	Name	Gets or sets the name of the function.
	NeedsRefresh	Gets a value indicating whether the data function needs to be refreshed.
	Outputs	Gets the outputs of the function.
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)
	UpdateBehavior	Gets or sets the update behavior.
	Visible	Gets or sets a value indicating whether the function is visible in the UI or not.

Methods

	Name	Description
	Execute	Asynchronously executes the data function.
	Execute(DataFunctionCompletionCallback)	Asynchronously executes the data function with a callback when the execution has been finished. There is no guarantee regarding timing when the function will be executed and when it has finished executing.
	ExecuteSynchronously	Updates the function synchronously.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	SynchronizeWithLibrary	Synchronize the function definition with the function definition stored in the library.
	ToString	Returns a String that represents this instance. (Overrides ObjectToString.)

Explicit Interface Implementations

	Name	Description
	INodeContextGetAncestorT	Implements GetAncestorT. (Inherited from DocumentNode.)
	INodeContextGetServiceT	Implements GetServiceT. (Inherited from DocumentNode.)
	INodeContextIsDescendantOf	Implements IsDescendantOf(DocumentNode). (Inherited from DocumentNode.)
	ITransactionsBeginAggregatedTransaction	Implements BeginAggregatedTransaction. (Inherited from DocumentNode.)
	ITransactionsExecuteInvisibleTransaction	Implements ExecuteInvisibleTransaction(Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteInvisibleTransaction2	Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction	Implements ExecuteStickyTransaction(Guid, Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction2	Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction	Implements ExecuteTransaction(Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction2	Implements ExecuteTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)

Remarks

This class describes how inputs and outputs should be handled from the function.

Instances of this class are created in the DataFunctionCollection on the DataManager.

Version Information

Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8