About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Class Legend

Representation of a plot legend. The legend is a key to the features (that is, symbols or pictures) used in the plot.

Since

2.0

Hierarchy (view full)

DocumentNode
- Legend

Implements

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Context Dock FontMetadata IsAttached Items MaxValuesPerLegendItem Transactions Visible Width

Methods

Cast

Cast<T1, T2>(this, type): T1
Casts this object to the specified type. Throws error on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from DocumentNode.Cast

Equals

Equals(obj): boolean
Determines whether the specified object is equal to the current object.
Parameters
- obj: any
  The object to compare with the current object.
Returns boolean
true if the specified object is equal to the current object; otherwise, false.

Inherited from DocumentNode.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from DocumentNode.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from DocumentNode.ToString

TryCast

TryCast<T1, T2>(this, type): null | T1
Casts this object to the specified type. Returns null on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from DocumentNode.TryCast

`Static`Equals

Equals(objA, objB): boolean
Determines whether the specified object instances are considered equal.
Parameters
- objA: any
  The first object to compare.
- objB: any
  The second object to compare.
Returns boolean
true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Inherited from DocumentNode.Equals

Default capability

Context

get Context(): INodeContext
Gets the context of this node.

Returns INodeContext
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Context

Dock

get Dock(): LegendDock
Gets or sets the docking of the legend.

Returns LegendDock
Since
2.0
set Dock(value): void
Parameters
- value: LegendDock
Returns void

FontMetadata

get FontMetadata(): FontMetadata
Gets or sets the font of this legend.

Returns FontMetadata
Since
2.0
set FontMetadata(value): void
Parameters
- value: FontMetadata
Returns void

IsAttached

get IsAttached(): boolean
Gets a value indicating whether this node is attached.

Returns boolean
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.IsAttached

Items

get Items(): LegendItemCollection
Gets the collection of legend items in this legend.

Returns LegendItemCollection
Since
2.0

MaxValuesPerLegendItem

get MaxValuesPerLegendItem(): number
Gets or sets the max values per legend item. This value controls how many legend items are shown before the list is truncated.

Returns number
Since
2.0
set MaxValuesPerLegendItem(value): void
Parameters
- value: number
Returns void

Transactions

get Transactions(): ITransactions
Gets a collection of methods for executing transactions on the document.

Returns ITransactions
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Transactions

Visible

get Visible(): boolean
Gets or sets a value indicating whether or not this Spotfire.Dxp.Application.Visuals.Legend is visible.

Returns boolean
Since
2.0
set Visible(value): void
Parameters
- value: boolean
Returns void

Width

get Width(): number
Gets or sets the width, in pixels, of the legend as it is displayed in the user interface.

Returns number
Since
2.0
set Width(value): void
Parameters
- value: number
Returns void