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