dx-doc 1:4.4.4-9 / usr / share / doc / dx / help / dxall883

#!F-adobe-helvetica-medium-r-normal--18*
#!N 
#!N 
 #!Rlegend Legend #!N #!N Category #!N #!N  #!Lcatann,dxall752 h Annotation  #!EL  #!N #!N Function 
#!N #!N Creates a legend #!N #!N Syntax #!CForestGreen #!N #!N 
 #!F-adobe-courier-bold-r-normal--18*   #!N  #!F-adobe-times-bold-r-normal--18*   legend #!EF = Legend(  #!F-adobe-times-bold-r-normal--18*   stringlist,colorlist, position, shape, 
#!N horizontal, label, colors, annotation, labelscale, font #!EF ); #!EF #!N 
#!N #!EC #!N #!N Inputs #!T,1,91,276,461,646  #!F-adobe-times-medium-r-normal--14*    #!F-adobe-times-bold-r-normal--18*   #!N TAB Name 
TAB Type TAB Default TAB Description #!EF #!N TAB stringlist TAB 
string list TAB none TAB list of strings for legend #!N 
TAB colorlist TAB field, vector list, or string list TAB none 
TAB list of colors for legend #!N TAB position TAB vector 
TAB [0.95, 0.95] TAB the position of the color bar (in 
#!N TAB - TAB - TAB - TAB viewport-relative coordinates) #!N 
TAB shape TAB vector TAB [300 25] TAB length and width 
of the color bar #!N TAB - TAB - TAB - 
TAB (in pixels) #!N TAB horizontal TAB flag TAB 0 TAB 
0: vertical orientation #!N TAB - TAB - TAB - TAB 
1: horizontal orientation #!N TAB label TAB string TAB no defaults 
TAB label for color bar #!N TAB colors TAB vector list 
or string list TAB appropriate TAB colors for annotation #!N TAB 
annotation TAB string list TAB "all" TAB annotation objects to be 
colored #!N TAB labelscale TAB scalar TAB 1.0 TAB scale factor 
for labels #!N TAB font TAB string TAB standard TAB font 
for labels #!N TAB - TAB - TAB - TAB #!EF 
#!N #!N Outputs #!T,1,161,321,646  #!F-adobe-times-medium-r-normal--14*    #!F-adobe-times-bold-r-normal--18*   #!N TAB Name TAB Type 
TAB Description #!EF #!N TAB legend TAB color field TAB the 
legend #!N TAB - TAB - TAB #!EF #!N #!N Functional 
Details #!N #!N This module creates a legend associating a set 
of strings with a set of colors. The legend generated by 
this module can be collected with the rest of the objects 
in a scene (by using a Collect module) and incorporated into 
an image. #!N #!I0 #!N #!N #!I0 #!N  #!F-adobe-times-bold-r-normal--18*    #!F-adobe-times-bold-r-normal--18*   stringlist 
#!EF #!EF #!I50 #!N is a list of strings for the 
legend #!N #!I0 #!N  #!F-adobe-times-bold-r-normal--18*    #!F-adobe-times-bold-r-normal--18*   colorlist #!EF #!EF #!I50 #!N 
is a colormap, a list of rgb vectors, or a list 
of color name strings (see  #!Lcolor,dxall792 h Color  #!EL  for a discussion of valid 
color name strings). If  #!F-adobe-times-bold-r-normal--18*   colorlist #!EF is a list of 
rgb vectors or a list of color name strings, then the 
length of  #!F-adobe-times-bold-r-normal--18*   colorlist #!EF must be the same as the 
length of  #!F-adobe-times-bold-r-normal--18*   stringlist #!EF . If  #!F-adobe-times-bold-r-normal--18*   colorlist #!EF is 
a colormap (see  #!Lcolor,dxall792 h Color  #!EL  for a description of a color map), 
then the colors are taken to be the values in  #!F-adobe-times-bold-r-normal--18*   
colorlist #!EF corresponding to the integers 0, ... n-1 where n 
is the number of items in  #!F-adobe-times-bold-r-normal--18*   stringlist #!EF . Thus, 
for example, AutoColor or Color can be applied to a categorized 
string data set (see  #!Lcategor,dxall782 h Categorize  #!EL  ), and the colormap used can 
be directly passed to Legend to associate the appropriate colors with 
the categorized strings. #!N #!I0 #!N  #!F-adobe-times-bold-r-normal--18*    #!F-adobe-times-bold-r-normal--18*   position #!EF #!EF 
#!I50 #!N is a 2-dimensional vector (or a 3-dimensional vector whose 
 #!F-adobe-times-medium-i-normal--18*   z #!EF -component is ignored) indicating the position of the 
legend in the final image. In viewport-relative coordinates, [0 0] places 
the legend at the lower left, and [1 1] at the 
upper right. These same coordinates determine the reference point that is 
used to position the legend relative to its placement in the 
image (e.g., for  #!F-adobe-times-bold-r-normal--18*   position #!EF = [0 0], the lower 
left corner of the legend is placed in the lower left 
corner of the image). #!N #!I0 #!N  #!F-adobe-times-bold-r-normal--18*    #!F-adobe-times-bold-r-normal--18*   shape #!EF 
#!EF #!I50 #!N is a 2-vector that specifies the length and 
width of the legend , in pixels. For both horizontal and 
vertical orientations, the first element of the vector is the length 
and the second is the width. #!N #!I0 #!N  #!F-adobe-times-bold-r-normal--18*    #!F-adobe-times-bold-r-normal--18*   
horizontal #!EF #!EF #!I50 #!N determines whether the orientation of the 
legend is vertical (0) or horizontal (1). #!N #!I0 #!N  #!F-adobe-times-bold-r-normal--18*   
 #!F-adobe-times-bold-r-normal--18*   label #!EF #!EF #!I50 #!N specifies a user-supplied label for 
the legend. #!N #!I0 #!N  #!F-adobe-times-bold-r-normal--18*    #!F-adobe-times-bold-r-normal--18*   colors #!EF  #!F-adobe-times-medium-r-normal--18*   and 
#!EF #!EF  #!F-adobe-times-bold-r-normal--18*   annotation #!EF #!I50 #!N set the colors of 
certain components of the legend. #!N #!N  #!F-adobe-times-bold-r-normal--18*   colors #!EF can 
be a single color (RGB vector or color-name string) or a 
list. The color-name string must be one of the defined color 
names (see  #!Lcolor,dxall792 h Color  #!EL  ). #!N #!N  #!F-adobe-times-bold-r-normal--18*   annotation #!EF can be 
a single string or a list of strings, chosen from the 
following: "all," "frame," "labels," and "ticks." #!N #!N If  #!F-adobe-times-bold-r-normal--18*   annotation 
#!EF is not specified or is "all"--  #!F-adobe-times-medium-i-normal--18*   and #!EF if 
 #!F-adobe-times-bold-r-normal--18*   colors #!EF is a single string--then  #!F-adobe-times-bold-r-normal--18*   colors #!EF is 
used for all color-bar annotation. Otherwise the number of colors must 
match the number of annotation strings exactly. The default frame color 
is "clear." #!N #!I0 #!N  #!F-adobe-times-bold-r-normal--18*    #!F-adobe-times-bold-r-normal--18*   labelscale #!EF #!EF #!I50 
#!N determines the size of the axes and tick-mark labels. For 
example,  #!F-adobe-times-bold-r-normal--18*   labelscale #!EF = 2.0 will display the labels at 
double their default size. #!N #!I0 #!N  #!F-adobe-times-bold-r-normal--18*    #!F-adobe-times-bold-r-normal--18*   font #!EF 
#!EF #!I50 #!N specifies the font used for axes and tick-mark 
labels. You can specify any of the defined fonts supplied with 
Data Explorer. These include a variable-width font ("variable," the default for 
axes labels) and a fixed-width font ("fixed," the default for tick-marks 
labels). #!CForestGreen #!N #!N  #!F-adobe-courier-bold-r-normal--18*   #!N area gothicit_t pitman roman_ext #!N 
cyril_d greek_d roman_d script_d #!N fixed greek_s roman_dser script_s #!N gothiceng_t 
italic_d roman_s variable #!N gothicger_t italic_t roman_tser #!EF #!N #!N #!EC 
For more information, see  #!Lapc,dxall746 h Data Explorer Fonts  #!EL  in IBM Visualization Data Explorer User's 
Guide. #!I0 #!N #!N #!N #!N Example Visual Programs #!CForestGreen #!N 
#!N  #!F-adobe-courier-bold-r-normal--18*   #!N HomeOwn.net #!N Legend.net #!N SalesOnStates.net #!EF #!N #!N 
#!EC #!N #!N See Also #!N #!N  #!Lscalscr,dxall935 h ScaleScreen  #!EL  ,  #!Lcolor,dxall792 h Color  #!EL  , 
 #!Lcolorba,dxall793 h ColorBar  #!EL  ,  #!Lcategor,dxall782 h Categorize  #!EL  #!N #!N #!N  #!F-adobe-times-medium-i-normal--18*   Next Topic #!EF #!N 
#!N  #!Llight,dxall884 h Light  #!EL  #!N  #!F-adobe-times-medium-i-normal--18*   #!N