Add new headers.
[scilab.git] / scilab / modules / graphics / help / en_US / set_posfig_dim.xml
1 <!--
2  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3  * Copyright (C) INRIA - Serge Steer
4  * 
5  * This file must be used under the terms of the CeCILL.
6  * This source file is licensed as described in the file COPYING, which
7  * you should have received as part of this distribution.  The terms
8  * are also available at    
9  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
10  *
11  -->
12 <?xml version="1.0" encoding="UTF-8"?>
13 <!DOCTYPE MAN SYSTEM "../../../../modules/helptools/help.dtd">
14 <MAN>
15   <LANGUAGE>eng</LANGUAGE>
16
17   <TITLE>set_posfig_dim</TITLE>
18
19   <TYPE>Scilab Function</TYPE>
20
21   <DATE>$LastChangedDate$</DATE>
22
23   <SHORT_DESCRIPTION name="set_posfig_dim">change defaut transformation for
24   exporting in postscript</SHORT_DESCRIPTION>
25
26   <CALLING_SEQUENCE>
27     <CALLING_SEQUENCE_ITEM>set_posfig_dim(w,h)</CALLING_SEQUENCE_ITEM>
28
29     <CALLING_SEQUENCE_ITEM>set_posfig_dim(0,0)</CALLING_SEQUENCE_ITEM>
30   </CALLING_SEQUENCE>
31
32   <PARAM>
33     <PARAM_INDENT>
34       <PARAM_ITEM>
35         <PARAM_NAME>w</PARAM_NAME>
36
37         <PARAM_DESCRIPTION>
38           <SP>: graphic figure width, number of pixels</SP>
39         </PARAM_DESCRIPTION>
40       </PARAM_ITEM>
41
42       <PARAM_ITEM>
43         <PARAM_NAME>h</PARAM_NAME>
44
45         <PARAM_DESCRIPTION>
46           <SP>: graphic figure height, number of pixels</SP>
47         </PARAM_DESCRIPTION>
48       </PARAM_ITEM>
49     </PARAM_INDENT>
50   </PARAM>
51
52   <DESCRIPTION>
53     <P><VERB>set_posfig_dim(w,h)</VERB> set the coordinates transformation to
54     be used when exporting a graphic window in postscript. The graphic figure
55     zoomed with ratios <VERB>w/&lt;graphic figure width&gt;</VERB>
56     horizontally and <VERB>h/&lt;graphic figure height&gt;</VERB>
57     vertically.</P>
58
59     <P>This function is particularily useful when one wants an export a
60     graphic figure exactly as it is shown on the screen. For that
61     <VERB>w</VERB> and <VERB>h</VERB> has to be set respectively to
62     <VERB>&lt;graphic figure width&gt;</VERB> and 
63     <VERB>&lt;graphic figure height&gt;</VERB></P>
64
65     <P><VERB>set_posfig_dim(0,0)</VERB> resets the default values:
66     <VERB>w=600</VERB>, <VERB>h=424</VERB>.</P>
67   </DESCRIPTION>
68
69   <EXAMPLE><![CDATA[ 
70     // make a figure with a specific shape 
71     f=scf(0);f.figure_size=[800,300];
72     plot2d()
73     set_posfig_dim(f.figure_size(1),f.figure_size(2))
74     filename='foo'; // ! no extension
75     xs2ps(0,filename)
76     //add the Postscript file header and create <filename>.eps file
77     if MSDOS then
78       unix_s(pathconvert('""'+WSCI+'/bin/BEpsf'+'""',%f)+' -p ' +filename)
79     else
80       unix_s(pathconvert('SCI/bin/BEpsf',%f)+' -p ' +filename)
81     end
82     
83   ]]></EXAMPLE>
84
85   <SEE_ALSO>
86     <SEE_ALSO_ITEM>
87       <LINK>xs2ps</LINK>
88     </SEE_ALSO_ITEM>
89   </SEE_ALSO>
90
91   <AUTHOR>Serge Steer INRIA</AUTHOR>
92 </MAN>