Add new positions for datatips (left, right, upper, lower).
[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 (upper left), 1 (upper right), 2 (lower left), 3 (lower right), 4 (left), 5 (right), 
84                         6 (upper) or 7 (lower).
85                     </para>
86                 </listitem>
87             </varlistentry>
88             <varlistentry>
89                 <term>z_component: </term>
90                 <listitem>
91                     <para>
92                         This field adds z position in the box. Its value should be <literal>"on" </literal>
93                         (z position written) or <literal>"off"</literal> (no z position written).
94                     </para>
95                 </listitem>
96             </varlistentry>
97             <varlistentry>
98                 <term>auto_orientation: </term>
99                 <listitem>
100                     <para>
101                         This field contains the default <literal>auto_orientation</literal> property
102                         value for the datatip. Its value should be <literal>"on" </literal>(automatic orientation)
103                         or <literal>"off"</literal> (no automatic orientation). In the <literal>"off"</literal> case, 
104                         See <literal>orientation</literal> property.
105                     </para>
106                 </listitem>
107             </varlistentry>
108             <varlistentry>
109                 <term>interp_mode: </term>
110                 <listitem>
111                     <para>This field sets the interpolation mode for tip location. Its value should be 
112                         <literal>"on" </literal>(interpolation is made between mesh points) or <literal>"off"
113                         </literal>
114                         (the tips can only be located at the mesh points).
115                     </para>
116                 </listitem>
117             </varlistentry>
118             <varlistentry>
119                 <term>display_function: </term>
120                 <listitem>
121                     <para>See 
122                         <literal>
123                             <link linkend="polyline_properties">polyline_properties</link>
124                         </literal>
125                         help page.
126                     </para>
127                 </listitem>
128             </varlistentry>
129             <varlistentry>
130                 <term>font_foreground: </term>
131                 <listitem>
132                     <para>
133                         This field contains the default <literal>font_foreground</literal> property
134                         Its value should be a color index (relative to the current colormap).
135                     </para>
136                 </listitem>
137             </varlistentry>
138             <varlistentry>
139                 <term>foreground: </term>
140                 <listitem>
141                     <para>
142                         This field contains the default <literal>foreground</literal> property
143                         used to draw the box. Its value should be a color index (relative
144                         to the current colormap).
145                     </para>
146                 </listitem>
147             </varlistentry>
148             <varlistentry>
149                 <term>background: </term>
150                 <listitem>
151                     <para>See 
152                         <literal>
153                             <link linkend="polyline_properties">polyline_properties</link>
154                         </literal>
155                         help page.
156                     </para>
157                 </listitem>
158             </varlistentry>
159             <varlistentry>
160                 <term>mark_mode: </term>
161                 <listitem>
162                     <para>See 
163                         <literal>
164                             <link linkend="polyline_properties">polyline_properties</link>
165                         </literal>
166                         help page.
167                     </para>
168                 </listitem>
169             </varlistentry>
170             <varlistentry>
171                 <term>mark_style: </term>
172                 <listitem>
173                     <para>See 
174                         <literal>
175                             <link linkend="polyline_properties">polyline_properties</link>
176                         </literal>
177                         help page.
178                     </para>
179                 </listitem>
180             </varlistentry>
181             <varlistentry>
182                 <term>mark_size_unit: </term>
183                 <listitem>
184                     <para>See 
185                         <literal>
186                             <link linkend="polyline_properties">polyline_properties</link>
187                         </literal>
188                         help page.
189                     </para>
190                 </listitem>
191             </varlistentry>
192             <varlistentry>
193                 <term>mark_size: </term>
194                 <listitem>
195                     <para>See 
196                         <literal>
197                             <link linkend="polyline_properties">polyline_properties</link>
198                         </literal>
199                         help page.
200                     </para>
201                 </listitem>
202             </varlistentry>
203             <varlistentry>
204                 <term>mark_foreground: </term>
205                 <listitem>
206                     <para>See 
207                         <literal>
208                             <link linkend="polyline_properties">polyline_properties</link>
209                         </literal>
210                         help page.
211                     </para>
212                 </listitem>
213             </varlistentry>
214             <varlistentry>
215                 <term>mark_background: </term>
216                 <listitem>
217                     <para>See 
218                         <literal>
219                             <link linkend="polyline_properties">polyline_properties</link>
220                         </literal>
221                         help page.
222                     </para>
223                 </listitem>
224             </varlistentry>
225             <varlistentry>
226                 <term>user_data: </term>
227                 <listitem>
228                     <para>See 
229                         <literal>
230                             <link linkend="polyline_properties">polyline_properties</link>
231                         </literal>
232                         help page.
233                     </para>
234                 </listitem>
235             </varlistentry>
236             <varlistentry>
237                 <term>tag: </term>
238                 <listitem>
239                     <para>This fields contains a string generally used to identify the control.
240                         See <literal>
241                             <link linkend="figure_properties">figure_properties</link>
242                         </literal>
243                         help page.
244                     </para>
245                 </listitem>
246             </varlistentry>
247         </variablelist>
248     </refsection>
249     <refsection role="see also">
250         <title>See Also</title>
251         <simplelist type="inline">
252             <member>
253                 <link linkend="polyline_properties">polyline_properties</link>
254             </member>
255             <member>
256                 <link linkend="figure_properties">figure_properties</link>
257             </member>
258             <member>
259                 <link linkend="graphics_entities">graphics_entities</link>
260             </member>
261         </simplelist>
262     </refsection>
263     <refsection>
264         <title>History</title>
265         <revhistory>
266             <revision>
267                 <revnumber>5.5.2</revnumber>
268                 <revremark>
269                     <para>
270                         New "orientation" values available: "left", "right", "upper", "lower".
271                     </para>
272                 </revremark>
273             </revision>
274         </revhistory>
275     </refsection>
276 </refentry>