Legend Properties

These properties control legend annotations. For each property, the type of control and the values that can be assigned are listed, along with the property identifier and allowed values for use by the iTools Procedural Interface. For a description of how a particular control is used, refer to Property Controls.

Figure D-32: Visualization Browser with Legend Properties Displayed

Note
This section discusses the properties of the legend container, which can contain multiple legend items of different types. The individual legend types are described in:
Legend Contour Items
Legend Contour Level Items
Legend Plot Items
Legend Surface Items

Table D-71: Legend Properties
Interface: Property Name	Control Type: Values	API: Property Identifier	API: Allowed Values
Layout	String List: Arrange the legend elements in columns or rows. Select a layout from the list. Choose from these values: Columns Rows Default = Columns	ORIENTATION	(0) Columns (1) Rows
Sample width	Number: Width in normalized units of the element sample that appears in the legend box. Range = `0.0` to `0.5`. Move the slider to change the value. Default = `0.15`	SAMPLE_WIDTH	Floating point value from 0.0 to 0.5.
Horizontal spacing	Number: Space in normalized units between samples and text in the legend box. Range = `0.0` to `0.25`. Move the slider to change the value. Default = `0.02`	HORIZONTAL_SPACING	Floating point value from 0.0 to 0.25.
Vertical spacing	Number: Space in normalized units between lines in the legend box. Move the slider to change the value. Default = `0.02`	VERTICAL_SPACING	Floating point
Text color	Color: Color to be used for the legend text. Click to choose from the default color palette, or specify RGB values. Default = `[0,0,0]` (black)	TEXT_COLOR	3D integer array of the form: [R, G, B] Each color value may range from 0 to 255.
Z value	Number: Z value of plane on which to project the legend. Edit the number to change the value. Default = `0`	ZVALUE	Floating point value
Text font	String List: Font used for legend text. Select a font from the list. Choose from these values: Helvetica Courier Times Symbol Hershey 3 Simplex In addition to the above standard fonts, you will also have available all of the other Hershey fonts as well as any TrueType fonts available to IDL. Default = Helvetica	FONT_INDEX	The following values are valid for all platforms: 0 (Helvetica--default) 1 (Courier) 2 (Times) 3 (Symbol) 4 (Hershey 3 Simplex) There may be other Hershey and TrueType fonts available, but the list values are system-dependent.
Text style	String List: Style used for legend text. Select a style from the list. Choose from these values: Normal Bold Italic Bold italic Default = Normal	FONT_STYLE	0 (Normal--default) 1 (Bold) 2 (Italic) 3 (Bold italic)
Text font size	Number: Font size in points for the legend text. Edit the number to change the size. Default = 10	FONT_SIZE	Integer
Color	Color: Color to use for the legend border. Legend object must be deselected for border attributes to be visible. Click to choose from the default color palette, or specify RGB values. Default = `[0,0,0]` (black)	COLOR	3D integer array of the form: [R, G, B] Each color value may range from 0 to 255.
Linestyle	Line Style: Style of the legend border. Select a line style from the list. Default = (solid line)	LINESTYLE	An integer value specifying a predefined line style, or a two-element vector specifying a stippling pattern. The predefined line styles are: 0 (Solid line--the default) 1 (Dotted) 2 (Dashed) 3 (Dash dot) 4 (Dash dot dot dot) 5 (Long dash) 6 (No line drawn) To define your own stippling pattern, specify a two-element vector [repeat, bitmask], where repeat indicates the number of times consecutive runs of 1's or 0's in the bitmask should be repeated. (That is, if three consecutive 0's appear in the bitmask and the value of repeat is 2, the line will have six consecutive bits turned off.) The value of repeat must be in the range 1 <= repeat <= 255. The bitmask indicates which pixels are drawn and which are not along the length of the line. Bitmask is most conveniently specified as a 16-bit hexadecimal value. For example, LINESTYLE = [2, 'F0F0'X] describes a dashed line (8 bits on, 8 bits off, 8 bits on, 8 bits off).
Thickness	Line Thickness: Thickness of the legend border in points. Select a thickness from the list. Default = `1`	THICK	A floating-point value between 1.0 (the default) and 10.0.
Fill background	Boolean: Fill legend background? Choose True or False. Default = True	FILL_BACKGROUND	0 (Do not fill legend background) 1 (Fill legend background)
Fill color	Color: Color to be used for the background. For background color to display, Fill Background property must be set to True. Click to choose from the default color palette, or specify RGB values. Default = `[255,255,255]` (white)	FILL_COLOR	3D integer array of the form: [R, G, B] Each color value may range from 0 to 255.
Transparency	Number: Transparency of the background fill from 0% to 100% Move the slider to change the value. Default = 0%	TRANSPARENCY	Integer value from 0 to 100.