prepare manual for rest conversion
[PyX/mjg.git] / manual / epsfile.tex
blob8b2bf8bbd719bb59b4244461c0cd4915e0174f0c
1 \chapter{Module epsfile: EPS file inclusion}
3 With the help of the \verb|epsfile.epsfile| class, you can easily embed
4 another EPS file in your canvas, thereby scaling, aligning the content
5 at discretion. The most simple example looks like
6 \begin{quote}
7 \begin{verbatim}
8 from pyx import *
9 c = canvas.canvas()
10 c.insert(epsfile.epsfile(0, 0, "file.eps"))
11 c.writeEPSfile("output")
12 \end{verbatim}
13 \end{quote}
15 All relevant parameters are passed to the \verb|epsfile.epsfile|
16 constructor. They are summarized in the following table:
18 \medskip
19 \begin{tableii}{l|l}{textrm}{argument name}{description}
20 \lineii{\texttt{x}}{$x$-coordinate of position.}
21 \lineii{\texttt{y}}{$y$-coordinate of position.}
22 \lineii{\texttt{filename}}{Name of the EPS file (including a possible extension).}
23 \lineii{\texttt{width=None}}{Desired width of EPS graphics or \texttt{None} for original width. Cannot be combined with scale specification.}
24 \lineii{\texttt{height=None}}{Desired height of EPS graphics or \texttt{None} for original height. Cannot be combined with scale specification.}
25 \lineii{\texttt{scale=None}}{Scaling factor for EPS graphics or \texttt{None} for no scaling. Cannot be combined with width or height specification.}
26 \lineii{\texttt{align="bl"}}{Alignment of EPS graphics. The first character specifies the vertical alignment: \texttt{b} for bottom, \texttt{c} for center, and \texttt{t} for top. The second character fixes the horizontal alignment: \texttt{l} for left, \texttt{c} for center \texttt{r} for right.}
27 \lineii{\texttt{clip=1}}{Clip to bounding box of EPS file?}
28 \lineii{\texttt{translatebbox=1}}{Use lower left corner of bounding box of EPS file? Set to $0$ with care.}
29 \lineii{\texttt{bbox=None}}{If given, use \texttt{bbox} instance instead of bounding box of EPS file.}
30 \lineii{\texttt{kpsearch=0}}{Search for file using the kpathsea library.}
31 \end{tableii}
35 \label{epsfile}
37 %%% Local Variables:
38 %%% mode: latex
39 %%% TeX-master: "manual.tex"
40 %%% End: