fix race condition by Michael J Gruber
[PyX/mjg.git] / manual / epsfile.tex
blobdb250b413ac349d5241a8a785854d28d9941c4dc
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{tabularx}{\linewidth}{l>{\raggedright\arraybackslash}X}
20 argument name&description\\
21 \hline
22 \texttt{x} & $x$-coordinate of position.\\
23 \texttt{y} & $y$-coordinate of position.\\
24 \texttt{filename} & Name of the EPS file (including a possible
25 extension).\\
26 \texttt{width=None} & Desired width of EPS graphics or \texttt{None}
27 for original width. Cannot be combined with scale specification.\\
28 \texttt{height=None} & Desired height of EPS graphics or \texttt{None}
29 for original height. Cannot be combined with scale specification.\\
30 \texttt{scale=None} & Scaling factor for EPS graphics or \texttt{None}
31 for no scaling. Cannot be combined with width or height specification.\\
32 \texttt{align="bl"} & Alignment of EPS graphics. The first character
33 specifies the vertical alignment: \texttt{b} for bottom, \texttt{c}
34 for center, and \texttt{t} for top. The second character fixes the
35 horizontal alignment: \texttt{l} for left, \texttt{c} for center
36 \texttt{r} for right.\\
37 \texttt{clip=1} & Clip to bounding box of EPS file?\\
38 \texttt{translatebbox=1} & Use lower left corner of bounding box of EPS
39 file? Set to $0$ with care.\\
40 \texttt{bbox=None} & If given, use \texttt{bbox} instance instead of
41 bounding box of EPS file.\\
42 \texttt{kpsearch=0} & Search for file using the kpathsea library.
43 \end{tabularx}
47 \label{epsfile}
49 %%% Local Variables:
50 %%% mode: latex
51 %%% TeX-master: "manual.tex"
52 %%% End: