.ig >>
<STYLE TYPE="text/css">
<!--
        A:link{text-decoration:none}
        A:visited{text-decoration:none}
        A:active{text-decoration:none}
-->
</STYLE>
<title>ploticus: attribute types - reference</title>
<body bgcolor=D0D0EE vlink=0000FF>
<br>
<br>
<center>
<table cellpadding=2 bgcolor=FFFFFF width=550 ><tr>
<td>
  <table cellpadding=2 width=550><tr>
  <td><br><h2>Attribute types - reference</h2></td>
  <td align=right>
  <small>
  <a href="../doc/Welcome.html"><img src="../doc/ploticus.gif" border=0></a><br>
  <a href="../doc/Welcome.html">Welcome</a> &nbsp; &nbsp;
  <a href="../gallery/index.html">Gallery</a> &nbsp; &nbsp;
  <a href="../doc/Contents.html">Handbook</a> 
  <td></tr></table>
</td></tr>
<td>
<br>
<br>
.>>

.TH Attribute_types_-_reference PL "15-MAY-2002   PL ploticus.sourceforge.net"

.SH DESCRIPTION
Many of the various attributes are of
standard types.  These types are described here, for reference.

.ig >>
<a name=positionunits></a>
.>>
.ig >>
<br><br><br>
.>>
.SH POSITION UNITS
\fBAbsolute\fR space is measured in inches (or centimeters if
set in the 
.ig >>
<a href="config.html">
.>>
\0config file
.ig >>
</a>
.>>
,
.ig >>
<a href="settings.html">
.>>
\0proc settings
.ig >>
</a>
.>>
,
or using the \fC-cm\fR command line option).  
Origin is always the \fBlower-left\fR
corner of the page/drawing area.
.LP
\fBScaled\fR space is measured in whatever units have been
defined with a \fBproc areadef\fR.
.LP
For more information, see
.ig >>
<a href="scaleunits.html">
.>>
\0scaleunits
.ig >>
</a>
.>>

.ig >>
<br><br><br>
.>>

.SH ATTRIBUTE TYPES
The basic attribute types, listed from simplest to most complex, are:


.LP
.ig >>
<a name=n></a>
.>>
.LP
\fBn\fR
.IP
A single number.  
May be floating point or integer.  
.br
Example: \fCOffset: 3.2\fR

.LP
.ig >>
<a name=dfield></a>
.>>
.LP
\fBdfield\fR
.IP
A reference to a field in the plot data.
Plot data must have already been read using \fBproc getdata\fR.
A \fBdfield\fR may be an integer (\fB1\fR or greater), e.g.
\fC1\fR would refer to the first data field.
If field names have been defined in \fBproc getdata\fR,
\fBdfield\fR may also be one of the defined names.

.LP
.ig >>
<a name=plotvalue></a>
.>>
.LP
\fBplotvalue\fR
.IP
A plottable value given the scaling and ranges that have been
set up with the most recent \fBproc areadef\fR.
See the above description of 
.ig >>
<a href="#positionunits">
.>>
\0position units
.ig >>
</a>
.>>

.LP
.ig >>
<a name=locvalue></a>
.>>
.LP
\fBlocvalue\fR
.IP
A number or value that 
describes a location or length.
May be either absolute units or scaled units.
.IP
If a suffix of \fC(s)\fR is attached to the end 
of the number, the number is taken as being in scaled 
space, and must be a plottable value (a number for numeric scaling,
a date where date scaling is being used, etc.)
.IP
If the number does not have a (s) suffix, it is interpreted as 
being in absolute space.  
.IP
Special operators: \fCmin\fR may be used to indicate the
minima of a defined plot area, and \fCmax\fR to indicate the maxima.
.IP
Offsets: A +/- offset may be given after the value
(no embedded spaces allowed).  The offset is always an
absolute value.  
Note that it is impossible to specify a negative offset when using date scaling
with a date notation that uses embedded dashes such as mm-dd-yyyy.
See the examples below.
.IP
See the above description of 
.ig >>
<a href="#positionunits">
.>>
position units
.ig >>
</a>
.>>
.IP
Example: \fC3.5\fR = 3.5 absolute units (inches or centimeters).
.br
Example: \fC142(s)\fR = 142 in scaled units (whatever was defined in the
most recent areadef).
.br
Example: \fCmin\fR = the plot area minima
.br
Example: \fCmin-0.1\fR = 0.1 inch below plot area minima
.br
Example: \fC23jan98(s)+0.5\fR = 0.5 inch above the point where 23jan98 (in scaled units) would lie

.LP
.ig >>
<a name=lenvalue></a>
.>>
.LP
\fBlenvalue\fR
.IP
Uses same notation as \fBlocvalue\fR except that it 
describes a distance rather than a location.  
Distances may be given in absolute units or scaled "basic" units
(e.g. for date and datetime this should be a value in days; 
for time scaling this should be a value in minutes).
See the above description of 
.ig >>
<a href="#locvalue">
.>>
locvalue
.ig >>
</a>
.>>

.LP
.ig >>
<a name=xy></a>
.>>
.LP
\fBx y\fR
.IP
A coordinate pair.  Both \fIx\fR and \fIy\fR are \fBlocvalues\fR.
See the above description of 
.ig >>
<a href="#locvalue">
.>>
locvalue
.ig >>
</a>
.>>
.br
Example: \fCLocation: 5.3 1\fR


.LP
.ig >>
<a name=printfspec></a>
.>>
.LP
\fBprintf-spec\fR
.IP
A format specifier as used in the "C" programming language,
used to control the display of numeric values.  Here are some
examples; for more information check any good C language reference.
Ploticus generally uses \fC%g\fR as the default spec, which
displays numbers using the shortest possible 
representation, and generally switches to scientific notation on
very large numbers or very small numbers.
.nf
printf-spec		typical results
-----------		-----------------------------------
%7.0f			500000   4500000
%5.2f			239.62   8491.50
$%.2f			$82.54
$%6.2f			$ 82.54
%3.0f%%			44%
.fi

.LP
.ig >>
<a name=string></a>
.>>
.LP
\fBstring\fR
.IP
A character string value containing no embedded white space.  All
white space before and after the string is discarded.  

.LP
.ig >>
<a name=text></a>
.>>
.LP
\fBtext\fR
.IP
A character string value that may contain embedded white space.
The specification may not occupy more than one line, however embedded 
newlines (specified as \fC\\n\fR) may be used to indicate that output should
have multiple lines.
.br
Example:
\fCYaxis.label: Number of Attempts\\nBefore Success\fR

.LP
.ig >>
<a name=multiline></a>
.>>
.LP
\fBmultilinetext\fR
.IP
Text that may be specified using one or more lines.
The last line of the text is indicated by a blank (zero-length) line.  \fB A common error 
is to forget to leave a blank line and hence get incorrect results.\fR
Blank lines that are to be part of the text may be escaped 
using a backslash (\\).
Leading whitespace (normally stripped off) may be retained by using a backslash (\\),
followed by the desired whitespace, followed by text (see 3rd example below).
.br
.nf
.ft C
Title: Comparison of Survey Techniques 
     By Region 
     \\
     Fall, 1997
.fi
.ft R
.IP
It is also ok to leave the first line blank as in the following 
example:
.nf
.ft C
Title: 
Comparison of Survey Techniques 
By Region 
\\
Fall, 1997
.fi
.ft R
.IP
Here's an example where leading whitespace is preserved:
.nf
text:
  Data: 0.08 0.10 0.15 0.17 0.24 0.34 0.38 0.42 0.49 0.50 0.70 
  \\      0.94 0.95 1.26 1.37 1.55 1.75 3.20 6.98 50.57

.fi


.ig >>
<br><br><br>
.>>

.SH RELATED TO GRAPHICS RENDERING
.LP
\fBpointsize\fR
.IP
An integer point size (usable range is 5 - 30 or so).

.LP
\fBfont\fR
.IP
A postscript font name.

.LP
\fBcolor\fR see 
.ig >>
<a href="color.html">
.>>
\0color
.ig >>
</a>
.>>

.LP
\fBtextdetails\fR see 
.ig >>
<a href="textdetails.html">
.>>
\0textdetails
.ig >>
</a>
.>>


.LP
\fBlinedetails\fR see 
.ig >>
<a href="linedetails.html">
.>>
\0linedetails
.ig >>
</a>
.>>

.LP
\fBsymboldetails\fR see 
.ig >>
<a href="symboldetails.html">
.>>
\0symboldetails
.ig >>
</a>
.>>

.LP
\fBconditional expression\fR see 
.ig >>
<a href="condex.html">
.>>
\0condex
.ig >>
</a>
.>>

.ig >>
<br>
<br>
</td></tr>
<td align=right>
<a href="../doc/Welcome.html">
<img src="../doc/ploticus.gif" border=0></a><br><small>data display engine &nbsp; <br>
<a href="../doc/Copyright.html">Copyright Steve Grubb</a>
<br>
<br>
<center>
<img src="../gallery/all.gif">
</center>
</td></tr>
</table>
.>>
