scatter with extended polyline properties mark_size, mark_foreground, mark_background
[scilab.git] / scilab / modules / graphics / help / en_US / compound_properties.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) INRIA - Djalel Abdemouche
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.1-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" xmlns:scilab="http://www.scilab.org"  xml:lang="en" xml:id="Compound_properties">
14     <refnamediv>
15         <refname>Compound properties</refname>
16         <refpurpose>
17             description of the Compound entity properties
18         </refpurpose>
19     </refnamediv>
20     <refsection>
21         <title>Description</title>
22         <para>
23             The <literal>Compound</literal> entity is a third of the graphics
24             entities hierarchy. This entity defines interdependencies of the
25             various graphics entities and their global visibility property.
26         </para>
27         <variablelist>
28             <varlistentry>
29                 <term>parent: </term>
30                 <listitem>
31                     <para>
32                         This property contains the handle of the parent. The
33                         parent of the text entity should be of the type <literal>"Axes"</literal> or
34                         <literal>"Compound"</literal>.
35                     </para>
36                 </listitem>
37             </varlistentry>
38             <varlistentry>
39                 <term>children: </term>
40                 <listitem>
41                     <para>
42                         A vector containing the handles of all graphics objects
43                         children of the <literal>Compound</literal>. These
44                         graphics objects can be of type
45                         <literal>"Compound"</literal>, <literal>"Rectangle"</literal>,
46                         <literal>"Polyline"</literal>, <literal>"Patch"</literal>, <literal>"Segs"</literal>,
47                         <literal>"Arc"</literal>, <literal>"Grayplot"</literal>, ...
48                     </para>
49                 </listitem>
50             </varlistentry>
51             <varlistentry>
52                 <term>visible: </term>
53                 <listitem>
54                     <para>
55                         This field contains the <literal>visible</literal>
56                         property value for the entity. It should be
57                         <literal>"on"</literal> or <literal>"off"</literal>. By
58                         default, value is <literal>"on"</literal> where graphics
59                         entities children of the <literal>Compound</literal> are
60                         drawn according to their visibility property. If
61                         <literal>"off"</literal> all children of
62                         <literal>Compound</literal> are not displayed on the
63                         screen.
64                     </para>
65                 </listitem>
66             </varlistentry>
67             <varlistentry>
68                 <term>user_data: </term>
69                 <listitem>
70                     <para>
71                         This field can be use to store any scilab variable in the
72                         figure data structure, and to retrieve it.
73                     </para>
74                 </listitem>
75             </varlistentry>
76         </variablelist>
77     </refsection>
78     <refsection role="see also">
79         <title>See Also</title>
80         <simplelist type="inline">
81             <member>
82                 <link linkend="glue">glue</link>
83             </member>
84             <member>
85                 <link linkend="unglue">unglue</link>
86             </member>
87             <member>
88                 <link linkend="graphics_entities">graphics entities</link>
89             </member>
90         </simplelist>
91     </refsection>
92 </refentry>