Represents a layer of reference elements.
Inheritance Hierarchy
Node
Spotfire.Dxp.Framework.DocumentModelDocumentNode
Spotfire.Dxp.Application.Visuals.LayersLayer
Spotfire.Dxp.Application.Visuals.ReferenceElementsReferenceLayer
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 ReferenceLayer : Layer
The ReferenceLayer type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
| Band |
Gets the band reference element settings.
| |
| BarSegmentHandling |
Gets or sets a value specifying how reference elements are rendered on a BarChart or CombinationChart
for different values of StackMode.
| |
| Box |
Gets the box reference element settings.
| |
| ColorAxis |
Gets the color axis of this ReferenceLayer.
This axis can be used to define a color assignments for reference elements that differs from that of the parent visualization.
| |
| ColumnNameMatchTarget |
Gets or sets a value that override the standard column name matching behavior to instead match on columns from this target axis.
| |
| Context |
Gets the context of this node.
(Inherited from DocumentNode.) | |
| Data |
Gets the reference layer data.
| |
| Details |
Gets the details object for this layer, containing items that control
tooltip settings.
| |
| DisplayName |
Gets the display name.
(Inherited from Layer.) | |
| ElementByAxis |
Gets the element-by axis of this ReferenceLayer.
This axis is used to perform additional grouping of reference elements.
The expression set on this axis must be categorical.
| |
| Enabled |
Gets or sets a value indicating whether this layer is enabled.
(Inherited from Layer.) | |
| EvaluationModes |
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, the X and
Color expressions can be overridden by the XAxis and ColorAxis
owned by a ReferenceLayer instance.
Additional grouping can be achieved by using the ElementByAxis which is unrelated
to the evaluation modes.
| |
| Expression |
Gets or sets the expression.
This is a shorthand to access the Expression of ValueColumn.
| |
| IsAttached |
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.) | |
| IsBackground |
Gets or sets a value indicating whether to render this element in the background.
That is, behind the data layer.
| |
| Label |
Gets the label reference element settings.
| |
| Legend | Gets the legend object for this layer.
| |
| LegendItem |
Gets the legend item object for this layer.
| |
| LegendTitleItem |
Gets the legend item object for the title of this layer.
| |
| LimitByMarking |
Gets or sets a value indicating whether to limit the reference layer to the marked data.
| |
| Line |
Gets the line reference element settings.
| |
| LineConnection |
Gets the line connection reference element settings.
| |
| Marker |
Gets the marker reference element settings.
| |
| Name |
Gets or sets the name of this Layer instance. If set to a non-empty string,
this name is used as the DisplayName of this instance.
(Inherited from Layer.) | |
| Relations |
Gets the visualizationRelations.
| |
| SecondaryExpression |
Gets or sets the secondary expression.
This is a shorthand to access the Expression of SecondaryValueColumn.
| |
| SecondaryValueColumn |
Gets the secondary value column.
| |
| Transactions |
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.) | |
| Transparency |
Gets or sets a value for the relative transparency.
This value is always in the range [0, 1], where 0 is fully opaque and 1 is fully transparent.
| |
| ValueAxis |
Gets or sets a value indicating which axis in the parent visualization that is the value axis.
| |
| ValueColumn |
Gets the value column.
| |
| Width |
Gets or sets a value for the relative width.
This value is always in the range [0, 100], where 100 is the full width of the categorical element
and 0 means that the element is not visible.
| |
| XAxis |
Gets the "X axis" of this ReferenceLayer.
This axis can be used to override the expression of the parent category axis, when it is continuous.
The expression set on this overriding axis must be continuous and have a type that matches that of the parent category axis.
|
Methods
| Name | Description | |
|---|---|---|
| ForEachNodeInSubTreeTNode |
Applies the specified action to all nodes of the specified type in the subtree spanned
from this node, including this node.
(Inherited from DocumentNode.) | |
| GetType | Gets the Type of the current instance. (Inherited from Object.) | |
| MoveTo |
Moves this instance to the specified targetCollection. This Layer
is removed from the LayerCollection where is currently resides and placed last
in the targetCollection.
(Inherited from Layer.) | |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Explicit Interface Implementations
Version Information
Supported in: 15.0, 14.8, 14.7, 14.6
See Also