Legend Class

Spotfire 14.3 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
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Application.VisualsLegend

Namespace: Spotfire.Dxp.Application.Visuals
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 65.0.19510.3242 (65.0.19510.3242)

Syntax

Copy

[SerializableAttribute]
[PersistenceVersionAttribute(56, 0)]
public sealed class Legend : DocumentNode

The Legend type exposes the following members.

Properties

	Name	Description
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	Dock	Gets or sets the docking of the legend.
	Font	Obsolete. Gets or sets the font of this legend.
	FontMetadata	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.
	MaxValuesPerLegendItem	Gets or sets the max values per legend item. This value controls how many legend items are shown before the list is truncated.
	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.

Top

Methods

	Name	Description
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

	Name	Description
	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.)
	ITransactionsExecuteInvisibleTransaction2	Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction	Implements ExecuteStickyTransaction(Guid, Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction2	Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction	Implements ExecuteTransaction(Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction2	Implements ExecuteTransaction(Executor) for the Action Mods API. (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: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8

Reference

Spotfire.Dxp.Application.Visuals Namespace