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: 70.0.21819.5008 (70.0.21819.5008)
Syntax
C#
[SerializableAttribute] [PersistenceVersionAttribute(70, 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.
|
| 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.) |
| Details |
Gets the details object for this layer, containing items that control
tooltip settings.
|
| DisplayName |
Gets the display name.
(Inherited from Layer.) |
| Enabled |
Gets or sets a value indicating whether this layer is enabled.
(Inherited from Layer.) |
| EvaluationModes |
Gets or sets the evaluation modes, describing which of the top level visualization axes
that are used to group by.
|
| Expression |
Gets or sets the expression.
|
| 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.
|
| 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.
|
| 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.
|
| 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.
|
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: 14.8, 14.7, 14.6
See Also