DataFunctionInput Class

 Spotfire 14.3 API Reference
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.

Inheritance Hierarchy
SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Data.DataFunctionsDataFunctionInput

Namespace:  Spotfire.Dxp.Data.DataFunctions
Assembly:  Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 65.0.19510.3242 (65.0.19510.3242)
Syntax
C#
Copy
[SerializableAttribute]
[PersistenceVersionAttribute(52, 0)]
public sealed class DataFunctionInput : DocumentNode

The DataFunctionInput type exposes the following members.

Properties
  NameDescription
Public propertyContext
Gets the context of this node.
(Inherited from DocumentNode.)
Public propertyExpression
Gets the expression that describes how to retrieve values for the input argument.
Public propertyIncludeActiveFiltering
Gets a value indicating whether active filtering should be included in the selections as well.
Public propertyIsAttached
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.)
Public propertySelections
Gets a readonly list of the selections to use when calculating the expression.
Public propertyTransactions
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.)
Top
Methods
  NameDescription
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implementationPrivate methodINodeContextGetAncestorT
Implements GetAncestorT.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextGetServiceT
Implements GetServiceT.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextIsDescendantOf
Implements IsDescendantOf(DocumentNode).
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsBeginAggregatedTransaction
Implements BeginAggregatedTransaction.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction
Implements ExecuteInvisibleTransaction(Executor).
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction2
Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction
Implements ExecuteStickyTransaction(Guid, Executor).
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction2
Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction
Implements ExecuteTransaction(Executor).
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction2
Implements ExecuteTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Top
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
See Also

Reference

Spotfire.Dxp.Data.DataFunctions Namespace