ReferenceLayerData Class

Spotfire 15.0 API Reference
Represents the data for a layer of reference elements.
Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Application.Visuals.ReferenceElementsReferenceLayerData

Namespace:  Spotfire.Dxp.Application.Visuals.ReferenceElements
Assembly:  Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 71.0.22122.5390 (71.0.22122.5390)
Syntax

C#
[SerializableAttribute]
[PersistenceVersionAttribute(71, 0)]
public sealed class ReferenceLayerData : DocumentNode

The ReferenceLayerData type exposes the following members.

Properties

  NameDescription
Public propertyApplyParentDataLimiting
Gets or sets a value indicating whether the layer shall use the data limitation of the parent visualization. If true, all limiting markings and filterings of the parent are applied as limiting for the layer, in addition to any other limiting specified by the layers itself. The limiting where clause of the parent, if any, is applied if the layer uses the same data table as the parent.
Public propertyColumnNameMatchTarget
Gets or sets a value that override the standard column name matching behavior to instead match on columns from this target axis.
Public propertyContext
Gets the context of this node.
(Inherited from DocumentNode.)
Public propertyDataTableReference
Gets or sets the DataTable that this reference layer uses, or null if it inherits the data table from the parent visualization.
Public propertyEvaluationModes
Gets or sets the evaluation modes, describing which axes to group by. The grouping expressions used on the X, Color and Trellis axes are defined by the corresponding axis in the parent visualization. However, in a ReferenceLayer the X and Color expressions can be overridden and additional grouping can be performed. See EvaluationModes.
Public propertyFilterings
Gets the collection of auxiliary selections to filter the reference layer data by.
Public propertyIsAttached
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.)
Public propertyLimitByMarking
Gets or sets a value indicating whether to limit the reference layer to the marked data.
Public propertyLimitingMarkingsEmptyBehavior
Gets or sets the behavior for when the limiting markings are empty.
Public propertyMarkingCombinationMethod
Gets or sets a value indicating how the data marking selections shall be combined to limit the data shown by the reference layer.
Public propertyRelations
Gets the visualizationRelations.
Public propertyShowMultipleTablesMismatchWarnings
Gets or sets a value indicating whether to show mismatch warnings
Public propertyTransactions
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.)
Public propertyUseActiveFiltering
Gets or sets a value indicating whether to use the filtering from the page's filter panel or not.
Public propertyValueAxis
Gets or sets a value indicating which axis in the parent visualization that is the value axis.
Public propertyWhereClauseExpression
Gets or sets the where clause expression that limits the data shown by the reference layer.
Top
Methods

  NameDescription
Public methodForEachNodeInSubTreeTNode
Applies the specified action to all nodes of the specified type in the subtree spanned from this node, including this node.
(Inherited from DocumentNode.)
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 (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextGetServiceT (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextIsDescendantOf (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsBeginAggregatedTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction2
Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction2
Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction2
Implements ExecuteTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Top
Version Information

Supported in: 15.0
See Also

Reference