Online help : converted XML files that valid the new scilab.rnc schema.
[scilab.git] / scilab / modules / graphics / help / en_US / set_posfig_dim.xml
1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) INRIA - Serge Steer
5  * 
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at    
10  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11  *
12  -->
13 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="set_posfig_dim"><info><pubdate>$LastChangedDate$</pubdate></info><refnamediv><refname>set_posfig_dim</refname><refpurpose>change defaut transformation for
14   exporting in postscript</refpurpose></refnamediv>
15   
16
17   
18
19   
20
21   
22
23   
24
25   <refsynopsisdiv><title>Calling Sequence</title><synopsis>set_posfig_dim(w,h)
26 set_posfig_dim(0,0)</synopsis></refsynopsisdiv>
27
28   <refsection><title>Parameters</title>
29     <variablelist>
30       <varlistentry>
31         <term>w</term>
32
33         <listitem>
34           <para>graphic figure width, number of pixels</para>
35         </listitem>
36       </varlistentry>
37
38       <varlistentry>
39         <term>h</term>
40
41         <listitem>
42           <para>graphic figure height, number of pixels</para>
43         </listitem>
44       </varlistentry>
45     </variablelist>
46   </refsection>
47
48   <refsection><title>Description</title>
49     <para><literal>set_posfig_dim(w,h)</literal> set the coordinates transformation to
50     be used when exporting a graphic window in postscript. The graphic figure
51     zoomed with ratios <literal>w/&lt;graphic figure width&gt;</literal>
52     horizontally and <literal>h/&lt;graphic figure height&gt;</literal>
53     vertically.</para>
54
55     <para>This function is particularily useful when one wants an export a
56     graphic figure exactly as it is shown on the screen. For that
57     <literal>w</literal> and <literal>h</literal> has to be set respectively to
58     <literal>&lt;graphic figure width&gt;</literal> and 
59     <literal>&lt;graphic figure height&gt;</literal></para>
60
61     <para><literal>set_posfig_dim(0,0)</literal> resets the default values:
62     <literal>w=600</literal>, <literal>h=424</literal>.</para>
63   </refsection>
64
65 <refsection><title>Examples</title><programlisting role="example"><![CDATA[ 
66 // make a figure with a specific shape
67 f=scf(0);f.figure_size=[800,300];
68 plot2d();
69 set_posfig_dim(f.figure_size(1),f.figure_size(2));
70 filename='foo.ps';
71 xs2ps(0,filename);
72 ]]></programlisting></refsection>
73
74   <refsection><title>See Also</title><simplelist type="inline">
75     <member>
76       <link linkend="xs2ps">xs2ps</link>
77     </member>
78   </simplelist></refsection>
79
80   <refsection><title>Authors</title><para>Serge Steer INRIA</para></refsection>
81 </refentry>