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
Node
Spotfire.Dxp.Framework.DocumentModelDocumentNode
Spotfire.Dxp.Data.DataFunctionsDataFunctionInput
Namespace: Spotfire.Dxp.Data.DataFunctions
Assembly: Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 66.0.19621.1485 (66.0.19621.1485)
Syntax
C#
[SerializableAttribute] [PersistenceVersionAttribute(52, 0)] public sealed class DataFunctionInput : DocumentNode
The DataFunctionInput type exposes the following members.
Properties
Name | Description | |
---|---|---|
Context |
Gets the context of this node.
(Inherited from DocumentNode.) | |
Expression | Gets the expression that describes how to retrieve values for the input argument.
| |
IncludeActiveFiltering | Gets a value indicating whether active filtering should be included in the selections as well.
| |
IsAttached |
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.) | |
Selections | Gets a readonly list of the selections to use when calculating the expression.
| |
Transactions |
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.) |
Methods
Name | Description | |
---|---|---|
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Explicit Interface Implementations
Version Information
Supported in: 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also