proc legendentry


Welcome     Gallery     Handbook


Manual page for proc_legendentry(PL)

DESCRIPTION

Defines one legend entry. This entry will be rendered the next time that proc legend is executed. Usually, legends are built by successive plotting procs having a legendlabel attribute. However, if additional flexibility is needed to make custom legend entries, this proc may be used, one or more times.

For example, if a scatterplot is being created with various sized points, there is no automatic way to get a legend of the various point sizes, so proc legendentry could be executed (probably several times) to define legend information, then proc legend could be executed to render it.

EXAMPLE

See the gallery example scatterplot3a

PREREQUISITES

None.

MANDATORY ATTRIBUTES

None.

ATTRIBUTES

sampletype t

The type of sample to be displayed with the entry. t may be one of: line, color , symbol , text , line+symbol , or text+symbol, or none.
none may be used to insert spacing or text headers/separators into the legend.
Example: sampletype: text

label text

The label for the entry. Example: label: Eastern counties

tag string

An optional short identifier to be associated with the entry, so that the entry can be accessed later. Used with proc bars colorfield, as in this example: colorfld

details text

Details regarding the rendering of the sample. What this is depends on the sampletype.

For line, a linedetails specification should be given.

For color, a color should be given.

For symbol, a symboldetails specification should be given.

For text, the character or word should be given here, and a textdetails specification may be given using the details2 attribute.

For line+symbol, a linedetails specification should be given here, and a symboldetails specification given using the details2 attribute.

For text+symbol, the character or word should be given here, a textdetails specification should be given using the details2 attribute, and a symboldetails specification given using the details3 attribute.

If sampletype is none, nothing should be given for this attribute.

details2 text

Secondary details attribute. See details above.

details3 text

See details above.


data display engine  
Copyright Steve Grubb


Markup created by unroff 1.0,    July 12, 2001.