PlotLegend Object

The PlotLegend object is used to configure the legend associated with a PlotWindow object. This object is not creatable in script, but an instance is always created as a child object of the PlotWindow object, as seen in the example below:

Users cannot create instances of this type of object. However, users can access instances of this object type that have been created indirectly, for example as children of other objects. Users can also access any static properties and methods on this object type.

Available In Editions:

Timing Precision Mode

Name	Description	Attributes
BackgroundColor	Sets the current color of the background of the legend.	Type: Variable Access: Read/Write
BorderColor	Sets the current color of the border of the legend.	Type: Variable Access: Read/Write
BorderVisible	Sets whether or not the border around the legend is visible.	Type: Variable Access: Read/Write
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
Font	Provides access to the legend's font properties.	Type: PlotFont Access: Read/Write
Location	Sets the location of the legend. Possible choices are: Left, Right, Top, or Bottom.	Type: Variable Access: Read/Write
Name	The name displayed for this object in output windows such as views, plots, and reports.	Type: String Access: Read/Write
ObjectId	The unique identifier for the object.	Type: Variable Access: Read-Only
ObjectType	The type of the object.	Type: String Access: Read-Only
TextColor	Sets the current color of the title text within the legend.	Type: Variable Access: Read/Write
Title	Provides access to the legend's title properties.	Type: PlotTitle Access: Read/Write
Visible	Sets whether the legend is visible.	Type: Variable Access: Read/Write

Name	Description
ClearSavedStates	Clears previous saved states for this object.
GetFromFile	Load the object state from the specified FreeFlyer object file.
GetFromString	Load the object state from the specified string.
PutToFile	Convert the object state to FreeFlyer object xml and write to a file.
PutToString	Convert the object state to FreeFlyer object xml and return as a string.
ReferenceEquals	Returns 1 if the argument refers to the calling object and 0 otherwise.
Restore	Restore an object's state from a previously saved state.
Save	Save the object's state so that it can be restored later.

PlotLegend Object

Description

Available In Editions:

Timing Precision Mode