fb0b9b13138bcc5eeb377520ec090810330d4ad3
[scilab.git] / scilab / modules / graphics / help / en_US / datatips / datatip_properties.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <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="datatip_properties">
3     <refnamediv>
4         <refname>datatip properties</refname>
5         <refpurpose>description of the Datatip
6             entity properties
7         </refpurpose>
8     </refnamediv>
9     <refsection>
10         <title>Description</title>
11         <para>The Datatip entity is a leaf of the graphics entities hierarchy. This
12             entity defines the parameters for datatips.
13         </para>
14         <variablelist>
15             <varlistentry>
16                 <term>parent: </term>
17                 <listitem>
18                     <para>See 
19                                                 <literal>
20                                                         <link linkend="polyline_properties">polyline_properties</link>
21                                                 </literal> help page.
22                     </para>
23                 </listitem>
24             </varlistentry>
25             <varlistentry>
26                 <term>children: </term>
27                 <listitem>
28                     <para>See 
29                                                 <literal>
30                                                         <link linkend="polyline_properties">polyline_properties</link>
31                                                 </literal> help page.
32                     </para>
33                 </listitem>
34             </varlistentry>
35             <varlistentry>
36                 <term>visible: </term>
37                 <listitem>
38                     <para>See 
39                                                 <literal>
40                                                         <link linkend="polyline_properties">polyline_properties</link>
41                                                 </literal> help page.
42                     </para>
43                 </listitem>
44             </varlistentry>
45             <varlistentry>
46                 <term>data: </term>
47                 <listitem>
48                     <para>See 
49                                                 <literal>
50                                                         <link linkend="polyline_properties">polyline_properties</link>
51                                                 </literal> help page.
52                     </para>
53                 </listitem>
54             </varlistentry>
55                         <varlistentry>
56                 <term>box_mode: </term>
57                 <listitem>
58                     <para>This field contains the default <literal>box_mode</literal> property
59                         value for the datatip. Its value should be <literal>"on" </literal>(box
60                         drawn) or <literal>"off"</literal> (no box drawn).
61                     </para>
62                 </listitem>
63             </varlistentry>
64                         <varlistentry>
65                 <term>label_mode: </term>
66                 <listitem>
67                     <para>This field contains the default <literal>label_mode</literal> property
68                         value for the datatip. Its value should be <literal>"on" </literal>(label
69                         written) or <literal>"off"</literal> (no label written).
70                     </para>
71                 </listitem>
72             </varlistentry>
73                         <varlistentry>
74                 <term>orientation: </term>
75                 <listitem>
76                     <para>This field sets the position on the text box with respect to polyline point. 
77                                         The possible values are 0, 1, 2 or 3.
78                     </para>
79                 </listitem>
80             </varlistentry>
81                         <varlistentry>
82                 <term>z_component: </term>
83                 <listitem>
84                     <para>This field adds z position in the box. Its value should be <literal>"on" </literal>
85                                         (z position written) or <literal>"off"</literal> (no z position written).
86                     </para>
87                 </listitem>
88             </varlistentry>
89                         <varlistentry>
90                 <term>auto_orientation: </term>
91                 <listitem>
92                     <para>This field contains the default <literal>auto_orientation</literal> property
93                                         value for the datatip. Its value should be <literal>"on" </literal>(automatic orientation)
94                     or <literal>"off"</literal> (no automatic orientation). In the <literal>"off"</literal> case, 
95                                         See <literal>orientation</literal> property.
96                     </para>
97                 </listitem>
98             </varlistentry>
99                         <varlistentry>
100                 <term>interp_mode: </term>
101                 <listitem>
102                     <para>This field sets the interpolation mode for tip location. Its value should be 
103                                         <literal>"on" </literal>(interpolation is made between mesh points) or <literal>"off"
104                                         </literal> (the tips can only be located at the mesh points).
105                     </para>
106                 </listitem>
107             </varlistentry>
108                         <varlistentry>
109                 <term>display_function: </term>
110                 <listitem>
111                     <para>See 
112                                                 <literal>
113                                                         <link linkend="polyline_properties">polyline_properties</link>
114                                                 </literal> help page.
115                     </para>
116                 </listitem>
117             </varlistentry>
118                         <varlistentry>
119                 <term>font_foreground: </term>
120                 <listitem>
121                     <para>This field contains the default <literal>font_foreground</literal> property
122                         Its value should be a color index (relative to the current colormap).
123                     </para>
124                 </listitem>
125             </varlistentry>
126             <varlistentry>
127                 <term>foreground: </term>
128                 <listitem>
129                     <para>This field contains the default <literal>foreground</literal> property
130                         used to draw the box. Its value should be a color index (relative
131                         to the current colormap).
132                     </para>
133                 </listitem>
134             </varlistentry>
135             <varlistentry>
136                 <term>background: </term>
137                 <listitem>
138                     <para>See 
139                                                 <literal>
140                                                         <link linkend="polyline_properties">polyline_properties</link>
141                                                 </literal> help page.
142                     </para>
143                 </listitem>
144             </varlistentry>
145             <varlistentry>
146                 <term>mark_mode: </term>
147                 <listitem>
148                     <para>See 
149                                                 <literal>
150                                                         <link linkend="polyline_properties">polyline_properties</link>
151                                                 </literal> help page.
152                     </para>
153                 </listitem>
154             </varlistentry>
155             <varlistentry>
156                 <term>mark_style: </term>
157                 <listitem>
158                     <para>See 
159                                                 <literal>
160                                                         <link linkend="polyline_properties">polyline_properties</link>
161                                                 </literal> help page.
162                     </para>
163                 </listitem>
164             </varlistentry>
165             <varlistentry>
166                 <term>mark_size_unit: </term>
167                 <listitem>
168                     <para>See 
169                                                 <literal>
170                                                         <link linkend="polyline_properties">polyline_properties</link>
171                                                 </literal> help page.
172                     </para>
173                 </listitem>
174             </varlistentry>
175             <varlistentry>
176                 <term>mark_size: </term>
177                 <listitem>
178                     <para>See 
179                                                 <literal>
180                                                         <link linkend="polyline_properties">polyline_properties</link>
181                                                 </literal> help page.
182                     </para>
183                 </listitem>
184             </varlistentry>
185             <varlistentry>
186                 <term>mark_foreground: </term>
187                 <listitem>
188                     <para>See 
189                                                 <literal>
190                                                         <link linkend="polyline_properties">polyline_properties</link>
191                                                 </literal> help page.
192                     </para>
193                 </listitem>
194             </varlistentry>
195             <varlistentry>
196                 <term>mark_background: </term>
197                 <listitem>
198                     <para>See 
199                                                 <literal>
200                                                         <link linkend="polyline_properties">polyline_properties</link>
201                                                 </literal> help page.
202                     </para>
203                 </listitem>
204             </varlistentry>
205             <varlistentry>
206                 <term>user_data: </term>
207                 <listitem>
208                     <para>See 
209                                                 <literal>
210                                                         <link linkend="polyline_properties">polyline_properties</link>
211                                                 </literal> help page.
212                     </para>
213                 </listitem>
214             </varlistentry>
215                         <varlistentry>
216                 <term>tag: </term>
217                 <listitem>
218                     <para>This fields contains a string generally used to identify the control.
219                                         See <literal>
220                                                         <link linkend="figure_properties">figure_properties</link>
221                                                 </literal> help page.
222                     </para>
223                 </listitem>
224             </varlistentry>
225         </variablelist>
226     </refsection>
227     <refsection role="see also">
228         <title>See Also</title>
229         <simplelist type="inline">
230             <member>
231                 <link linkend="polyline_properties">polyline_properties</link>
232             </member>
233                         <member>
234                 <link linkend="figure_properties">figure_properties</link>
235             </member>
236             <member>
237                 <link linkend="graphics_entities">graphics_entities</link>
238             </member>
239         </simplelist>
240     </refsection>
241 </refentry>