← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/graphics/help/en_US/figure_operations/clf.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/graphics/help/en_US/figure_operations/clf.xml
12
12
 *
13
13
 -->
14
14
<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" xmlns:scilab="http://www.scilab.org" version="5.0-subset Scilab" xml:lang="en" xml:id="clf">
15
 
  <refnamediv>
16
 
    <refname>clf</refname>
17
 
    <refpurpose>clear or reset the current graphic figure
18
 
      (window) to default values
19
 
    </refpurpose>
20
 
  </refnamediv>
21
 
  <refsynopsisdiv>
22
 
    <title>Calling Sequence</title>
23
 
    <synopsis>clf(&lt;opt_job_arg&gt;)
24
 
      clf(h,&lt;opt_job_arg&gt;)
25
 
      clf(num,&lt;opt_job_arg&gt;)
26
 
    </synopsis>
27
 
  </refsynopsisdiv>
28
 
  <refsection>
29
 
    <title>Arguments</title>
30
 
    <variablelist>
31
 
      <varlistentry>
32
 
        <term>h</term>
33
 
        <listitem>
34
 
          <para>a handle, the figure handle</para>
35
 
        </listitem>
36
 
      </varlistentry>
37
 
      <varlistentry>
38
 
        <term>num</term>
39
 
        <listitem>
40
 
          <para>a number, the figure_id</para>
41
 
        </listitem>
42
 
      </varlistentry>
43
 
      <varlistentry>
44
 
        <term>&lt;opt_job_arg&gt;</term>
45
 
        <listitem>
46
 
          <para>
47
 
            a string ( <literal>'clear' </literal>or <literal>'reset'</literal> )
48
 
            specifying the job for <literal>clf</literal>.
49
 
          </para>
50
 
        </listitem>
51
 
      </varlistentry>
52
 
    </variablelist>
53
 
  </refsection>
54
 
  <refsection>
55
 
    <title>Description</title>
56
 
    <para>
57
 
      The <literal>clf</literal> command is used to reset a figure to its default
58
 
      values and/or to delete all its children.
59
 
    </para>
60
 
    <para>
61
 
      If <literal>opt_job_arg</literal> string value is <literal>'clear'</literal> then
62
 
      all children of the specified figure are deleted.
63
 
    </para>
64
 
    <para>
65
 
      If <literal>opt_job_arg</literal> string value is <literal>'reset'</literal> then
66
 
      not only all children of the specified figure are deleted but the figure
67
 
      properties are reset to their default values using the default figure
68
 
      model (see <link linkend="gdf">gdf</link>). The only exception are the <literal>axes_size</literal>
69
 
      and <literal>figure_size</literal> properties which can not be reset if the figure
70
 
      is docked with other elements.
71
 
    </para>
72
 
    <para>
73
 
      <literal>clf(num)</literal> clear or reset the figure with
74
 
      <literal>figure_id==num</literal>.
75
 
    </para>
76
 
    <para>
77
 
      <literal>clf(h)</literal> clear or reset the figure pointed to by
78
 
      the handle <literal>h</literal>.
79
 
    </para>
80
 
    <para>
81
 
      <literal>clf()</literal> clear or reset the current figure.
82
 
    </para>
83
 
    <para>
84
 
      <literal>clf</literal> function delete every children of specified windows including
85
 
      menus and uicontrols added by user.
86
 
      To prevent menus and uicontrols from being deleted, the <literal>delete(gca())</literal> command
87
 
      might be used instead.
88
 
    </para>
89
 
  </refsection>
90
 
  <refsection>
91
 
    <title>Examples</title>
92
 
    <programlisting role="example"><![CDATA[ 
 
15
    <refnamediv>
 
16
        <refname>clf</refname>
 
17
        <refpurpose>clear or reset the current graphic figure
 
18
            (window) to default values
 
19
        </refpurpose>
 
20
    </refnamediv>
 
21
    <refsynopsisdiv>
 
22
        <title>Calling Sequence</title>
 
23
        <synopsis>clf(&lt;opt_job_arg&gt;)
 
24
            clf(h,&lt;opt_job_arg&gt;)
 
25
            clf(num,&lt;opt_job_arg&gt;)
 
26
        </synopsis>
 
27
    </refsynopsisdiv>
 
28
    <refsection>
 
29
        <title>Arguments</title>
 
30
        <variablelist>
 
31
            <varlistentry>
 
32
                <term>h</term>
 
33
                <listitem>
 
34
                    <para>a handle, the figure handle</para>
 
35
                </listitem>
 
36
            </varlistentry>
 
37
            <varlistentry>
 
38
                <term>num</term>
 
39
                <listitem>
 
40
                    <para>a number, the figure_id</para>
 
41
                </listitem>
 
42
            </varlistentry>
 
43
            <varlistentry>
 
44
                <term>&lt;opt_job_arg&gt;</term>
 
45
                <listitem>
 
46
                    <para>
 
47
                        a string ( <literal>'clear' </literal>or <literal>'reset'</literal> )
 
48
                        specifying the job for <literal>clf</literal>.
 
49
                    </para>
 
50
                </listitem>
 
51
            </varlistentry>
 
52
        </variablelist>
 
53
    </refsection>
 
54
    <refsection>
 
55
        <title>Description</title>
 
56
        <para>
 
57
            The <literal>clf</literal> command is used to reset a figure to its default
 
58
            values and/or to delete all its children.
 
59
        </para>
 
60
        <para>
 
61
            If <literal>opt_job_arg</literal> string value is <literal>'clear'</literal> then
 
62
            all children of the specified figure are deleted.
 
63
        </para>
 
64
        <para>
 
65
            If <literal>opt_job_arg</literal> string value is <literal>'reset'</literal> then
 
66
            not only all children of the specified figure are deleted but the figure
 
67
            properties are reset to their default values using the default figure
 
68
            model (see <link linkend="gdf">gdf</link>). The only exception are the <literal>axes_size</literal>
 
69
            and <literal>figure_size</literal> properties which can not be reset if the figure
 
70
            is docked with other elements.
 
71
        </para>
 
72
        <para>
 
73
            <literal>clf(num)</literal> clear or reset the figure with
 
74
            <literal>figure_id==num</literal>.
 
75
        </para>
 
76
        <para>
 
77
            <literal>clf(h)</literal> clear or reset the figure pointed to by
 
78
            the handle <literal>h</literal>.
 
79
        </para>
 
80
        <para>
 
81
            <literal>clf()</literal> clear or reset the current figure.
 
82
        </para>
 
83
        <para>
 
84
            <literal>clf</literal> function delete every children of specified windows including
 
85
            menus and uicontrols added by user.
 
86
            To prevent menus and uicontrols from being deleted, the <literal>delete(gca())</literal> command
 
87
            might be used instead.
 
88
        </para>
 
89
    </refsection>
 
90
    <refsection>
 
91
        <title>Examples</title>
 
92
        <programlisting role="example"><![CDATA[ 
93
93
f4=scf(4);  //creates figure with id==4 and make it the current one
94
94
f4.color_map = jetcolormap(64);
95
95
f4.figure_size = [400, 200];
107
107
clf(gcf(),'reset')
108
108
plot3d1(t,t,sin(t)'*cos(t));  // color_map changed (back to the default one with 32 colors)
109
109
 ]]></programlisting>
110
 
  </refsection>
111
 
  <refsection role="see also">
112
 
    <title>See Also</title>
113
 
    <simplelist type="inline">
114
 
      <member>
115
 
        <link linkend="set">set</link>
116
 
      </member>
117
 
      <member>
118
 
        <link linkend="get">get</link>
119
 
      </member>
120
 
      <member>
121
 
        <link linkend="gcf">gcf</link>
122
 
      </member>
123
 
      <member>
124
 
        <link linkend="gdf">gdf</link>
125
 
      </member>
126
 
      <member>
127
 
        <link linkend="scf">scf</link>
128
 
      </member>
129
 
      <member>
130
 
        <link linkend="graphics_entities">graphics_entities</link>
131
 
      </member>
132
 
    </simplelist>
133
 
  </refsection>
 
110
    </refsection>
 
111
    <refsection role="see also">
 
112
        <title>See Also</title>
 
113
        <simplelist type="inline">
 
114
            <member>
 
115
                <link linkend="set">set</link>
 
116
            </member>
 
117
            <member>
 
118
                <link linkend="get">get</link>
 
119
            </member>
 
120
            <member>
 
121
                <link linkend="gcf">gcf</link>
 
122
            </member>
 
123
            <member>
 
124
                <link linkend="gdf">gdf</link>
 
125
            </member>
 
126
            <member>
 
127
                <link linkend="scf">scf</link>
 
128
            </member>
 
129
            <member>
 
130
                <link linkend="graphics_entities">graphics_entities</link>
 
131
            </member>
 
132
        </simplelist>
 
133
    </refsection>
134
134
</refentry>