Representation of a plot legend. The legend is a key to the features
(that is, symbols or pictures) used in the plot.
Inheritance Hierarchy
Spotfire.Dxp.Framework.DocumentModelNode
Spotfire.Dxp.Framework.DocumentModelDocumentNode
Spotfire.Dxp.Application.VisualsLegend
Namespace: Spotfire.Dxp.Application.Visuals
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 30.0.10915.3380 (30.0.10915.3380)
Syntax
C#
[SerializableAttribute] [PersistenceVersionAttribute(17, 0)] public sealed class Legend : DocumentNode
The Legend type exposes the following members.
Methods
Name | Description | |
---|---|---|
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
Properties
Name | Description | |
---|---|---|
![]() | Context |
Gets the context of this node.
(Inherited from DocumentNode.) |
![]() | Dock |
Gets or sets the docking of the legend.
|
![]() | Font |
Gets or sets the font of this legend.
|
![]() | IsAttached |
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.) |
![]() | Items |
Gets the collection of legend items in this legend.
|
![]() | Transactions |
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.) |
![]() | Width |
Gets or sets the width, in pixels, of the legend as it is displayed in the user interface.
|
![]() | Visible |
Gets or sets a value indicating whether or not this
Legend is visible.
|
Explicit Interface Implementations
Name | Description | |
---|---|---|
![]() ![]() | IServiceProviderGetService |
Implements IServiceProvider.
(Inherited from Node.) |
![]() ![]() | INodeContextGetAncestorT |
Implements GetAncestorT.
(Inherited from DocumentNode.) |
![]() ![]() | INodeContextGetServiceT |
Implements GetServiceT.
(Inherited from DocumentNode.) |
![]() ![]() | INodeContextIsDescendantOf |
Implements IsDescendantOf(DocumentNode).
(Inherited from DocumentNode.) |
![]() ![]() | ITransactionsBeginAggregatedTransaction |
Implements BeginAggregatedTransaction.
(Inherited from DocumentNode.) |
![]() ![]() | ITransactionsExecuteInvisibleTransaction |
Implements ExecuteInvisibleTransaction(Executor).
(Inherited from DocumentNode.) |
![]() ![]() | ITransactionsExecuteStickyTransaction |
Implements ExecuteStickyTransaction(Guid, Executor).
(Inherited from DocumentNode.) |
![]() ![]() | ITransactionsExecuteTransaction |
Implements ExecuteTransaction(Executor).
(Inherited from DocumentNode.) |
Remarks
A Legend can be turned on/off by setting the Visible property. A Legend that is turned off can be shown as a popover when requested.
Version Information
See Also