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