Bug 6840 fixed: Add new line_style
[scilab.git] / scilab / modules / graphics / help / en_US / axes_operations / axes_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  * Copyright (C) 2009 - DIGITEO - Pierre Lando
6  *
7  * This file must be used under the terms of the CeCILL.
8  * This source file is licensed as described in the file COPYING, which
9  * you should have received as part of this distribution.  The terms
10  * are also available at
11  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
12  *
13  -->
14 <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="axes_properties">
15     <refnamediv>
16         <refname>axes properties</refname>
17         <refpurpose>description of the axes entity
18             properties
19         </refpurpose>
20     </refnamediv>
21     <refsection>
22         <title>Description</title>
23         <para>The Axes entity is the second level of the graphics entities hierarchy.
24             This entity defines the parameters allowing the change of coordinates and
25             the axes drawing as well as the parameters' default values for the
26             children creation.
27         </para>
28         <variablelist>
29             <varlistentry>
30                 <term>Axes properties</term>
31                 <listitem>
32                     <variablelist>
33                         <varlistentry>
34                             <term>parent: </term>
35                             <listitem>
36                                 <para>This field contains the handle of the parent figure.</para>
37                             </listitem>
38                         </varlistentry>
39                         <varlistentry>
40                             <term>children: </term>
41                             <listitem>
42                                 <para>FA vector containing the handles of all graphics objects
43                                     children of the axes These graphics objects are of type
44                                     <literal>"Compound"</literal>, <literal>"Rectangle"</literal>,
45                                     <literal>"Polyline"</literal>, <literal>"Segs"</literal>, <literal>"Arc"</literal>,
46                                     <literal>"Grayplot"</literal>,.. (see <link linkend="Compound_properties">Compound_properties</link>,
47                                     <link linkend="rectangle_properties">rectangle_properties</link>, <link linkend="champ_properties">champ_properties</link>,
48                                     <link linkend="axis_properties">axis_properties</link>, <link linkend="polyline_properties">polyline_properties</link>,
49                                     <link linkend="segs_properties">segs_properties</link>, <link linkend="grayplot_properties">grayplot_properties</link>,
50                                     <link linkend="surface_properties">surface_properties</link>,
51                                     <link linkend="fec_properties">fec_properties</link>, <link linkend="text_properties">text_properties</link>,
52                                     <link linkend="legend_properties">legend_properties</link>)
53                                 </para>
54                             </listitem>
55                         </varlistentry>
56                         <varlistentry>
57                             <term>visible: </term>
58                             <listitem>
59                                 <para>
60                                     This field contains the <literal>visible</literal> property value
61                                     for axes . Its value should be <literal>"on" </literal> or
62                                     <literal>"off"</literal> . By default, axes is visible <literal>"on"</literal>
63                                     in case all "visible" chidren are displayed on the screen, If
64                                     <literal>"off"</literal> the axes and all its chidren are not
65                                     drawn.
66                                 </para>
67                             </listitem>
68                         </varlistentry>
69                         <varlistentry>
70                             <term>axes_visible: </term>
71                             <listitem>
72                                 <para>
73                                     A <literal>1x3</literal> string vector. This property specifies
74                                     whether each axis is drawn or not. Its value should be
75                                     <literal>"on"</literal> or <literal>"off"</literal> for a global setting.To
76                                     act on a single axis, the syntax is <literal>axes_visible(N)</literal>
77                                     where <literal>N</literal> is <literal>1,2</literal> or <literal>3</literal>
78                                     corresponding to the <literal> x,y</literal> or <literal>z</literal> axis. The
79                                     scaling data and if required the grids are drawn if the value is
80                                     <literal>"on"</literal>. Note that when creating a simple axes entity
81                                     using the <literal>gca()</literal> (shorcut for
82                                     <literal>get"current_axes")</literal>) or <literal>gcf()</literal> (shortcut
83                                     for <literal>get(current_figure)</literal>) commands, the axes
84                                     visiblibilty is set to <literal>"off"</literal>.
85                                 </para>
86                             </listitem>
87                         </varlistentry>
88                         <varlistentry>
89                             <term>axes_reverse: </term>
90                             <listitem>
91                                 <para>
92                                     A <literal>1x3</literal> string vector corresponding to the three
93                                     axes (X,Y,Z). For each axes, the property specifies the direction
94                                     of the incresing values. If <literal>"off"</literal>, the default
95                                     direction is used. If <literal>"on"</literal>, the direction is reverse.
96                                     It is also possible to use only one string, <literal>"on"</literal> or
97                                     <literal>"off"</literal>, to set simultaneously the three data.
98                                 </para>
99                             </listitem>
100                         </varlistentry>
101                         <varlistentry>
102                             <term>grid: </term>
103                             <listitem>
104                                 <para>The field value is a vector
105                                     <literal>[x-grid,y-grid,z-grid]</literal> where <literal>x-grid</literal>
106                                     controls a grid drawning for the x-axis and <literal>y-grid,
107                                         z-grid
108                                     </literal>
109                                     respecting to the y-axis, z-axis. The default values
110                                     is <literal>-1</literal> grids are not drawn, else the grids are drawn
111                                     using the color given indexed by the grid value.
112                                 </para>
113                             </listitem>
114                         </varlistentry>
115                         <varlistentry>
116                             <term>grid_position: </term>
117                             <listitem>
118                                 <para>This character string specifies the grid position compared with other graphic entities.
119                                     Its value can be either <literal>"foreground"</literal>
120                                     to draw the grid ahead other graphic entities or <literal>"background"</literal> to draw the grid behind.
121                                 </para>
122                             </listitem>
123                         </varlistentry>
124                         <varlistentry>
125                             <term>x_location: </term>
126                             <listitem>
127                                 <para>Specify the location of the x-axis. The possible values
128                                     are:
129                                 </para>
130                                 <itemizedlist>
131                                     <listitem>
132                                         <para>
133                                             <literal>"bottom"</literal>. In this case the x axis is drawn at
134                                             the bottom of the axes rectangle.
135                                         </para>
136                                     </listitem>
137                                     <listitem>
138                                         <para>
139                                             <literal>"top"</literal>. In this case the x axis is drawn at
140                                             the top of the axes rectangle.
141                                         </para>
142                                     </listitem>
143                                     <listitem>
144                                         <para>
145                                             <literal>"middle"</literal>. In this case the x axis is drawn
146                                             at the centered position.
147                                         </para>
148                                     </listitem>
149                                     <listitem>
150                                         <para>
151                                             <literal>"origin"</literal>. In this case the x axis is drawn
152                                             at the origin.
153                                         </para>
154                                     </listitem>
155                                 </itemizedlist>
156                             </listitem>
157                         </varlistentry>
158                         <varlistentry>
159                             <term>y_location: </term>
160                             <listitem>
161                                 <para>Specify the location of the y-axis. The possible values
162                                     are:
163                                 </para>
164                                 <itemizedlist>
165                                     <listitem>
166                                         <para>
167                                             <literal>"left"</literal>. In this case the y axis is drawn at
168                                             the left of the axes rectangle.
169                                         </para>
170                                     </listitem>
171                                     <listitem>
172                                         <para>
173                                             <literal>"right"</literal>. In this case the y axis is drawn at
174                                             the right of the axes rectangle.
175                                         </para>
176                                     </listitem>
177                                     <listitem>
178                                         <para>
179                                             <literal>"middle"</literal>. In this case the y axis is drawn
180                                             at the centered position.
181                                         </para>
182                                     </listitem>
183                                     <listitem>
184                                         <para>
185                                             <literal>"origin"</literal>. In this case the y axis is drawn
186                                             at the origin.
187                                         </para>
188                                     </listitem>
189                                 </itemizedlist>
190                             </listitem>
191                         </varlistentry>
192                         <varlistentry>
193                             <term>title: </term>
194                             <listitem>
195                                 <para>An object attached to the Axes entity and returning a graphic
196                                     handle on a Label structure (see <link linkend="label_properties">label_properties</link>).
197                                     This field defines a title with options on this label.
198                                 </para>
199                             </listitem>
200                         </varlistentry>
201                         <varlistentry>
202                             <term>x_label: </term>
203                             <listitem>
204                                 <para>An object attached to the Axes entity and returning a graphic
205                                     handle on a Label structure (see <link linkend="label_properties">label_properties</link>).
206                                     This field defines a label on x axis with options on this
207                                     label.
208                                 </para>
209                             </listitem>
210                         </varlistentry>
211                         <varlistentry>
212                             <term>y_label: </term>
213                             <listitem>
214                                 <para>An object attached to the Axes entity and returning a graphic
215                                     handle on a Label structure (see <link linkend="label_properties">label_properties</link>).
216                                     This field defines a label on y axis with options on this
217                                     label.
218                                 </para>
219                             </listitem>
220                         </varlistentry>
221                         <varlistentry>
222                             <term>z_label: </term>
223                             <listitem>
224                                 <para>An object attached to the Axes entity and returning a graphic
225                                     handle on a Label structure (see <link linkend="label_properties">label_properties</link>).
226                                     This field defines a label on z axis with options on this
227                                     label.
228                                 </para>
229                             </listitem>
230                         </varlistentry>
231                         <varlistentry>
232                             <term>auto_ticks: </term>
233                             <listitem>
234                                 <para>
235                                     A <literal>1x3</literal> string vector giving the auto_ticks status
236                                     for each axis. This property specifies whether each axis is
237                                     graduated using a computational algorithm or not (graduations are
238                                     set by the user). Its value should be <literal>"on"</literal> or
239                                     <literal>"off"</literal> for a global setting.To act on a single axis,
240                                     the syntax is <literal>auto_ticks(N)</literal> where <literal>N</literal> is
241                                     <literal>1,2</literal> or <literal>3</literal> corresponding to the
242                                     <literal>x,y</literal> or <literal>z</literal> axis. Note that editing ticks
243                                     (text and/or locations) via <literal>x_ticks, y_ticks</literal> or
244                                     <literal>z_ticks</literal> automatically set <literal>auto_ticks</literal> to
245                                     <literal>"off"</literal> for the corresponding axes.
246                                 </para>
247                             </listitem>
248                         </varlistentry>
249                         <varlistentry>
250                             <term>x_ticks.locations: </term>
251                             <listitem>
252                                 <para>A real vector containing the locations for the graduations on
253                                     x axis. This property can be edited specifying a new real vector
254                                     (of the same size). To specify greater or lesser graduations, man
255                                     can act on the <literal>x_ticks</literal> <literal>tlist</literal> defining a
256                                     corresponding<literal> x_ticks.labels</literal> string vector too.
257                                 </para>
258                             </listitem>
259                         </varlistentry>
260                         <varlistentry>
261                             <term>y_ticks.locations: </term>
262                             <listitem>
263                                 <para>A real vector containing the locations for the graduations on
264                                     y axis. This property can be edited specifying a new real vector
265                                     (of the same size). To specify greater or lesser graduations, man
266                                     can act on the <literal>y_ticks</literal> <literal>tlist</literal> defining a
267                                     corresponding<literal> y_ticks.labels</literal> string vector too.
268                                 </para>
269                             </listitem>
270                         </varlistentry>
271                         <varlistentry>
272                             <term>z_ticks.locations: </term>
273                             <listitem>
274                                 <para>A real vector containing the locations for the graduations on
275                                     z axis. This property can be edited specifying a new real vector
276                                     (of the same size). To specify greater or lesser graduations, man
277                                     can act on the <literal>z_ticks</literal> <literal>tlist</literal> defining a
278                                     corresponding<literal> z_ticks.labels</literal> string vector too.
279                                 </para>
280                             </listitem>
281                         </varlistentry>
282                         <varlistentry>
283                             <term>x_ticks.labels: </term>
284                             <listitem>
285                                 <para>A string vector containing the labels for the graduations on x
286                                     axis. This property can be edited specifying a new string vector
287                                     (of the same size). To specify greater or lesser graduations, man
288                                     can act on the <literal>x_ticks</literal> <literal>tlist</literal> defining a
289                                     corresponding<literal> x_ticks.locations</literal> real vector too.
290                                 </para>
291                                 <para>
292                                     Starting from Scilab 5.2, it is possible to write <link linkend="math_rendering_features_in_graphic">LaTeX or MathML expression</link>.
293                                 </para>
294                             </listitem>
295                         </varlistentry>
296                         <varlistentry>
297                             <term>y_ticks.labels: </term>
298                             <listitem>
299                                 <para>A string vector containing the labels for the graduations on y
300                                     axis. This property can be edited specifying a new string vector
301                                     (of the same size). To specify greater or lesser graduations, man
302                                     can act on the <literal>y_ticks</literal> <literal>tlist</literal> defining a
303                                     corresponding<literal> y_ticks.locations</literal> real vector too.
304                                 </para>
305                                 <para>
306                                     Starting from Scilab 5.2, it is possible to write <link linkend="math_rendering_features_in_graphic">LaTeX or MathML expression</link>.
307                                 </para>
308                             </listitem>
309                         </varlistentry>
310                         <varlistentry>
311                             <term>z_ticks.labels: </term>
312                             <listitem>
313                                 <para>A string vector containing the labels for the graduations on z
314                                     axis. This property can be edited specifying a new string vector
315                                     (of the same size). To specify greater or lesser graduations, man
316                                     can act on the <literal>z_ticks</literal> <literal>tlist</literal> defining a
317                                     corresponding<literal> z_ticks.locations</literal> real vector too.
318                                 </para>
319                                 <para>
320                                     Starting from Scilab 5.2, it is possible to write <link linkend="math_rendering_features_in_graphic">LaTeX or MathML expression</link>.
321                                 </para>
322                             </listitem>
323                         </varlistentry>
324                         <varlistentry>
325                             <term>box: </term>
326                             <listitem>
327                                 <para>This property specifies whether to enclose the axes in a box.
328                                     Its value can be either <literal>"off"</literal>,
329                                     <literal>"hidden_axes"</literal>, <literal>"back_half"</literal> or
330                                     <literal>"on".</literal> If the property is <literal>"off"</literal>, the box
331                                     is not draw. If the property is <literal>"hidden_axes"</literal>, only
332                                     the back frame is drawn. If the property is
333                                     <literal>"back_half"</literal>, the X, Y and Z axis are also drawn. If
334                                     the property is <literal>"on"</literal> the whole box is drawn.
335                                 </para>
336                             </listitem>
337                         </varlistentry>
338                         <varlistentry>
339                             <term>filled: </term>
340                             <listitem>
341                                 <para>This property specifies whether the axes background should be drawn or not.
342                                     Its value can be either <literal>"off"</literal> or
343                                     <literal>"on".</literal> If the property is <literal>"off"</literal>, the background
344                                     is not drawn, the axes box is transparent. If the property is <literal>"on"</literal> the
345                                     background is drawn using the color specified by the <literal>background</literal> property.
346                                 </para>
347                             </listitem>
348                         </varlistentry>
349                         <varlistentry>
350                             <term>sub_ticks: </term>
351                             <listitem>
352                                 <para>This field sets the number of tics to draw between two main
353                                     tics. The field value is the vector <literal>[nx,ny]</literal> where
354                                     <literal>nx</literal> is the number of sub tics for the x-axis and
355                                     <literal>ny</literal> respecting to the y-axis.
356                                 </para>
357                             </listitem>
358                         </varlistentry>
359                         <varlistentry>
360                             <term>font_style: </term>
361                             <listitem>
362                                 <para>Specifies the font used for displaying tics labels. This is a positive integer referecing one of the loaded fonts.
363                                     Its value must be between 0, referecing the first font,
364                                     and the number of loaded fonts minus one, referencing the last font.
365                                     For more information see <link linkend="graphics_fonts">graphics_fonts</link>.
366                                 </para>
367                             </listitem>
368                         </varlistentry>
369                         <varlistentry>
370                             <term>font_size: </term>
371                             <listitem>
372                                 <para>
373                                     It is a scalar specifying the character size of tics labels.
374                                     If <literal>fractional_font</literal> property is <literal>"off"</literal>
375                                     only the integer part of the value is used.
376                                     For more information see <link linkend="graphics_fonts">graphics_fonts</link>.
377                                 </para>
378                             </listitem>
379                         </varlistentry>
380                         <varlistentry>
381                             <term>font_color: </term>
382                             <listitem>
383                                 <para>This property determines the color of the tics labels.</para>
384                             </listitem>
385                         </varlistentry>
386                         <varlistentry>
387                             <term>fractional_font: </term>
388                             <listitem>
389                                 <para>
390                                     This property specify whether ticks labels are displayed using fractional font sizes.
391                                     Its value must be either <literal>"on"</literal> or <literal>"off"</literal>.
392                                     If <literal>"on"</literal> the floating point value of <literal>font_size</literal>
393                                     is used for display and the font is anti-aliased. If <literal>"off"</literal> only the integer part is used
394                                     and the font is not smoothed.
395                                 </para>
396                             </listitem>
397                         </varlistentry>
398                         <varlistentry>
399                             <term>isoview: </term>
400                             <listitem>
401                                 <para>This property is used to have isometric scales on the x, y and
402                                     z axes (for exemple to make the display of the curve sin(x) versus
403                                     cos(x) be a circle not an ellipse). Its value should be
404                                     <literal>"on"</literal> or <literal>"off"</literal>. If the value is
405                                     <literal>"on"</literal>, the axes <literal>data_bounds</literal> automatically
406                                     change according to the corresponding figure
407                                     <literal>figure_size</literal> property values.
408                                 </para>
409                             </listitem>
410                         </varlistentry>
411                         <varlistentry>
412                             <term>cube_scaling:</term>
413                             <listitem>
414                                 <para>
415                                     This property is used in <literal>3d mode</literal> to have a
416                                     rescaling of the x, y and z axes. Indeed, it allows the
417                                     <literal>data</literal> to fit into a 1x1x1 cube ; the goal is to better
418                                     display 3d graphics in case axes scales are very different from
419                                     one to another. Its value should be <literal>"on" </literal> or
420                                     <literal>"off"</literal> (which is the default value). In most cases, it
421                                     helps generating Matlab-like 3d view.
422                                 </para>
423                             </listitem>
424                         </varlistentry>
425                         <varlistentry>
426                             <term>view: </term>
427                             <listitem>
428                                 <para>This field is related to the graphics universe. It takes
429                                     <literal>"3d"</literal> as value corresponding to the three-dimensional
430                                     views. In the other case its value can be <literal>"2d"</literal> for
431                                     initial 2d plotting (default value). This flag also depends on the
432                                     plots the user enters : a <literal>plot3d </literal>command, for
433                                     example, will switch the <literal>view</literal> flag from
434                                     <literal>"2d"</literal> to <literal>"3d"</literal>.
435                                 </para>
436                             </listitem>
437                         </varlistentry>
438                         <varlistentry>
439                             <term>rotation_angles: </term>
440                             <listitem>
441                                 <para>
442                                     This field is the vector <literal>[alpha,theta]</literal>. These two
443                                     values give the spherical coordinates of the observation points
444                                     (in degree).
445                                 </para>
446                             </listitem>
447                         </varlistentry>
448                         <varlistentry>
449                             <term>log_flags: </term>
450                             <listitem>
451                                 <para> 3 character string that sets the scale (linear or logarithmic) along the axes.
452                                     Each character speficfies the scale for respectivgly the X, Y and Z axes.
453                                     They should take a value between <literal>'n'</literal> for linear scale or
454                                     <literal>'l'</literal> for logarithmic scale.
455                                 </para>
456                             </listitem>
457                         </varlistentry>
458                         <varlistentry>
459                             <term>tight_limits: </term>
460                             <listitem>
461                                 <para>
462                                     If this property value is <literal>"on"</literal> axes adapt to fit exactly with the minima and
463                                     maxima values of the data bounds. If this field value is <literal>"off"</literal>, axes may
464                                     enlarge boundaries such as to produce pretty tics labels.
465                                 </para>
466                             </listitem>
467                         </varlistentry>
468                         <varlistentry>
469                             <term>data_bounds: </term>
470                             <listitem>
471                                 <para>This field contains the boundary values for the x,y and z
472                                     coordinates. It is the matrix
473                                     <literal>[xmin,ymin,zmin;xmax,ymax,zmax]</literal> or
474                                     <literal>[xmin,ymin;xmax,ymax]</literal>. Note that, to stricly have the
475                                     specified data bounds, <literal>tight_limits</literal> must be set to
476                                     <literal>"on"</literal> value (see above).
477                                     To manually set data_bounds set <literal>auto_scale="off"</literal>
478                                 </para>
479                             </listitem>
480                         </varlistentry>
481                         <varlistentry>
482                             <term>zoom_box: </term>
483                             <listitem>
484                                 <para>This field contains the current zoom box if any coordinates
485                                     are given. It is an empty matrix (no zoom) or the vector
486                                     <literal>[xmin,ymin,xmax,ymax,zmin,zmax]</literal> (defines a smaller axes box).
487                                 </para>
488                             </listitem>
489                         </varlistentry>
490                         <varlistentry>
491                             <term>margins: </term>
492                             <listitem>
493                                 <para>A vector
494                                     <literal>[margin_left,margin_right,margin_top,margin_bottom]</literal>
495                                     specifying the margins portion for this axes. This vector is
496                                     composed of numbers between [0 1] with default: [0.125 0.125 0.125
497                                     0.125]. These numbers are ratios relative to associated values of the
498                                     <literal>axes_bounds</literal> property, which are <literal>width</literal> for
499                                     <literal>margin_left</literal> and <literal>margin_right</literal>, and
500                                     <literal>height</literal> for <literal>margin_top</literal> and
501                                     <literal>margin_bottom</literal>.
502                                 </para>
503                             </listitem>
504                         </varlistentry>
505                         <varlistentry>
506                             <term>axes_bounds: </term>
507                             <listitem>
508                                 <para>
509                                     A vector <literal>[x_left,y_up,width,height]</literal> specifying
510                                     the portion of figure used by this axes. Where
511                                     <literal>x_left</literal>, <literal>y_up</literal>, <literal>width</literal> and
512                                     <literal>height</literal> are numbers in [0 1] give respectively the
513                                     position of the upper-left corner and the dimension of the axes
514                                     (these numbers are ratio relative to the corresponding figure
515                                     <literal>figure_size</literal> property values).
516                                 </para>
517                             </listitem>
518                         </varlistentry>
519                         <varlistentry>
520                             <term>hidden_axis_color: </term>
521                             <listitem>
522                                 <para>This property defined the color of the hidden axis. It takes
523                                     an index relative to the current colormap.
524                                 </para>
525                             </listitem>
526                         </varlistentry>
527                         <varlistentry>
528                             <term>user_data: </term>
529                             <listitem>
530                                 <para>This field can be use to store any scilab variable in the axes
531                                     data structure, and to retreive it.
532                                 </para>
533                             </listitem>
534                         </varlistentry>
535                     </variablelist>
536                 </listitem>
537             </varlistentry>
538             <varlistentry>
539                 <term>Properties for high level functions</term>
540                 <listitem>
541                     <para>
542                         The <literal>plot</literal>, <literal>plot2dx</literal>, <literal>grayplot</literal>
543                         and <literal>matplot</literal> functions use the following properties to
544                         decide how to merge consecutive plots if this is not stated by the
545                         <literal>frameflag</literal> calling argument. The result of the merge is
546                         decided through these two following properties:
547                     </para>
548                     <variablelist>
549                         <varlistentry>
550                             <term>auto_clear: </term>
551                             <listitem>
552                                 <para>
553                                     If this property value is equal to <literal>"on"</literal>, a call
554                                     to a high level graphic will re-ininitialize the current axes and
555                                     erase all its children before preforming the drawing (log_flags will be reset).
556                                     If the value is <literal>"off"</literal> the drawings will be added to current axes
557                                     according to <literal>"auto_scale"</literal> property.
558                                 </para>
559                             </listitem>
560                         </varlistentry>
561                         <varlistentry>
562                             <term>auto_scale: </term>
563                             <listitem>
564                                 <para>A property to update the axes data boundary. If value is
565                                     <literal>"on"</literal>, a new plot will adapt the current axes
566                                     properties to fit with previous and current plots. If its value is
567                                     <literal>"off"</literal> the new plot will be drawn in the current axes
568                                     data boundary.
569                                 </para>
570                             </listitem>
571                         </varlistentry>
572                     </variablelist>
573                 </listitem>
574             </varlistentry>
575             <varlistentry>
576                 <term>Children's default values: </term>
577                 <listitem>
578                     <variablelist>
579                         <varlistentry>
580                             <term>hiddencolor: </term>
581                             <listitem>
582                                 <para>This property controls the hidden parts' color. It takes as
583                                     value an index relative to the current colormap. In another case,
584                                     if it is a negative value, the hidden parts take the same colors
585                                     as the surface
586                                 </para>
587                             </listitem>
588                         </varlistentry>
589                         <varlistentry>
590                             <term>line_mode: </term>
591                             <listitem>
592                                 <para>
593                                     This field contains the default <literal>line_mode</literal>
594                                     property value for Segs Rectangle Legend Axis Plot3d Fac3d and
595                                     Polyline objects. Its value should be <literal>"on" </literal>(default)
596                                     or <literal>"off"</literal>.
597                                 </para>
598                             </listitem>
599                         </varlistentry>
600                         <varlistentry>
601                             <term>line_style: </term>
602                             <listitem>
603                                 <para>
604                                     This field contains the default <literal>line_style</literal>
605                                     property value for Segs, Arcs, Rectangle and Polyline objects.
606                                     <literal>line_style</literal> selects the type of line to be used to
607                                     draw lines . Its value should be an integer in [1 10]. 1
608                                     stand for solid, the other values stand for a selection of dashes
609                                     (dash, dash dot, longdash dot, bigdash dot, bigdash longdash, dot, double dot, longblank dot, bigblank dot).
610                                 </para>
611                             </listitem>
612                         </varlistentry>
613                         <varlistentry>
614                             <term>thickness: </term>
615                             <listitem>
616                                 <para>
617                                     This field contains the default <literal>thickness</literal>
618                                     property value for all objects using line drawing. It is a positive real specifying the line width
619                                     in pixels. The displayed width is actually determined by rounding the supplied width
620                                     to the nearest integer. The only exception is vectorial export where the whole <literal>thickness</literal>
621                                     value is considered.
622                                 </para>
623                             </listitem>
624                         </varlistentry>
625                         <varlistentry>
626                             <term>mark_mode: </term>
627                             <listitem>
628                                 <para>
629                                     This field contains the default <literal>mark_mode</literal>
630                                     property value for Segs Rectangle Legend Axis Plot3d Fac3d and
631                                     Polyline objects. Its value should be <literal>"on" </literal> or
632                                     <literal>"off"</literal> (default).
633                                 </para>
634                             </listitem>
635                         </varlistentry>
636                         <varlistentry>
637                             <term>mark_style: </term>
638                             <listitem>
639                                 <para>
640                                     This field contains the default <literal>mark_style</literal>
641                                     property value for Segs Rectangle Legend Axis Plot3d Fac3d and
642                                     Polyline objects. <literal>mark_style</literal> selects the type of mark
643                                     to be displayed. Its value should be an integer in [0 9] which
644                                     stands for: dot, plus, cross, star, filled diamond, diamond,
645                                     triangle up, triangle down, trefle and circle.
646                                 </para>
647                             </listitem>
648                         </varlistentry>
649                         <varlistentry>
650                             <term>mark_size_unit: </term>
651                             <listitem>
652                                 <para>
653                                     This field contains the default <literal>mark_size_unit</literal>
654                                     property value for Segs Rectangle Legend Axis Plot3d Fac3d and
655                                     Polyline objects. If <literal>mark_size_unit</literal> is set to
656                                     <literal>"point"</literal>, then the <literal>mark_size</literal> value is
657                                     directly given in points. When <literal>mark_size_unit</literal> is set
658                                     to <literal>"tabulated"</literal>, <literal>mark_size</literal> is computed
659                                     relative to the font size array: therefore, its value should be an
660                                     integer in [0 5] whith stands for 8pt, 10pt, 12pt, 14pt, 18pt and
661                                     24pt. Note that <link linkend="plot2d">plot2d</link> and pure scilab functions use
662                                     <literal>tabulated</literal> mode as default ; when using
663                                     <link linkend="plot">plot</link> function, the <literal>point</literal> mode is
664                                     automatically enabled.
665                                 </para>
666                             </listitem>
667                         </varlistentry>
668                         <varlistentry>
669                             <term>mark_size: </term>
670                             <listitem>
671                                 <para>
672                                     This field contains the default <literal>mark_size</literal>
673                                     property value for Segs Rectangle Legend Axis Plot3d Fac3d and
674                                     Polyline objects. <literal>mark_size</literal> selects the font size of
675                                     mark to be displayed. Its value should be an integer in [0 5]
676                                     whith stands for 8pt, 10pt, 12pt, 14pt, 18pt and 24pt (see
677                                     <link linkend="getmark">getmark</link>).
678                                 </para>
679                                 <para>
680                                     <warning>In the special case where mark_style and mark_size are 0, a dot of one pixel is drawn.</warning>
681                                 </para>
682                             </listitem>
683                         </varlistentry>
684                         <varlistentry>
685                             <term>mark_foreground: </term>
686                             <listitem>
687                                 <para>
688                                     This field contains the default <literal>mark_foreground</literal>
689                                     property value for all objects created under this axes. Polyline,
690                                     rectangle, legend, surface, segment and axis objects are using
691                                     this property to specify a foreground (edge) color for their
692                                     marks. Its value should be a color index (relative to the current
693                                     color_map) or 0 for transparant edge. Note that the default value is <literal>-1</literal>
694                                     (default black) and, even if you change the
695                                     <literal>color_map</literal>, this <literal>-1</literal> value will always
696                                     point onto the default black color.
697                                 </para>
698                             </listitem>
699                         </varlistentry>
700                         <varlistentry>
701                             <term>mark_background: </term>
702                             <listitem>
703                                 <para>This property controls the default
704                                     <literal>mark_background</literal> property value for all objects
705                                     created under this axes. Polyline, rectangle, legend, surface,
706                                     segment and axis objects are using this property to specify a
707                                     background (face) color for their marks. It takes as value an
708                                     index relative to the current colormap or 0 for transparant face. Note that the default value
709                                     is <literal>-2</literal> (default white) and, even if you change the
710                                     <literal>color_map</literal>, this <literal>-2</literal> value will always
711                                     point onto the default white color.
712                                 </para>
713                             </listitem>
714                         </varlistentry>
715                         <varlistentry>
716                             <term>foreground: </term>
717                             <listitem>
718                                 <para>
719                                     This field contains the default <literal>foreground</literal>
720                                     property value for axes and all objects created under this axes.
721                                     Its value should be a color index (relative to the current
722                                     color_map). Note that the default value is <literal>-1</literal>
723                                     (default black) and, even if you change the
724                                     <literal>color_map</literal>, this <literal>-1</literal> value will always
725                                     point onto the default black color.
726                                 </para>
727                             </listitem>
728                         </varlistentry>
729                         <varlistentry>
730                             <term>background: </term>
731                             <listitem>
732                                 <para>
733                                     This property controls the default <literal>background</literal>
734                                     property value for axes and all objects created under this axes.
735                                     It takes as value an index relative to the current colormap.Note
736                                     that the default value is <literal>-2</literal> (default white) and,
737                                     even if you change the <literal>color_map</literal>, this
738                                     <literal>-2</literal> value will always point onto the default white
739                                     color.
740                                 </para>
741                             </listitem>
742                         </varlistentry>
743                         <varlistentry>
744                             <term>arc_drawing_mode: </term>
745                             <listitem>
746                                 <para>
747                                     This property controls the default <literal>arc_drawing_mode</literal>
748                                     property value for all created Arc objects under this Axes object.
749                                     Its value should be either <literal>"nurbs"</literal> or <literal>"lines"</literal>.
750                                 </para>
751                             </listitem>
752                         </varlistentry>
753                         <varlistentry>
754                             <term>clip_state: </term>
755                             <listitem>
756                                 <para>
757                                     This field contains the default <literal>clip_state</literal>
758                                     property value for all objects. Its value should be :
759                                 </para>
760                                 <itemizedlist>
761                                     <listitem>
762                                         <para>
763                                             <literal>"off"</literal> this means that all objects created
764                                             after that are not clipped (default value).
765                                         </para>
766                                     </listitem>
767                                     <listitem>
768                                         <para>
769                                             <literal>"clipgrf"</literal> this means that all objects created
770                                             after that are clipped outside the Axes boundaries.
771                                         </para>
772                                     </listitem>
773                                     <listitem>
774                                         <para>
775                                             <literal>"on"</literal> this means that all objects created
776                                             after that are clipped outside the rectangle given by property
777                                             clip_box.
778                                         </para>
779                                     </listitem>
780                                 </itemizedlist>
781                             </listitem>
782                         </varlistentry>
783                         <varlistentry>
784                             <term>clip_box: </term>
785                             <listitem>
786                                 <para>
787                                     This field contains the default <literal>clip_box</literal> property
788                                     value for all objects. Its value should be an empty matrix if
789                                     clip_state is <literal>"off"</literal>. Other case the clipping is given
790                                     by the vector <literal>[x,y,w,h]</literal> (upper-left point width
791                                     height).
792                                 </para>
793                             </listitem>
794                         </varlistentry>
795                         <varlistentry>
796                             <term>Note on default values :</term>
797                             <listitem>
798                                 <variablelist>
799                                     <varlistentry>
800                                         <term/>
801                                         <listitem>
802                                             <para>All these listed properties and fields inherit from
803                                                 default values stored in an axes model. These default values
804                                                 can be seen and changed. To do so, use the
805                                                 <literal>get("default_axes")</literal> command : it returns a
806                                                 graphic handle on the axes model. Note that no graphic window
807                                                 is created by this command. The next created axes will inherit
808                                                 from this model (see "Example on axes model" below).
809                                             </para>
810                                         </listitem>
811                                     </varlistentry>
812                                 </variablelist>
813                             </listitem>
814                         </varlistentry>
815                     </variablelist>
816                 </listitem>
817             </varlistentry>
818         </variablelist>
819     </refsection>
820     <refsection>
821         <title>Examples</title>
822         <programlisting role="example"><![CDATA[
823 lines(0) // disables vertical paging
824 a=get("current_axes")//get the handle of the newly created axes
825 a.axes_visible="on"; // makes the axes visible
826 a.font_size=3; //set the tics label font size
827 a.x_location="top"; //set the x axis position
828 a.data_bounds=[-100,-2,-1;100,2,1]; //set the boundary values for the x, y and z coordinates.
829 a.sub_tics=[5,0];
830 a.labels_font_color=5;
831 a.grid=[2,2];
832 a.box="off";
833
834 // Example with 3D axes
835 clf(); //clear the graphics window
836 x=0.1:0.1:2*%pi;plot2d(x-.3,sin(x)*7+.2);
837 a=gca(); // get the handle of the current axes
838 a.grid=[1 -1 -1]; //make x-grid
839 a.rotation_angles=[70 250]; //turn the axes with giving angles
840 a.grid=[1 6 -1]; //make y-grid
841 a.view="2d"; //return te the 2d view
842 a.box="back_half";
843 a.labels_font_color=5;
844 a.children.children.thickness=4;
845 a.children.children.polyline_style=3;
846 a.view="3d"; //return te the 3d view
847 a.children.children.thickness=1;
848 a.children.children.foreground=2;
849 a.grid=[1 6 3]; //make z-grid
850 a.parent.background=4;
851 a.background=7;
852 plot2d(cos(x)+1,3*sin(x)-3);
853 plot2d(cos(x)+7,3*sin(x)+3);
854 a.children(2).children.polyline_style=2;
855 a.children(1).children.polyline_style=4;
856 a.children(1).children.foreground=5;
857 a.children(2).children.foreground=14;
858 a.parent.figure_size= [1200,800];
859 a.box="on";
860 a.labels_font_size=4;
861 a.parent.background=8;
862 a.parent.figure_size= [400,200];
863 a.rotation_angles=[0 260];
864 delete(a.children(2));
865 delete(); // delete current object
866
867 a = gca();
868 a.labels_font_size=1;
869 a.auto_clear= "on";
870 x=0:0.1:2.5*%pi;plot2d(10*cos(x),sin(x));
871
872 a.data_bounds(:,1) = [1;15] ; // set positive bounds for X axe
873 a.log_flags = "lnn" ; // set X axes to logarithmic scale
874 a.log_flags = "nnn" ; // switch back to linear scale
875
876 a=gca();
877 a.rotation_angles=[45 45];
878 a.data_bounds=[-20,-3,-2;20 3 ,2];
879 xrect([-4 0.5 8 1]);
880 a.auto_clear = "off" ;
881 a.isoview="on"; // isoview mode
882 xrect([-2 0.25 4 0.5]);
883 a.children(1).fill_mode="on";
884 a.axes_visible="off";
885 a.children(1).data=[-2 0.25 -1 4 0.5];
886 a.children(2).data=[-4 0.5 1 8 1];
887 x=2*%pi*(0:7)/8;
888 xv=[.2*sin(x);.9*sin(x)];yv=[.2*cos(x);.9*cos(x)];
889 xsegs(10*xv,yv,1:8)
890 s=a.children(1);
891 s.arrow_size=1;
892 s.segs_color=5;
893 a.data_bounds //the boundary values for the x,y and z coordinates
894 a.view="2d";
895 a.data_bounds=[-10,-1; 10,1]; // set the boundary values for the two-dimensional views
896
897 // Example on axes model
898 da=gda() // get the handle on axes model to view and edit the fields
899 // title by default
900 da.title.text="My Default@Title"
901 da.title.foreground = 12;
902 da.title.font_size = 4;
903 // x labels default
904 da.x_label.text="x";
905 da.x_label.text="x"; // Latex or MathML can be used here also
906 da.x_label.font_style = 8;
907 da.x_label.font_size = 2;
908 da.x_label.foreground = 5;
909 da.x_location = "middle";
910 // y labels default
911 da.y_label.text="y";
912 da.y_label.font_style = 3;
913 da.y_label.font_size = 5;
914 da.y_label.foreground = 3;
915 da.y_location = "right";
916 da.thickness = 2;
917 da.foreground = 7;
918 // the plot
919 x=(0:0.1:2*%pi)';
920 plot2d(x,[sin(x),sin(2*x),sin(3*x)],style=[1,2,3],rect=[0,-2,2*%pi,2]);
921 sda() // back to default axes model
922
923
924 // Example with LaTeX / MathML ticks:
925 plot2d();
926 a=gca();
927
928 mathml="<mrow><mfrac><mrow><mi>d</mi>  <mi>y</mi></mrow><mrow>  <mi>d</mi>  <mi>x</mi></mrow></mfrac> <mo>=</mo>..
929 <mfrac><mn>1</mn><msup> <mi>y</mi>  <mn>2</mn></msup> </mfrac> </mrow>";
930 // Only LaTeX expression
931 a.x_ticks = tlist(["ticks", "locations", "labels"], (0:6)', [mathml;"1";"$\sin(x)$";"3";"$\cos(a) - test$";"5";"6"]);
932
933 // Mixed expression: MathML and LaTex
934 a.y_ticks = tlist(["ticks", "locations", "labels"], (-2:0.5:2)', ["0";"1";"2";"3";"$\cos(a)$";"5";"6";mathml;"8"]);
935
936  ]]></programlisting>
937     </refsection>
938     <refsection role="see also">
939         <title>See Also</title>
940         <simplelist type="inline">
941             <member>
942                 <link linkend="lines">lines</link>
943             </member>
944             <member>
945                 <link linkend="set">set</link>
946             </member>
947             <member>
948                 <link linkend="get">get</link>
949             </member>
950             <member>
951                 <link linkend="gca">gca</link>
952             </member>
953             <member>
954                 <link linkend="gda">gda</link>
955             </member>
956             <member>
957                 <link linkend="gcf">gcf</link>
958             </member>
959             <member>
960                 <link linkend="sda">sda</link>
961             </member>
962             <member>
963                 <link linkend="sdf">sdf</link>
964             </member>
965             <member>
966                 <link linkend="scf">scf</link>
967             </member>
968             <member>
969                 <link linkend="graphics_entities">graphics_entities</link>
970             </member>
971         </simplelist>
972     </refsection>
973     <refsection>
974         <title>History</title>
975         <revhistory>
976             <revision>
977                 <revnumber>5.4.0</revnumber>
978                 <revremark>line_style value 0 is obsolete, use 1 instead (both are equivalent for SOLID). Using value 0 will produce an error in Scilab 5.4.1.</revremark>
979             </revision>
980             <revision>
981                 <revnumber>5.5.0</revnumber>
982                 <revremark>line_style values 9 and 10 can be used to have respectively longblank dot and bigblank dot styles.</revremark>
983             </revision>
984         </revhistory>
985     </refsection>
986 </refentry>