#set TITLE = "proc legendentry"
#include top

.SH DESCRIPTION
Defines one legend entry.
This entry will be rendered the next time that 
\fBproc legend\fR is executed.
Usually, legends are built by successive plotting procs
having a \fClegendlabel\fR attribute.  However, if additional
flexibility is needed to make custom legend entries, this
proc may be used, one or more times.
.LP
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 \fBproc legendentry\fR could be executed (probably several 
times) to define legend information, then \fBproc legend\fR could be
executed to render it.

.SH EXAMPLE
See the gallery example
.ig >>
<a href="../gallery/scatterplot3a.html">
.>>
scatterplot3a 
.ig >>
</a>
.>>

.SH PREREQUISITES
None.

.SH MANDATORY ATTRIBUTES
None.  


.SH ATTRIBUTES

.LP
\fBsampletype\fR \fIt\fR
.IP
The type of sample to be displayed with the entry.
\fIt\fR may be one of:
\fCline\fR, \fCcolor\fR , \fCsymbol\fR , \fCtext\fR , \fCline+symbol\fR , or 
\fCtext+symbol\fR, or \fCnone\fR.
.br
\fCnone\fR may be used to insert spacing or text headers/separators into the legend.
.br
Example: \fCsampletype: text\fR

.LP
\fBlabel\fR  
.ig >>
<a href="attributetypes.html#text">
.>>
\fI text \fR
.ig >>
</a>
.>>
.IP
The label for the entry.
Example: \fClabel: Eastern counties\fR

.LP
\fBtag\fR
#set FILE = "attributetypes.html#string"
#set TAG = "\\fI string \\fR"
#include link
.IP
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:
#set FILE = "../gallery/colorfld.htm"
#set TAG = "colorfld"
#include link


.LP
\fBdetails\fR  
.ig >>
<a href="attributetypes.html#text">
.>>
\fI text \fR
.ig >>
</a>
.>>
.IP
Details regarding the rendering of the sample.
What this is depends on the \fCsampletype\fR.  

.IP
For \fCline\fR, a 
.ig >>
<a href="linedetails.html">
.>>
\fI linedetails \fR
.ig >>
</a>
.>>
specification should be given.

.IP
For \fCcolor\fR, a 
.ig >>
<a href="color.html">
.>>
\fI color \fR
.ig >>
</a>
.>>
should be given.

.IP
For \fCsymbol\fR, a 
.ig >>
<a href="symboldetails.html">
.>>
\fI symboldetails \fR
.ig >>
</a>
.>>
specification should be given.

.IP
For \fCtext\fR, the character or word should be given here, and a
.ig >>
<a href="textdetails.html">
.>>
\fI textdetails \fR
.ig >>
</a>
.>>
specification may be given using the \fCdetails2\fR attribute.

.IP
For \fCline+symbol\fR, a 
.ig >>
<a href="linedetails.html">
.>>
\fI linedetails \fR
.ig >>
</a>
.>>
specification should be given here,
and a 
.ig >>
<a href="symboldetails.html">
.>>
\fI symboldetails \fR
.ig >>
</a>
.>>
specification given using the \fCdetails2\fR attribute.

.IP
For \fCtext+symbol\fR, the character or word should be given here, a 
.ig >>
<a href="textdetails.html">
.>>
\fI textdetails \fR
.ig >>
</a>
.>>
specification should be given using the \fCdetails2\fR attribute,
and a 
.ig >>
<a href="symboldetails.html">
.>>
\fI symboldetails \fR
.ig >>
</a>
.>>
specification given using the \fCdetails3\fR attribute.

.IP
If \fCsampletype\fR is \fCnone\fR, nothing should be given for this attribute.

.LP
\fBdetails2\fR  
.ig >>
<a href="attributetypes.html#text">
.>>
\fI text \fR
.ig >>
</a>
.>>
.IP
Secondary details attribute.  See \fCdetails\fR above.

.LP
\fBdetails3\fR  
.ig >>
<a href="attributetypes.html#text">
.>>
\fI text \fR
.ig >>
</a>
.>>
.IP
See \fCdetails\fR above.

#include bottom
