.ig >>
<STYLE TYPE="text/css">
<!--
        A:link{text-decoration:none}
        A:visited{text-decoration:none}
        A:active{text-decoration:none}
        OL,UL,P,BODY,TD,TR,TH,FORM { font-family: arial,helvetica,sans-serif;; font-size:small; color: #333333; }

        H1 { font-size: x-large; font-family: arial,helvetica,sans-serif; }
        H2 { font-size: large; font-family: arial,helvetica,sans-serif; }
        H3 { font-size: medium; font-family: arial,helvetica,sans-serif; }
        H4 { font-size: small; font-family: arial,helvetica,sans-serif; }
-->
</STYLE>
<title>ploticus: proc image</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>proc image</h2></td>
  <td align=right>
  <small>
  <a href="../doc/welcome.html"><img src="../doc/ploticus.gif" border=0></a><br>
  Version 2.40 Jan'08
     </small><br><a href="../doc/scripthome.html">Scripts</a>
  <td></tr></table>
</td></tr>
<td>
<br>
<br>
.>>

.TH proc_image PL "15-JAN-2008   PL ploticus.sourceforge.net"


.LP
\fBproc image\fR integrates an external PNG/GIF/JPG image file (containing a logo for example) into the ploticus result.  
This proc was formerly called proc import, and the old name will continue to map to this proc.

.LP
.ig >>
<center><a href="../gallery/logoimages.htm"><img src="../gallery/logoimages.gif"></a></center>
.>>
.LP

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

\fBIf you are producing PNG/GIF/JPG output\fR, the image is imported by ploticus and integrated into the output result as 
it is generated.  Ploticus does not convert image types... the import image type \fBmust\fR be the same as your result image type
(ploticus does not check image file types of file name extensions to enforce this).

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

\fBIf you are producing SVG\fR, ploticus simply adds an <image> tag to the svg output (which contains an xlink to the filename), 
and the image will be loaded when the SVG is viewed.  Presumably, images of any type (PNG/GIF/JPG) can be viewed this way.  
The \fCwidth\fR and \fCheight\fR of the image should be specified so that alignment can be executed correctly.  

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

If you're producing other output formats, a gray placeholder box will be drawn to show the image placement location, but
the image will not be displayed.

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

.SH Attributes
The \fCfile\fR and \fClocation\fR attributes \fBmust\fR be supplied.  
The \fCwidth\fR and \fCheight\fR attributes should always be specified.

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

.LP
\fBfile\fR 
.ig >>
&nbsp; &nbsp;
.>>
\fIpathname\fR
.IP \0
The pathname of the image to import.
With PNG/GIF/JPG this filename should be specified relative to the working directory that ploticus is running in.
With SVG, the image file will be loaded when the svg is viewed and should be relative to the .svg file.


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

.LP
\fBlocation\fR  
.ig >>
&nbsp; &nbsp;
.>>
.ig >>
<a href="attributetypes.html#xy">
.>>
\0 x y 
.ig >>
</a>
.>>
.IP \0
Determines where the imported image should be placed (see also \fCalign\fR below).

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

.LP
\fBalign\fR  
.ig >>
&nbsp; &nbsp;
.>>
\fCtopcenter | center | topleft | bottomleft\fR
.IP \0
Alignment of image relative to \fClocation\fR.
Default is \fCtopleft\fR.
.IP 
\fCtopleft\fR positions the image with its top left at \fIx, y\fR;
.br
\fCtopcenter\fR positions the imported image with its top-center at \fIx, y\fR
.br
\fCcenter\fR centers the image around \fIx, y\fR horizontally and vertically;
.br
\fCbottomleft\fR positions the image with its bottom left at \fIx, y\fR.

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

.LP
\fBwidth\fR
.ig >>
&nbsp; &nbsp;
.>>
npixels
.br
\fBheight\fR
.ig >>
&nbsp; &nbsp;
.>>
npixels
.IP \0
The imported image will be rendered at this width and height.  These values are in PNG/GIF/JPG pixels, which
are 100 per inch.  Best practice is to always specify
(but does not need to be specified when rendering PNG/GIF/JPG and clickmap is not being done).

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

.LP
\fBscale\fR  
.ig >>
&nbsp; &nbsp;
.>>
\fIs\fR
.IP \0
Scale factor to apply when rendering the image.  
\fBAs of 2.40 this attribute is no longer supported\fR... use width and height (above) to control the size.

.ig >>
<br><br>
.>>
.LP
\fBclickmapurl\fR \fIurl\fR
.IP \0
If generating a
.ig >>
<a href="clickmap.html">
.>>
\0clickmap,
.ig >>
</a>
.>>
this specifies the url that users will go to when they click on the image.

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

.LP
\fBclickmaplabel\fR \fIlabel\fR
.IP
If generating a
.ig >>
<a href="clickmap.html">
.>>
\0client-side clickmap,
.ig >>
</a>
.>>
this specifies a mouseover text labels that the user will see when they hover their mouse over the image.


.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>
<br>
<center>
Ploticus is hosted at http://ploticus.sourceforge.net <br>
<img src="http://sourceforge.net/sflogo.php?group_id=38453" width="88" height="31" border="0" alt="SourceForge Logo">
</center>
.>>
