scatter with extended polyline properties mark_size, mark_foreground, mark_background
[scilab.git] / scilab / modules / graphics / help / en_US / 2d_plot / scatter.xml
index ba2fb11..8298f31 100644 (file)
@@ -18,8 +18,8 @@
     <refsynopsisdiv>
         <title>Calling Sequence</title>
         <synopsis>
-          scatter(x,y,&lt;s&gt;,&lt;c&gt;,&lt;"fill"&gt;,&lt;marker&gt;,&lt;marker_property,value&gt;)
-          scatter(&lt;axes_handle&gt;,...)
+          p = scatter(x,y,&lt;s&gt;,&lt;c&gt;,&lt;"fill"&gt;,&lt;marker&gt;,&lt;marker_property,value&gt;)
+          p = scatter(&lt;axes_handle&gt;,...)
         </synopsis>
     </refsynopsisdiv>
     <refsection>
@@ -46,7 +46,7 @@
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>s</term>
+                <term>&lt;s&gt;</term>
                 <listitem>
                     <para>
                         Specifying the sizes of the markers.
@@ -58,7 +58,7 @@
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>c</term>
+                <term>&lt;c&gt;</term>
                 <listitem>
                     <para>
                         Specifying the colors of the markers.
                     </para>
                 </listitem>
             </varlistentry>
+            <varlistentry>
+                <term>&lt;p&gt;</term>
+                <listitem>
+                    <para>
+                        Returns a handle to the created polyline.
+                    </para>
+                </listitem>
+            </varlistentry>
         </variablelist>
     </refsection>
     <refsection>
@@ -435,37 +443,31 @@ t = linspace(0,1,200)
 x = t.*cos(10*%pi*t)
 y = t.*sin(10*%pi*t)
 // create 2D scatter plot
-scatter(x,y)
+p = scatter(x,y)
  ]]></programlisting>
         <scilab:image>
 t = linspace(0,25,200)
 x = t.*cos(t)
 y = t.*sin(t)
-scatter(x,y,t)
+p = scatter(x,y,t)
         </scilab:image>
         <programlisting role="example"><![CDATA[
-// get current entity
-ce = gce()
-// get polyline
-pl = ce.children
 // modify ployline 
-pl.thickness = 0.5
-pl.mark_foreground = addcolor(name2rgb("darkblue")/255)
-pl.mark_background = addcolor(name2rgb("darkcyan")/255)
+p.thickness = 0.5
+p.mark_foreground = addcolor(name2rgb("darkblue")/255)
+p.mark_background = addcolor(name2rgb("darkcyan")/255)
  ]]></programlisting>
         <scilab:image>
 t = linspace(0,25,200)
 x = t.*cos(t)
 y = t.*sin(t)
-scatter(x,y,t)
-ce = gce()
-pl = ce.children
-pl.thickness = 0.5
-pl.mark_foreground = addcolor(name2rgb("darkblue")/255)
-pl.mark_background = addcolor(name2rgb("darkcyan")/255)
+p = scatter(x,y,t)
+p.thickness = 0.5
+p.mark_foreground = addcolor(name2rgb("darkblue")/255)
+p.mark_background = addcolor(name2rgb("darkcyan")/255)
         </scilab:image>
-    </refsection>
-    <refsection role="see also">
+      </refsection>
+      <refsection role="see also">
         <title>See Also</title>
         <simplelist type="inline">
             <member>
@@ -478,9 +480,6 @@ pl.mark_background = addcolor(name2rgb("darkcyan")/255)
                 <link linkend="gca">gca</link>
             </member>
             <member>
-                <link linkend="gce">gce</link>
-            </member>
-            <member>
                 <link linkend="gcf">gcf</link>
             </member>
             <member>