The legend object

Legend

Valid Parents: Domain

Valid Children: None

Legend resource tabs

Main
Title
Text
Style

Legend Resources

Main
- Type
  Legend Type
- Origin
  Position
  Alignment
- Background
  Background Color
  Frame Color
  Frame Width
- Multiple Legends
  Append Legend

Title
- Legend Title
  Title Text
  Font
  Height
  Color
  Boldness

Text
- Text
  X Text
  Y Text
  Unit Height
  Entry Height
  Font
  Color
  Boldness
- User-defined Text
  Undefined Text
  Class Text Data
  Below Text
  Above Text

Style
- Style
  Length Factor
  Size Mode
  X Scale Factor
  Y Scale Factor
  X Size
  Y Size
  Columns
  Order
  Trailing Zeros
  Interval Step
- Number Format
  Decimals
  Floating Point Format

The Legend object resources control the definition and appearance of a legend for the domain. Legends are always drawn on a 2D plane, even if the domain contains a 3D graph. Legends from different Domains can be combined by setting the resource XuNappendLegend.

New Resources

Legend Resource Set

Above Text (XuNaboveText)
A text string or a dataset containing a text string which is to be used in the legend box to replace the word "Above". Note that this is only used for the Stepped legend.

Type: string
Default: "Above"
Range:

Append Legend (XuNappendLegend)
This resource allows you to combine Chart legends from different domains into one Chart legend. By setting the value to On this domain's legend will be appended to all preceding legends which are disabled. The resulting legend will be treated as a single legend belonging to this domain.

Type: float
Default: true
Range: false,true

Background Color (XuNbackgroundColor)
The color of the background for the legend.

Type: float
Default: Unset
Range:

Below Text (XuNbelowText)
A text string or a dataset containing a text string which is to be used in the legend box to replace the word "Below". Note that this is only used for the Stepped legend.

Type: string
Default: "Below"
Range:

Class Dataset Text (XuNclassDatasetText)
A string dataset containing userlabels for each class entry in the legend.

Type: string
Default: Unset
Range: N/A

Color (XuNcolor)
The color of the legend text.

Type: float
Default: 1
Range:

Boldness (XuNentryBoldness)
The relative boldness of the text. The value must be in the range of 0. 20. and expresses a percentage of the character height. Vector fonts are by default represented by one pixel wide vectors on the screen and by a boldness of 10% of the character height on hardcopy devices. With polygon fonts, the boldness factor affects the outline of the fonts. By default the outline has no width. The character has a width but the line outlining it has no width. By setting the boldness factor, the width of the line surrounding the character is increased.

Type: float
Default: 1
Range: 0:20

Font (XuNentryFont)
The font for the legend text. The default font is determined by the textoption font resource. Refer to the font table for the UNICLD fonts.

Type: string
Default: Unset
Range: " simp", "carg", "cart", "cenb", "cobo", "comp", "coub", "couo", "cour", "cyri", "dupl", "futu", "gote", "gotg", "goti", "gree", "hebo", "helb", "helo", "helv", "ital", "matr", "psim", "scri", "simg", "sims", "smag", "smai", "smal", "swib", "swil", "swim", "tem", "tibi", "tibo", "tiit", "tiro", "trii", "trip", "utbi", "utob", "utoi", "utor", "vsim"

Entry Height (XuNentryHeight)
The height of the text and the descriptor marks in the legend box. The height is specified as a percentage of the minimum dimension of the 2D workbox, but the actual text is threefifths of the specified size.

Type: float
Default: 3
Range: 0:20

Length Factor (XuNentryLengthFactor)
Controls the length of the entry symbol. Only applicable to the chart legend type.

Type: float
Default: 2
Range: 0:20

Floating Point Format (XuNfloatingFormat)
The floating number format to be used for representing the class range values or magnitude values when XuNlegendType (Legend Type) is stepped, continuous, or vector. Possible options:

Label	Value	Description
X.X	"decimal"	Decimal number format. Example: 10.0
EE	"ee"	Scientific number format. Example: 1.0E+01
*10	"log10"	Log10 number format. Example: 1.0*10 1

Type: string
Default: "decimal"
Range: "decimal" ," ee" ," log10"

Frame Color (XuNframeColor)
The color of the frame surrounding the legend.

Type: float
Default: 1
Range:

Frame Width (XuNframeWidth)
The width of the frame surrounding the legend (in mm). To suppress the drawing of a frame this value can be set to 0.0.

Type: float
Default: Unset
Range: 0:5

Interval Step (XuNintervalStep)
The number of class range divisions each color swatch represents. By default, a color swatch is used for each division of the class range. Note that this is only used for the Stepped and Continuous legend.

Type: float
Default: 1
Range: 1:10

Position (XuNlegendOrigin)
The insertion coordinates of the legend. You set the X and Y position as a percentage of the dimension of the 2D workbox.

Type: float
Default: (105,0)
Range:

Legend Type (XuNlegendType)
Allows you to choose the type of legend to be drawn. Possible options:

Label	Value	Description
Chart	"chart"	For Line, Scatter, Bar, Pie, Polar Line, and Polar Scatter graph types; the legend contains a mark corresponding to the graph type and the dataset name beside it. For a Pie graph, XuNlabelLayoutTextLabelData (Text Label Data) must be specified.
Stepped	"stepped"	For grid and contour graphs; the legend separate entry for each data class limit.
Continuous	"continuous"	For grid and contour graphs; the legend shows a continuous color scale spanning the class limits.
Isoline	"isoline"	For contour graphs; the legend shows a colored line for each data class limit.
Vector	"vector"	For 2D Vector graphs; the legend contains the vector symbol and the magnitude of the vector. Two vector symbols for X and Y are used when the graph is scaled anisotropically.

Type: string
Default: Unset
Range: " chart" ," stepped" ,"continuous" ," isoline" ," vector"

Columns (XuNnumColumns)
The number of columns in the Chart and Vector legends. The legend items are presented row by row and from left to right. The number of columns in a row can be any number between 1 and 10.

Type: float
Default: 1
Range: 1:10

Decimals (XuNnumDecimals)
The number of decimal places to be used for representing the class range values or magnitude values drawn in the Stepped, Continuous and Vector legends. The choice can be any number between 0 and 9.

Type: float
Default: Unset
Range: 0:9

Order (XuNorder)
The presentation order of the legend items. Possible options:

Label	Value	Description
Ascending	"ascending"	For a Chart or Vector legend, the first item appears at the top lefthand corner of the legend and the last legend item at the bottom righthand corner. For a Stepped or Continuous legend, the highest class value appears at the top of the legend and the lowest class value at the bottom.
Descending	"descending"	The reverse of the ascending order.

Type: string
Default: "ascending"
Range: "ascending" ," descending"

Alignment (XuNoriginAlignment)
The legend justification. Possible options:

Label	Value	Description
Lower Left	"lowerLeft"	Insertion point is the lower left corner of the box.
Lower Center	"lowerCenter"	Insertion point is the lower center of the box.
Lower Right	"lowerRight"	Insertion point is the lower right corner of the box.
Upper Left	"upperLeft"	Insertion point is the upper left corner of the box.
Upper Center	"upperCenter"	Insertion point is the upper center of the box.
Upper Right	"upperRight"	Insertion point is the upper right corner of the box.

Type: string
Default: "lowerLeft"
Range: "lowerLeft" ," lowerCenter" ,"lowerRight" ," upperLeft" ,"upperCenter" ," upperRight"

Size Mode (XuNsymbolSizeMode)
The size mode of the vector legend symbol. Possible options:

Label	Value	Description
Scale Factor	"scaleFactor"	The vector legend symbol is scaled according to the X and Y scale factors.
Approximate Size	"approximateSize"	The vector legend symbol is first scaled according to the X and Y size values and the magnitudes are then scaled to a 'rounded number' with a single digit of between 1 and 9.
Exact Size	"exactSize"	The vector legend symbol is scaled according to the X and Y size values.

Type: string
Default: "scaleFactor"
Range: "scaleFactor" ,"approximateSize"," fixedSize"

X Scale Factor (XuNsymbolXScaleFactor)
A scale factor to scale up (greater than 1) or down (less than 1) the default size of the vector legend symbol in the X direction. This resource is also used to scale the vector legend symbol of the isotropic 2D Vector graph. The choice can be any positive value but it must not be greater than 100. The default size of the vector legend symbol is determined by two factors. The first factor is the size of the largest vector symbol in the corresponding 2D Vector graph. The second factor is that the magnitude of the vector legend symbol is always scale up to a 'nice number' with digits of 0, 1, 2 and 5. Note that this resource does not affect the size of the vector symbols in the corresponding 2D Vector graphs.

Type: float
Default: 1
Range: 0:100

Y Scale Factor (XuNsymbolYScaleFactor)
A scale factor to scale up (greater than 1) or down (less than 1) the default size of the vector legend symbol in the Y direction. The choice can be any positive value but it must not be greater than 100. See the explanation given in 'X Scale Factor' for more details.

Type: float
Default: 1
Range: 0:100

X Size (XuNsymbolXSize)
The size of the vector legend symbol in the X direction. This resource is also used for the vector legend symbol of the isotropic 2D Vector graph. The choice can be any positive value but it must not be greater than 100. The default size of the vector legend symbol is specified as a percentage of the minimum dimension of the 2D workbox. Note that this resource does not affect the size of the vector symbols in the corresponding 2D Vector graphs.

Type: float
Default: 10
Range: 0:100

Y Size (XuNsymbolYSize)
The size of the vector legend symbol in the Y direction. The choice can be any positive value but it must not be greater than 100. See the explanation given in 'X Size' for more details.

Type: float
Default: 10
Range: 0:100

Boldness (XuNtitleBoldness)
The relative boldness of the text. The value must be in the range of 0. 20. and expresses a percentage of the character height. Vector fonts are by default represented by one pixel wide vectors on the screen and by a boldness of 10% of the character height on hardcopy devices. With polygon fonts, the boldness factor affects the outline of the fonts. By default the outline has no width. The character has a width but the line outlining it has no width. By setting the boldness factor, the width of the line surrounding the character is increased.

Type: float
Default: 0
Range: 0:20

Color (XuNtitleColor)
The color for the legend title.

Type: float
Default: 1
Range:

Font (XuNtitleFont)
The font for the legend's title text. The default font is determined by the textoption font resource. Refer to the font table for the UNICLD fonts.

Type: string
Default: "Unsetsimp,'carg','cart',"
Range: " simp" ,"carg" ,"cart" ,"cenb" ,"cobo" ,"comp" ,"coub" ,"couo" ,"cour" ,"cyri" ,"dupl" ,"futu" ,"gote" ,"gotg" ,"goti" ,"gree" ,"hebo" ,"helb" ,"helo" ,"helv" ,"ital" ,"matr" ,"psim" ,"scri" ,"simg" ,"sims" ,"smag" ,"smai" ,"smal" ,"swib" ,"swil" ,"swim" ,"tem","tibi","tibo","tiit","tiro","trii","trip","utbi","utob","utoi","utor","vsim"

Height (XuNtitleHeight)
The height of the legend title.

Type: float
Default: 4
Range: 0.001:20

Title Text (XuNtitleText)
A text string or a dataset containing a text string which is to be drawn in the legend box as an explanatory text. It will be drawn at the top of the legend box.

Type: string
Default: Unset
Range: N/A

Trailing Zeros (XuNtrailingZeros)
Allows you to include or truncate trailing zeros of the magnitude values drawn in the Vector legend. Possible options:

Label	Value	Description
Truncated	"truncated"	All superfluous trailing zeros are removed from the fraction.
Untouched	"untouched"	All trailing zeros are drawn.
With Decimal	"withDecimal"	All trailing zeros are removed.
Without Decimal	"withoutDecimal"	All trailing zeros and the decimal point are removed.

Type: string
Default: "truncated"
Range: "truncated" ," untouched", "withDecimal", "withoutDecimal"

Undefined Text (XuNundefinedText)
A text string or a dataset containing a text string which is to be used in the legend box to replace the word 'Unset'. Note that this is only used for the Stepped and Continuous legend.

Type: float
Default: "Unset"
Range:

Unit Height (XuNunitTextHeight)
The height of the legend text associated with the vector legend symbol. The height is specified as a percentage of the minimum dimension of the 2D workbox.

Type: float
Default: 1.8
Range: 0.001:20

X Text (XuNxUnitText)
A text string giving the units denomination which will be appended to the magnitude of the vector in the X direction. This resource is also used for the unit text of the isotropic 2D Vector graph.

Type: string
Default: Unset
Range: N/A

Y Text (XuNyUnitText)
A text string giving the units denomination which will be appended to the magnitude of the vector in the Y direction.

Type: string
Default: Unset
Range: N/A

Inherited Resources

Controls Resource Set

Immutable (XuNimmutable)
This resource controls whether the object can be modified. Values are true (On) for nonmodifiable, or false (Off) for modifiable. By default it is set to modifiable. Setting this resource to on locks the currents settings for the object and disables any further changes to the object, including resetting this resource.

Type: float
Default: true
Range: false,true

Object Name (XuNname)
The name of the object. If not explicitly set, a default name with the format <class>_<id> will be generated.

Type: string
Default: Unset
Range: N/A

Object Enabled (XuNobjectEnabled)
This resource enables or disables the legend. This resource can be set to either true (On) to enable the object or false (Off) to disabled it.

Type: float
Default: false
Range: false,true

Include in Saved GSL (XuNsave)
This resource controls whether the object is included in saved GSL. Values are true (On) to include in saved GSL or false (Off) to omit from GSL. By default objects are included in saved GSL.

Type: float
Default: true
Range: false,true

User Data (XuNuserData)
A dataset name or pointer which the user can associate with the object. The dataset is for user use and will not be used by Gsharp.

Type: string
Default: Unset
Range: N/A

Return to Graphic Objects.