Legend Class TIBCO Spotfire 7.12 API Reference
Representation of a plot legend. The legend is a key to the features (that is, symbols or pictures) used in the plot.
Inheritance Hierarchy
SystemObject
  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.11525.4184 (30.0.11525.4184)
Syntax
C#
Copy
[SerializableAttribute]
[PersistenceVersionAttribute(17, 0)]
public sealed class Legend : DocumentNode

The Legend type exposes the following members.

Methods
  NameDescription
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Top
Properties
  NameDescription
Public propertyContext
Gets the context of this node.
(Inherited from DocumentNode.)
Public propertyDock
Gets or sets the docking of the legend.
Public propertyFont
Gets or sets the font of this legend.
Public propertyIsAttached
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.)
Public propertyItems
Gets the collection of legend items in this legend.
Public propertyTransactions
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.)
Public propertyWidth
Gets or sets the width, in pixels, of the legend as it is displayed in the user interface.
Public propertyVisible
Gets or sets a value indicating whether or not this Legend is visible.
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implementationPrivate methodIServiceProviderGetService
Implements IServiceProvider.
(Inherited from Node.)
Explicit interface implementationPrivate methodINodeContextGetAncestorT
Implements GetAncestorT.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextGetServiceT
Implements GetServiceT.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextIsDescendantOf
Implements IsDescendantOf(DocumentNode).
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsBeginAggregatedTransaction
Implements BeginAggregatedTransaction.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction
Implements ExecuteInvisibleTransaction(Executor).
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction
Implements ExecuteStickyTransaction(Guid, Executor).
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction
Implements ExecuteTransaction(Executor).
(Inherited from DocumentNode.)
Top
Remarks
Each legend contains a series of Legend Items, each of which describes a feature.

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

Supported in: 7.9, 7.8, 7.7, 7.6, 7.5, 7.12, 7.11, 7.10, 7.0
See Also

Reference

Spotfire.Dxp.Application.Visuals Namespace