* Bug 16321 fixed: typos in help pages
[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  * Copyright (C) 2013, 2018 - Samuel GOUGEON
7  *
8  * Copyright (C) 2012 - 2016 - Scilab Enterprises
9  *
10  * This file is hereby licensed under the terms of the GNU GPL v2.0,
11  * pursuant to article 5.3.4 of the CeCILL v.2.1.
12  * This file was originally licensed under the terms of the CeCILL v2.1,
13  * and continues to be available under such terms.
14  * For more information, see the COPYING file which you should have received
15  * along with this program.
16  *
17  -->
18 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
19           xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML"
20           xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"
21           xml:lang="en" xml:id="axes_properties">
22     <refnamediv>
23         <refname>axes properties</refname>
24         <refpurpose>
25             description of the axes entity properties
26         </refpurpose>
27     </refnamediv>
28     <refsection>
29         <title>Description</title>
30         <para>
31             The Axes entity is the second level of the graphics entities hierarchy.
32             This entity defines the parameters allowing the change of coordinates and
33             the axes drawing as well as the parameters' default values for the
34             children creation.
35         </para>
36         <variablelist>
37             <varlistentry>
38                 <term>Axes properties</term>
39                 <listitem>
40                     <variablelist>
41                         <varlistentry>
42                             <term>parent: </term>
43                             <listitem>
44                                 <para>This field contains the handle of the parent figure.</para>
45                             </listitem>
46                         </varlistentry>
47                         <varlistentry>
48                             <term>children: </term>
49                             <listitem>
50                                 <para>
51                                     FA vector containing the handles of all graphics objects
52                                     children of the axes These graphics objects are of type
53                                     <literal>"Compound"</literal>, <literal>"Rectangle"</literal>,
54                                     <literal>"Polyline"</literal>, <literal>"Segs"</literal>, <literal>"Arc"</literal>,
55                                     <literal>"Grayplot"</literal>,.. (see <link linkend="Compound_properties">Compound_properties</link>,
56                                     <link linkend="rectangle_properties">rectangle_properties</link>, <link linkend="champ_properties">champ_properties</link>,
57                                     <link linkend="axis_properties">axis_properties</link>, <link linkend="polyline_properties">polyline_properties</link>,
58                                     <link linkend="segs_properties">segs_properties</link>, <link linkend="grayplot_properties">grayplot_properties</link>,
59                                     <link linkend="surface_properties">surface_properties</link>,
60                                     <link linkend="fec_properties">fec_properties</link>, <link linkend="text_properties">text_properties</link>,
61                                     <link linkend="legend_properties">legend_properties</link>)
62                                 </para>
63                             </listitem>
64                         </varlistentry>
65                         <varlistentry>
66                             <term>visible: </term>
67                             <listitem>
68                                 <para>
69                                     This field contains the <literal>visible</literal> property value
70                                     for axes . Its value should be <literal>"on" </literal> or
71                                     <literal>"off"</literal> . By default, axes is visible <literal>"on"</literal>
72                                     in case all "visible" children are displayed on the screen, If
73                                     <literal>"off"</literal> the axes and all its children are not
74                                     drawn.
75                                 </para>
76                             </listitem>
77                         </varlistentry>
78                         <varlistentry>
79                             <term>axes_visible: </term>
80                             <listitem>
81                                 <para>
82                                     A <literal>1x3</literal> string vector. This property specifies
83                                     whether each axis is drawn or not. Its value should be
84                                     <literal>"on"</literal> or <literal>"off"</literal> for a global setting.To
85                                     act on a single axis, the syntax is <literal>axes_visible(N)</literal>
86                                     where <literal>N</literal> is <literal>1,2</literal> or <literal>3</literal>
87                                     corresponding to the <literal> x,y</literal> or <literal>z</literal> axis. The
88                                     scaling data and if required the grids are drawn if the value is
89                                     <literal>"on"</literal>. Note that when creating a simple axes entity
90                                     using the <literal>gca()</literal> (shortcut for
91                                     <literal>get"current_axes")</literal>) or <literal>gcf()</literal> (shortcut
92                                     for <literal>get(current_figure)</literal>) commands, the axes
93                                     visibility is set to <literal>"off"</literal>.
94                                 </para>
95                             </listitem>
96                         </varlistentry>
97                         <varlistentry>
98                             <term>axes_reverse: </term>
99                             <listitem>
100                                 <para>
101                                     A <literal>1x3</literal> string vector corresponding to the three
102                                     axes (X,Y,Z). For each axes, the property specifies the direction
103                                     of the increasing values. If <literal>"off"</literal>, the default
104                                     direction is used. If <literal>"on"</literal>, the direction is reverse.
105                                     It is also possible to use only one string, <literal>"on"</literal> or
106                                     <literal>"off"</literal>, to set simultaneously the three data.
107                                 </para>
108                             </listitem>
109                         </varlistentry>
110                         <varlistentry>
111                             <term>grid: </term>
112                             <listitem>
113                                 <para>
114                                     vector of 3 colors indices <literal>[xCol, yCol, zCol]</literal>
115                                     used to draw the grid along respective directions.
116                                     To cancel the grid in a direction, use <literal>-1</literal>
117                                     as index. Default = <literal>[-1 -1 -1]</literal> (no grid).
118                                 </para>
119                             </listitem>
120                         </varlistentry>
121                         <varlistentry>
122                             <term>grid_style: </term>
123                             <listitem>
124                                 <para>
125                                     vector <literal>[xLineStyle, yLineStyle, zLineStyle]</literal>
126                                     of 2 or 3 line styles ids from 1 to 10 (solid, dashes, dots, etc)
127                                     used to draw the grid along respective directions (in 2D or 3D).
128                                     Available line styles are described
129                                     <link linkend="polyline_properties">there</link>.
130                                 </para>
131                             </listitem>
132                         </varlistentry>
133                         <varlistentry>
134                             <term>grid_thickness: </term>
135                             <listitem>
136                                 <para>
137                                     vector <literal>[xLineThick, yLineThick, zLineThick]</literal>
138                                     of 2 or 3 positive decimal numbers setting the thickness of
139                                     the grid lines along respective directions (in 2D or 3D).
140                                </para>
141                             </listitem>
142                         </varlistentry>
143                         <varlistentry>
144                             <term>grid_position: </term>
145                             <listitem>
146                                 <para>
147                                     <literal>"background"</literal> (default): the grid is drawn
148                                     behind all other graphical components ;
149                                     or <literal>"foreground</literal>: the grid is drawn on the top.
150                                 </para>
151                             </listitem>
152                         </varlistentry>
153                         <varlistentry>
154                             <term>x_location: </term>
155                             <listitem>
156                                 <para>
157                                     Specify the location of the x-axis. The possible values
158                                     are:
159                                 </para>
160                                 <itemizedlist>
161                                     <listitem>
162                                         <para>
163                                             <literal>"bottom"</literal>. In this case the x axis is drawn at
164                                             the bottom of the axes rectangle.
165                                         </para>
166                                     </listitem>
167                                     <listitem>
168                                         <para>
169                                             <literal>"top"</literal>. In this case the x axis is drawn at
170                                             the top of the axes rectangle.
171                                         </para>
172                                     </listitem>
173                                     <listitem>
174                                         <para>
175                                             <literal>"middle"</literal>. In this case the x axis is drawn
176                                             at the centered position.
177                                         </para>
178                                     </listitem>
179                                     <listitem>
180                                         <para>
181                                             <literal>"origin"</literal>. In this case the x axis is drawn
182                                             at the origin.
183                                         </para>
184                                     </listitem>
185                                 </itemizedlist>
186                             </listitem>
187                         </varlistentry>
188                         <varlistentry>
189                             <term>y_location: </term>
190                             <listitem>
191                                 <para>
192                                     Specify the location of the y-axis. The possible values
193                                     are:
194                                 </para>
195                                 <itemizedlist>
196                                     <listitem>
197                                         <para>
198                                             <literal>"left"</literal>. In this case the y axis is drawn at
199                                             the left of the axes rectangle.
200                                         </para>
201                                     </listitem>
202                                     <listitem>
203                                         <para>
204                                             <literal>"right"</literal>. In this case the y axis is drawn at
205                                             the right of the axes rectangle.
206                                         </para>
207                                     </listitem>
208                                     <listitem>
209                                         <para>
210                                             <literal>"middle"</literal>. In this case the y axis is drawn
211                                             at the centered position.
212                                         </para>
213                                     </listitem>
214                                     <listitem>
215                                         <para>
216                                             <literal>"origin"</literal>. In this case the y axis is drawn
217                                             at the origin.
218                                         </para>
219                                     </listitem>
220                                 </itemizedlist>
221                             </listitem>
222                         </varlistentry>
223                         <varlistentry>
224                             <term>title: </term>
225                             <listitem>
226                                 <para>
227                                     An object attached to the Axes entity and returning a graphic
228                                     handle on a Label structure
229                                     (see <link linkend="label_properties">label_properties</link>).
230                                     This field defines a title with options on this label.
231                                 </para>
232                             </listitem>
233                         </varlistentry>
234                         <varlistentry>
235                             <term>x_label: </term>
236                             <listitem>
237                                 <para>
238                                     An object attached to the Axes entity and returning a graphic
239                                     handle on a Label structure
240                                     (see <link linkend="label_properties">label_properties</link>).
241                                     This field defines a label on x axis with options on this
242                                     label.
243                                 </para>
244                             </listitem>
245                         </varlistentry>
246                         <varlistentry>
247                             <term>y_label: </term>
248                             <listitem>
249                                 <para>
250                                     An object attached to the Axes entity and returning a graphic
251                                     handle on a Label structure
252                                     (see <link linkend="label_properties">label_properties</link>).
253                                     This field defines a label on y axis with options on this
254                                     label.
255                                 </para>
256                             </listitem>
257                         </varlistentry>
258                         <varlistentry>
259                             <term>z_label: </term>
260                             <listitem>
261                                 <para>
262                                     An object attached to the Axes entity and returning a graphic
263                                     handle on a Label structure
264                                     (see <link linkend="label_properties">label_properties</link>).
265                                     This field defines a label on z axis with options on this
266                                     label.
267                                 </para>
268                             </listitem>
269                         </varlistentry>
270                         <varlistentry>
271                             <term>auto_ticks: </term>
272                             <listitem>
273                                 <para>
274                                     Default <literal>["on" "on" "on"]</literal>. auto_ticks status
275                                     for each x, y and z respective axis.
276                                 </para>
277                                 <para>
278                                     <literal>"on"</literal> means that the axis is automatically
279                                     graduated through a
280                                     computational algorithm. Then, resizing the figure and axes
281                                     automatically updates accordingly graduations ticks and labels
282                                     of the given axis.
283                                </para>
284                                <para>
285                                     On the contrary, <literal>"off"</literal> means that graduations
286                                     ticks or/and labels are set by hand. Then resizing the figure and
287                                     axes has no effect on existing graduations ticks and labels.
288                               </para>
289                               <para>Setting <literal>.auto_ticks="on"</literal> or <literal>"off"</literal>
290                                 sets the same status for the x, y and z axes. Setting
291                                 <literal>.auto_ticks(2)="off"</literal> sets the status only for the
292                                 y axis. Etc.
293                               </para>
294                               <warning>
295                                 Editing ticks (labels and/or locations) via
296                                 <literal>x_ticks, y_ticks</literal> or  <literal>z_ticks</literal>
297                                 automatically sets <literal>auto_ticks</literal> to <literal>"off"</literal>
298                                 for the corresponding axes.
299                               </warning>
300                             </listitem>
301                         </varlistentry>
302                         <varlistentry>
303                             <term>x_ticks, y_ticks, z_ticks: </term>
304                             <listitem>
305                                 <para>
306                                     Each of these properties is a tlist of type "ticks" with 2 fields named "locations" and "labels":
307                                     <literal>tlist(["ticks", "locations", "labels"], Locations, Labels)</literal> where
308                                     <variablelist>
309                                         <varlistentry>
310                                             <term>Locations</term>
311                                             <listitem>
312                                                 is a real vector containing the locations of
313                                                 graduations along and according to the data scale
314                                                 of the given x or y or z axis.
315                                                 When the number of ticks does not need to be changed,
316                                                 their locations can be set or changed through
317                                                 the syntax (e.g. along x)
318                                                 <literal>Haxes.x_ticks.locations = Locations</literal>
319                                                 where <literal>Haxes = gca();</literal> and
320                                                 <literal>Locations</literal> is the complete vector
321                                                 of updated ticks positions. To change just the ith
322                                                 location, just use:
323                                                 <literal>Haxes.x_ticks.locations(i) = newLoc</literal>
324                                             </listitem>
325                                         </varlistentry>
326                                         <varlistentry>
327                                             <term>Labels</term>
328                                             <listitem>
329                                                 is a text vector containing the labels to be displayed
330                                                 in front of each related graduation. As for Locations
331                                                 of ticks, Labels can be addressed with (e.g. along y)
332                                                 <literal>Haxes.y_ticks.labels = Labels</literal> or
333                                                 <literal>Haxes.y_ticks.labels(j) = newLabelJ</literal>.
334                                                 <para>
335                                                 Vertical or tilted ticks labels can be yielded using
336                                                 LaTeX formating with
337                                                 <literal>\rotatebox{angle}{text}</literal>. See the
338                                                 <link linkend="axes_properties_vertical_xticks">example</link>
339                                                 below.
340                                                 </para>
341                                             </listitem>
342                                         </varlistentry>
343                                     </variablelist>
344                                     <warning>
345                                         <itemizedlist>
346                                         <listitem>
347                                             For an axis, <literal>Locations</literal> and
348                                             <literal>Labels</literal> vectors must have the same
349                                             number of components.
350                                         </listitem>
351                                         <listitem>
352                                             When the number of ticks must be changed, their positions
353                                             AND labels must be changed at once, in order to avoid
354                                             any mismatch: The syntax (e.g. along x)
355                                             <literal>Haxes.x_ticks = tlist(["ticks" "locations", "labels"], newLocations, newLabels)</literal>
356                                             must then be used.
357                                         </listitem>
358                                         <listitem>
359                                             Changing by hand the <literal>Locations</literal> or/and
360                                             <literal>Labels</literal> of an axis automatically sets
361                                             its <literal>.auto_ticks</literal> status to
362                                             <literal>"off"</literal>. This cancels its
363                                             auto-regraduation under resizing of the figure.
364                                         </listitem>
365                                       </itemizedlist>
366                                     </warning>
367                                 </para>
368                             </listitem>
369                         </varlistentry>
370                         <varlistentry>
371                             <term>x_ticks.locations, y_ticks.locations, z_ticks.locations: </term>
372                             <listitem>
373                                 <para>
374                                     Each of these properties is a real vector containing the locations
375                                   of graduations on the related x or y or z axis.
376                                   <varname>x_ticks.locations</varname> must have the same number of
377                                   components as <varname>x_ticks.labels</varname>.
378                                   See <varname>x_ticks</varname> hereabove for more details.
379                                 </para>
380                             </listitem>
381                         </varlistentry>
382                         <varlistentry>
383                             <term>x_ticks.labels, y_ticks.labels, z_ticks.labels: </term>
384                             <listitem>
385                                 <para>
386                                   Each of these properties is a text vector containing the labels
387                                   to be displayed in front of ticks on the related x or y or z axis.
388                                   <varname>x_ticks.labels</varname> must have the same number of
389                                   components as <varname>x_ticks.locations</varname>.
390                                   See <varname>x_ticks</varname> hereabove for more details.
391                                 </para>
392                             </listitem>
393                         </varlistentry>
394                         <varlistentry>
395                             <term>ticks_format: </term>
396                             <listitem>
397                                 <para>
398                                     This property specifies the format to use for each axes.
399                                     It is a row vector with at most 3 columns containing strings
400                                     format (as specified for <link linkend="mprintf">mprintf</link>).
401                                     Each ticks position will be used to format the string used as label.
402                                 </para>
403                                 <para>
404                                     So, for example ticks_format="%.2e" will print ticks positions
405                                     in using scientific notation with two decimals.
406                                 </para>
407                                 <warning>
408                                    Labels are actually updated according to the newly set
409                                    <literal>.ticks_format(i)</literal> only if the
410                                    <literal>.auto_ticks(i)</literal> status of the axis #i is
411                                    <literal>"on"</literal>. Otherwise,
412                                    <literal>.ticks_format(i)</literal> is recorded without being
413                                    immediately used.
414                                 </warning>
415                             </listitem>
416                         </varlistentry>
417                         <varlistentry>
418                             <term>ticks_st: </term>
419                             <listitem>
420                                 <para>
421                                   This property specifies scale-translate factors to apply to each
422                                   ticks position before to use it in the formatted string used as
423                                   label. So if the factors are
424                                   <literal>[x_s y_s z_s ; x_t y_t z_t]</literal> and if a x_tick is
425                                   positioned at X, the value used to format the label will be
426                                   <literal>x_s*(X-x_t)</literal>. It could be particularly useful
427                                   when the axes bounds are too closed.
428                                     <para>
429                                         It is a matrix with 2 rows and at most 3 columns.
430                                     </para>
431                                 </para>
432                                 <para>
433                                     So, for example <literal>base=B</literal>, labels could be
434                                     printed with <literal>ticks_format=string(base)+"%+.2e"</literal>
435                                     and <literal>ticks_st=[1 base]</literal>
436                                 </para>
437                             </listitem>
438                         </varlistentry>
439                         <varlistentry>
440                             <term>box: </term>
441                             <listitem>
442                                 <para>
443                                     This property specifies whether to enclose the axes in a box.
444                                     Its value can be either <literal>"off"</literal>,
445                                     <literal>"hidden_axes"</literal>, <literal>"back_half"</literal> or
446                                     <literal>"on".</literal> If the property is <literal>"off"</literal>, the box
447                                     is not draw. If the property is <literal>"hidden_axes"</literal>, only
448                                     the back frame is drawn. If the property is
449                                     <literal>"back_half"</literal>, the X, Y and Z axis are also drawn. If
450                                     the property is <literal>"on"</literal> the whole box is drawn.
451                                 </para>
452                                 <scilab:image><![CDATA[
453                                     box = ["on" "back_half" "hidden_axes" "off"];
454                                     for i = 1:4
455                                         subplot(1,4,i)
456                                         plot3d([0 1],[0 1],[0 1])
457                                         a = gca();
458                                         a.box = box(i);
459                                         a.rotation_angles = [235 326];
460                                         title(msprintf("%s", box(i)), "fontsize",3)
461                                     end
462                                     gcf().axes_size = [840 222];
463                                 ]]></scilab:image>
464                             </listitem>
465                         </varlistentry>
466                         <varlistentry>
467                             <term>filled: </term>
468                             <listitem>
469                                 <para>
470                                     This property specifies whether the axes background should be
471                                     drawn or not.
472                                     Its value can be either <literal>"off"</literal> or
473                                     <literal>"on".</literal>
474                                     If the property is <literal>"off"</literal>, the background
475                                     is not drawn, the axes box is transparent. If the property is
476                                     <literal>"on"</literal> the
477                                     background is drawn using the color specified by the
478                                     <literal>background</literal> property.
479                                 </para>
480                             </listitem>
481                         </varlistentry>
482                         <varlistentry>
483                             <term>sub_ticks: </term>
484                             <listitem>
485                                 <para>
486                                     This field sets the number of tics to draw between two main
487                                     tics. The field value is the vector <literal>[nx,ny]</literal> where
488                                     <literal>nx</literal> is the number of sub tics for the x-axis and
489                                     <literal>ny</literal> respecting to the y-axis.
490                                 </para>
491                             </listitem>
492                         </varlistentry>
493                         <varlistentry>
494                             <term>font_style: </term>
495                             <listitem>
496                                 <para>
497                                     Specifies the font used for displaying tics labels. This is a
498                                     positive integer referencing one of the loaded fonts.
499                                     Its value must be between 0, referencing the first font,
500                                     and the number of loaded fonts minus one, referencing the last font.
501                                     For more information see <link linkend="graphics_fonts">graphics_fonts</link>.
502                                 </para>
503                             </listitem>
504                         </varlistentry>
505                         <varlistentry>
506                             <term>font_size: </term>
507                             <listitem>
508                                 <para>
509                                     It is a scalar specifying the character size of tics labels.
510                                     If <literal>fractional_font</literal> property is <literal>"off"</literal>
511                                     only the integer part of the value is used.
512                                     For more information see <link linkend="graphics_fonts">graphics_fonts</link>.
513                                 </para>
514                             </listitem>
515                         </varlistentry>
516                         <varlistentry>
517                             <term>font_color: </term>
518                             <listitem>
519                                 <para>This property determines the color of the tics labels.</para>
520                             </listitem>
521                         </varlistentry>
522                         <varlistentry>
523                             <term>fractional_font: </term>
524                             <listitem>
525                                 <para>
526                                     This property specify whether ticks labels are displayed using fractional font sizes.
527                                     Its value must be either <literal>"on"</literal> or <literal>"off"</literal>.
528                                     If <literal>"on"</literal> the floating point value of <literal>font_size</literal>
529                                     is used for display and the font is anti-aliased.
530                                     If <literal>"off"</literal> only the integer part is used
531                                     and the font is not smoothed.
532                                 </para>
533                             </listitem>
534                         </varlistentry>
535                         <varlistentry>
536                             <term>isoview: </term>
537                             <listitem>
538                                 <para>
539                                     This property is used to have isometric scales on the x, y and
540                                     z axes (for example to make the display of the curve sin(x) versus
541                                     cos(x) be a circle not an ellipse). Its value should be
542                                     <literal>"on"</literal> or <literal>"off"</literal>. If the value is
543                                     <literal>"on"</literal>, the axes <literal>data_bounds</literal>
544                                     automatically change according to the corresponding figure
545                                     <literal>figure_size</literal> property values.
546                                 </para>
547                             </listitem>
548                         </varlistentry>
549                         <varlistentry>
550                             <term>cube_scaling:</term>
551                             <listitem>
552                                 <para>
553                                     This property is used in <literal>3d mode</literal> to have a
554                                     rescaling of the x, y and z axes. Indeed, it allows the
555                                     <literal>data</literal> to fit into a 1x1x1 cube ; the goal is to better
556                                     display 3d graphics in case axes scales are very different from
557                                     one to another. Its value should be <literal>"on" </literal> or
558                                     <literal>"off"</literal> (which is the default value). In most cases, it
559                                     helps generating Matlab-like 3d view.
560                                 </para>
561                             </listitem>
562                         </varlistentry>
563                         <varlistentry>
564                             <term>view: </term>
565                             <listitem>
566                                 <para>
567                                     This field is related to the graphics universe. It takes
568                                     <literal>"3d"</literal> as value corresponding to the three-dimensional
569                                     views. In the other case its value can be <literal>"2d"</literal> for
570                                     initial 2d plotting (default value). This flag also depends on the
571                                     plots the user enters : a <literal>plot3d </literal>command, for
572                                     example, will switch the <literal>view</literal> flag from
573                                     <literal>"2d"</literal> to <literal>"3d"</literal>.
574                                 </para>
575                             </listitem>
576                         </varlistentry>
577                         <varlistentry>
578                             <term>rotation_angles: </term>
579                             <listitem>
580                                 <para>
581                                     Spherical coordinates <literal>[alpha, theta]</literal> =
582                                     <literal>[polAngle, azimuth]</literal> of the observation point,
583                                     in degrees:
584                                     <itemizedlist>
585                                         <listitem>
586                                             <emphasis role="bold">theta</emphasis>: azimuth angle
587                                             in the (x,y) plane. Particular angles, for (x,y) seen
588                                             from (O,z):
589                                             <table>
590                                                 <tr><td>270 </td><td>: (O,x) to right</td></tr>
591                                                 <tr><td>0 </td><td>: (O,x) to bottom</td></tr>
592                                                 <tr><td>90 </td><td>: (O,x) to left</td></tr>
593                                                 <tr><td>180 </td><td>: (O,x) to top</td></tr>
594                                             </table>
595                                             <scilab:image><![CDATA[
596                                             // gca().rotation_angles:
597                                             // Azimuth:
598                                             // --------
599                                             x = linspace(0,30,100);
600                                             y = exp(-x/7).*sin(x);
601                                             scf(1);
602                                             clf
603                                             i = 1;
604                                             for a = [270 315 0 90 180]
605                                                 subplot(1,5,i)
606                                                 plot(x, y, "b")
607                                                 gca().rotation_angles(2) = a;
608                                                 gca().margins = [0.17 0.17 0.25 0.15];
609                                                 gca().box = "on";
610                                                 gca().cube_scaling = "on";
611                                                 title(msprintf("theta = %d\n\r", a), "fontsize",3, "color",color("magenta3"))
612                                                 i = i + 1;
613                                             end
614                                             gcf().axes_size = [810 200];
615                                             ]]></scilab:image>
616                                         </listitem>
617                                         <listitem>
618                                             <emphasis role="bold">alpha</emphasis>: polar angle from
619                                             (Oz), in planes orthogonal to (x,y). Particular values:
620                                             <table>
621                                                 <tr><td>0</td><td>= North pole (O,z)</td><td> view from above</td></tr>
622                                                 <tr><td>90</td><td>= Equator (x,y)</td><td> view from side</td></tr>
623                                                 <tr><td>180</td><td>= South pole (O,-z)</td><td> view from below</td></tr>
624                                             </table>
625                                             <scilab:image><![CDATA[
626                                             // gca().rotation_angles:
627                                             // polar angle
628                                             // -----------
629                                             scf(2);
630                                             clf
631                                             i = 1
632                                             for a = [0 30 60 90 120]
633                                                 subplot(1,5,i)
634                                                 plot3d()
635                                                 gce().color_mode = -2;
636                                                 gca().rotation_angles = [a 300];
637                                             //    gca().margins = [0.17 0.17 0.25 0.15];
638                                             //    gca().box = "on";
639                                                 gca().cube_scaling = "on";
640                                                 title(msprintf("alpha = %d\n", a), "fontsize",3, "color",color("magenta3"))
641                                                 i = i + 1;
642                                             end
643                                             gcf().axes_size = [810 220];
644                                             ]]></scilab:image>
645                                         </listitem>
646                                     </itemizedlist>
647                                 </para>
648                             </listitem>
649                         </varlistentry>
650                         <varlistentry>
651                             <term>log_flags: </term>
652                             <listitem>
653                                 <para>
654                                     3 character string that sets the scale (linear or logarithmic) along the axes.
655                                     Each character specifies the scale for respectively the X, Y and Z axes.
656                                     They should take a value between <literal>'n'</literal> for linear scale or
657                                     <literal>'l'</literal> for logarithmic scale.
658                                 </para>
659                                 <scilab:image><![CDATA[
660                                     x = linspace(0,10,100)(2:$);
661                                     m = ["nn" "ln" "nl" "ll"];
662                                     clf
663                                     for i = 1:4
664                                         subplot(1,4,i)
665                                         plot2d(m(i), x, x.^2)
666                                         xgrid(color("grey75"),1,7)
667                                         title(msprintf("""%s""",m(i)),"fontsize",3)
668                                         select i
669                                         case 1, gca().sub_ticks = [3 3];
670                                         case 2, gca().sub_ticks = [8 3];
671                                         case 3, gca().sub_ticks = [3 8];
672                                         case 4, gca().sub_ticks = [8 8];
673                                         end
674                                     end
675                                     gcf().axes_size = [800 220];
676                                 ]]></scilab:image>
677                             </listitem>
678                         </varlistentry>
679                         <varlistentry>
680                             <term>tight_limits: </term>
681                             <listitem>
682                                 <para>
683                                     A <literal>1x3</literal> string vector giving the tight_limits status
684                                     for each axis. This property specifies whether each axis fits exactly with the minima and
685                                     maxima values of the data bounds. If an item is <literal>"off"</literal>, the corresponding axis may
686                                     enlarge boundaries such as to produce pretty tics labels. For a global setting (all axes at once), you have to set its value
687                                     to <literal>"on"</literal> or <literal>"off"</literal> (single string). To act on a single axis,
688                                     the syntax is <literal>tight_limits(N)</literal> where <literal>N</literal> is
689                                     <literal>1,2</literal> or <literal>3</literal> corresponding to the
690                                     <literal>x,y</literal> or <literal>z</literal> axis.
691                                 </para>
692                             </listitem>
693                         </varlistentry>
694                         <varlistentry>
695                             <term>data_bounds: </term>
696                             <listitem>
697                                 <para>
698                                     This field contains the boundary values for the x, y and z
699                                     coordinates. It is either the matrix or the vector
700                                     <literal>[xmin,ymin; xmax,ymax]</literal>,
701                                     <literal>[xmin,ymin,zmin; xmax,ymax,zmax]</literal>,
702                                     <literal>[xmin,xmax,ymin,ymax]</literal>,
703                                     <literal>[xmin,xmax,ymin,ymax,zmin,zmax]</literal>,
704                                     <literal>[xmin;xmax;ymin;ymax]</literal> or
705                                     <literal>[xmin;xmax;ymin;ymax;zmin;zmax]</literal>. Note that, to strictly have the
706                                     specified data bounds, <literal>tight_limits</literal> must be set to
707                                     <literal>"on"</literal> value (see above).
708                                     To manually set data_bounds set <literal>auto_scale="off"</literal>
709                                 </para>
710                             </listitem>
711                         </varlistentry>
712                         <varlistentry>
713                             <term>zoom_box: </term>
714                             <listitem>
715                                 <para>
716                                     This field contains the current zoom box if any coordinates
717                                     are given. It is an empty matrix (no zoom) or the vector
718                                     <literal>[xmin,ymin,xmax,ymax,zmin,zmax]</literal> (defines a smaller axes box).
719                                 </para>
720                             </listitem>
721                         </varlistentry>
722                         <varlistentry>
723                             <term>margins: </term>
724                             <listitem>
725                                 <para>
726                                     A vector
727                                     <literal>[margin_left,margin_right,margin_top,margin_bottom]</literal>
728                                     specifying the margins portion for this axes. This vector is
729                                     composed of numbers between [0 1] with default: [0.125 0.125 0.125
730                                     0.125]. These numbers are ratios relative to associated values of the
731                                     <literal>axes_bounds</literal> property, which are <literal>width</literal> for
732                                     <literal>margin_left</literal> and <literal>margin_right</literal>, and
733                                     <literal>height</literal> for <literal>margin_top</literal> and
734                                     <literal>margin_bottom</literal>.
735                                 </para>
736                             </listitem>
737                         </varlistentry>
738                         <varlistentry>
739                             <term>auto_margins: </term>
740                             <listitem>
741                                 <para>
742                                     A property to allow the automatic computation of the margins accordint to their contents.
743                                     If value is <literal>"on"</literal>, then the automatic computation is activated.
744                                 </para>
745                             </listitem>
746                         </varlistentry>
747                         <varlistentry>
748                             <term>axes_bounds: </term>
749                             <listitem>
750                                 <para>
751                                     Vector <literal>[x_left, y_top, width, height]</literal> of
752                                     four decimal numbers in [0, 1] specifying the portion of figure
753                                     or frame used by this axes:
754                                     <itemizedlist>
755                                         <listitem>
756                                             <literal>x_left</literal> and <literal>y_top</literal>
757                                             set the position of the top-left corner of the axes area,
758                                             with respect to the top-left corner of the embedding
759                                             figure or frame.
760                                         </listitem>
761                                         <listitem>
762                                             <literal>width</literal> and <literal>height</literal>
763                                             set the dimensions of the axes area. 1 stands for the
764                                             full width or height of the embedding figure or frame.
765                                         </listitem>
766                                     </itemizedlist>
767                                 </para>
768                                 <para>
769                                     These numbers are relative to the
770                                     <literal>gca().parent.position(3:4)</literal> [width, height]
771                                     dimensions of the figure or of the Uicontrol frame
772                                     embedding the axes.
773                                 </para>
774                             </listitem>
775                         </varlistentry>
776                         <varlistentry>
777                             <term>hidden_axis_color: </term>
778                             <listitem>
779                                 <para>
780                                     This property defined the color of the hidden axis. It takes
781                                     an index relative to the current colormap.
782                                 </para>
783                             </listitem>
784                         </varlistentry>
785                         <varlistentry>
786                             <term>user_data: </term>
787                             <listitem>
788                                 <para>
789                                     This field can be use to store any scilab variable in the axes
790                                     data structure, and to retrieve it.
791                                 </para>
792                             </listitem>
793                         </varlistentry>
794                     </variablelist>
795                 </listitem>
796             </varlistentry>
797             <varlistentry>
798                 <term>Properties for high level functions</term>
799                 <listitem>
800                     <para>
801                         The <literal>plot</literal>, <literal>plot2dx</literal>, <literal>grayplot</literal>
802                         and <literal>matplot</literal> functions use the following properties to
803                         decide how to merge consecutive plots if this is not stated by the
804                         <literal>frameflag</literal> calling argument. The result of the merge is
805                         decided through these two following properties:
806                     </para>
807                     <variablelist>
808                         <varlistentry>
809                             <term>auto_clear: </term>
810                             <listitem>
811                                 <para>
812                                     If this property value is equal to <literal>"on"</literal>, a call
813                                     to a high level graphic will re-initialize the current axes and
814                                     erase all its children before preforming the drawing (log_flags will be reset).
815                                     If the value is <literal>"off"</literal> the drawings will be added to current axes
816                                     according to <literal>"auto_scale"</literal> property.
817                                 </para>
818                             </listitem>
819                         </varlistentry>
820                         <varlistentry>
821                             <term>auto_scale: </term>
822                             <listitem>
823                                 <para>
824                                     A property to update the axes data boundary. If value is
825                                     <literal>"on"</literal>, a new plot will adapt the current axes
826                                     properties to fit with previous and current plots. If its value is
827                                     <literal>"off"</literal> the new plot will be drawn in the current axes
828                                     data boundary.
829                                 </para>
830                             </listitem>
831                         </varlistentry>
832                     </variablelist>
833                 </listitem>
834             </varlistentry>
835             <varlistentry>
836                 <term>Children's default values: </term>
837                 <listitem>
838                     <variablelist>
839                         <varlistentry>
840                             <term>hiddencolor: </term>
841                             <listitem>
842                                 <para>
843                                     This property controls the hidden parts' color. It takes as
844                                     value an index relative to the current colormap. In another case,
845                                     if it is a negative value, the hidden parts take the same colors
846                                     as the surface
847                                 </para>
848                             </listitem>
849                         </varlistentry>
850                         <varlistentry>
851                             <term>line_mode: </term>
852                             <listitem>
853                                 <para>
854                                     This field contains the default <literal>line_mode</literal>
855                                     property value for Segs Rectangle Legend Axis Plot3d Fac3d and
856                                     Polyline objects. Its value should be <literal>"on" </literal>(default)
857                                     or <literal>"off"</literal>.
858                                 </para>
859                             </listitem>
860                         </varlistentry>
861                         <varlistentry>
862                             <term>line_style: </term>
863                             <listitem>
864                                 <para>
865                                     This field contains the default <literal>line_style</literal>
866                                     property value for Segs, Arcs, Rectangle and Polyline objects.
867                                     <literal>line_style</literal> selects the type of line to be used to
868                                     draw lines . Its value should be an integer in [1 10]. 1
869                                     stand for solid, the other values stand for a selection of dashes
870                                     (dash, dash dot, longdash dot, bigdash dot, bigdash longdash, dot, double dot, longblank dot, bigblank dot).
871                                 </para>
872                             </listitem>
873                         </varlistentry>
874                         <varlistentry>
875                             <term>thickness: </term>
876                             <listitem>
877                                 <para>
878                                     This field contains the default <literal>thickness</literal>
879                                     property value for all objects using line drawing. It is a positive real specifying the line width
880                                     in pixels. The displayed width is actually determined by rounding the supplied width
881                                     to the nearest integer. The only exception is vectorial export where the whole <literal>thickness</literal>
882                                     value is considered.
883                                 </para>
884                             </listitem>
885                         </varlistentry>
886                         <varlistentry>
887                             <term>mark_mode: </term>
888                             <listitem>
889                                 <para>
890                                     This field contains the default <literal>mark_mode</literal>
891                                     property value for Segs Rectangle Legend Axis Plot3d Fac3d and
892                                     Polyline objects. Its value should be <literal>"on" </literal> or
893                                     <literal>"off"</literal> (default).
894                                 </para>
895                             </listitem>
896                         </varlistentry>
897                         <varlistentry>
898                             <term>mark_style: </term>
899                             <listitem>
900                                 <para>
901                                     This field contains the default <literal>mark_style</literal>
902                                     property value for Segs Rectangle Legend Axis Plot3d Fac3d and
903                                     Polyline objects. <literal>mark_style</literal> selects the type of mark
904                                     to be displayed. Its value should be an integer in [0 9] which
905                                     stands for: dot, plus, cross, star, filled diamond, diamond,
906                                     triangle up, triangle down, trefle and circle.
907                                 </para>
908                             </listitem>
909                         </varlistentry>
910                         <varlistentry>
911                             <term>mark_size_unit: </term>
912                             <listitem>
913                                 <para>
914                                     This field contains the default <literal>mark_size_unit</literal>
915                                     property value for Segs Rectangle Legend Axis Plot3d Fac3d and
916                                     Polyline objects. If <literal>mark_size_unit</literal> is set to
917                                     <literal>"point"</literal>, then the <literal>mark_size</literal> value is
918                                     directly given in points. When <literal>mark_size_unit</literal> is set
919                                     to <literal>"tabulated"</literal>, <literal>mark_size</literal> is computed
920                                     relative to the font size array: therefore, its value should be an
921                                     integer in [0 5] which stands for 8pt, 10pt, 12pt, 14pt, 18pt and
922                                     24pt. Note that <link linkend="plot2d">plot2d</link> and pure scilab functions use
923                                     <literal>tabulated</literal> mode as default ; when using
924                                     <link linkend="plot">plot</link> function, the <literal>point</literal> mode is
925                                     automatically enabled.
926                                 </para>
927                             </listitem>
928                         </varlistentry>
929                         <varlistentry>
930                             <term>mark_size: </term>
931                             <listitem>
932                                 <para>
933                                     This field contains the default <literal>mark_size</literal>
934                                     property value for Segs Rectangle Legend Axis Plot3d Fac3d and
935                                     Polyline objects. <literal>mark_size</literal> selects the font size of
936                                     mark to be displayed. Its value should be an integer in [0 5]
937                                     which stands for 8pt, 10pt, 12pt, 14pt, 18pt and 24pt.
938                                 </para>
939                                 <para>
940                                     <warning>In the special case where mark_style and mark_size are 0, a dot of one pixel is drawn.</warning>
941                                 </para>
942                             </listitem>
943                         </varlistentry>
944                         <varlistentry>
945                             <term>mark_foreground: </term>
946                             <listitem>
947                                 <para>
948                                     This field contains the default <literal>mark_foreground</literal>
949                                     property value for all objects created under this axes. Polyline,
950                                     rectangle, legend, surface, segment and axis objects are using
951                                     this property to specify a foreground (edge) color for their
952                                     marks. Its value should be a color index (relative to the current
953                                     color_map) or 0 for transparent edge. Note that the default value is <literal>-1</literal>
954                                     (default black) and, even if you change the
955                                     <literal>color_map</literal>, this <literal>-1</literal> value will always
956                                     point onto the default black color.
957                                 </para>
958                             </listitem>
959                         </varlistentry>
960                         <varlistentry>
961                             <term>mark_background: </term>
962                             <listitem>
963                                 <para>
964                                     This property controls the default
965                                     <literal>mark_background</literal> property value for all objects
966                                     created under this axes. Polyline, rectangle, legend, surface,
967                                     segment and axis objects are using this property to specify a
968                                     background (face) color for their marks. It takes as value an
969                                     index relative to the current colormap or 0 for transparent face. Note that the default value
970                                     is <literal>-2</literal> (default white) and, even if you change the
971                                     <literal>color_map</literal>, this <literal>-2</literal> value will always
972                                     point onto the default white color.
973                                 </para>
974                             </listitem>
975                         </varlistentry>
976                         <varlistentry>
977                             <term>foreground: </term>
978                             <listitem>
979                                 <para>
980                                     This field contains the default <literal>foreground</literal>
981                                     property value for axes and all objects created under this axes.
982                                     Its value should be a color index (relative to the current
983                                     color_map). Note that the default value is <literal>-1</literal>
984                                     (default black) and, even if you change the
985                                     <literal>color_map</literal>, this <literal>-1</literal> value will always
986                                     point onto the default black color.
987                                 </para>
988                             </listitem>
989                         </varlistentry>
990                         <varlistentry>
991                             <term>background: </term>
992                             <listitem>
993                                 <para>
994                                     This property controls the default <literal>background</literal>
995                                     property value for axes and all objects created under this axes.
996                                     It takes as value an index relative to the current colormap.Note
997                                     that the default value is <literal>-2</literal> (default white) and,
998                                     even if you change the <literal>color_map</literal>, this
999                                     <literal>-2</literal> value will always point onto the default white
1000                                     color.
1001                                 </para>
1002                             </listitem>
1003                         </varlistentry>
1004                         <varlistentry>
1005                             <term>arc_drawing_mode: </term>
1006                             <listitem>
1007                                 <para>
1008                                     This property controls the default <literal>arc_drawing_mode</literal>
1009                                     property value for all created Arc objects under this Axes object.
1010                                     Its value should be either <literal>"nurbs"</literal> or <literal>"lines"</literal>.
1011                                 </para>
1012                             </listitem>
1013                         </varlistentry>
1014                         <varlistentry>
1015                             <term>clip_state: </term>
1016                             <listitem>
1017                                 <para>
1018                                     This field contains the default <literal>clip_state</literal>
1019                                     property value for all objects. Its value should be :
1020                                 </para>
1021                                 <itemizedlist>
1022                                     <listitem>
1023                                         <para>
1024                                             <literal>"off"</literal> this means that all objects created
1025                                             after that are not clipped (default value).
1026                                         </para>
1027                                     </listitem>
1028                                     <listitem>
1029                                         <para>
1030                                             <literal>"clipgrf"</literal> this means that all objects created
1031                                             after that are clipped outside the Axes boundaries.
1032                                         </para>
1033                                     </listitem>
1034                                     <listitem>
1035                                         <para>
1036                                             <literal>"on"</literal> this means that all objects created
1037                                             after that are clipped outside the rectangle given by property
1038                                             clip_box.
1039                                         </para>
1040                                     </listitem>
1041                                 </itemizedlist>
1042                             </listitem>
1043                         </varlistentry>
1044                         <varlistentry>
1045                             <term>clip_box: </term>
1046                             <listitem>
1047                                 <para>
1048                                     This field contains the default <literal>clip_box</literal> property
1049                                     value for all objects. Its value should be an empty matrix if
1050                                     clip_state is <literal>"off"</literal>. Other case the clipping is given
1051                                     by the vector <literal>[x,y,w,h]</literal> (upper-left point width
1052                                     height).
1053                                 </para>
1054                             </listitem>
1055                         </varlistentry>
1056                         <varlistentry>
1057                             <term>Note on default values :</term>
1058                             <listitem>
1059                                 <variablelist>
1060                                     <varlistentry>
1061                                         <term/>
1062                                         <listitem>
1063                                             <para>
1064                                                 All these listed properties and fields inherit from
1065                                                 default values stored in an axes model. These default values
1066                                                 can be seen and changed. To do so, use the
1067                                                 <literal>get("default_axes")</literal> command : it returns a
1068                                                 graphic handle on the axes model. Note that no graphic window
1069                                                 is created by this command. The next created axes will inherit
1070                                                 from this model (see "Example on axes model" below).
1071                                             </para>
1072                                         </listitem>
1073                                     </varlistentry>
1074                                 </variablelist>
1075                             </listitem>
1076                         </varlistentry>
1077                     </variablelist>
1078                 </listitem>
1079             </varlistentry>
1080         </variablelist>
1081     </refsection>
1082     <refsection>
1083         <title>Examples</title>
1084         <programlisting role="example"><![CDATA[
1085 lines(0) // disables vertical paging
1086 a=get("current_axes")//get the handle of the newly created axes
1087 a.axes_visible="on"; // makes the axes visible
1088 a.font_size=3; //set the tics label font size
1089 a.x_location="top"; //set the x axis position
1090 a.data_bounds=[-100,-2,-1;100,2,1]; //set the boundary values for the x, y and z coordinates.
1091 a.sub_tics=[5,0];
1092 a.labels_font_color=5;
1093 a.grid=[2,2];
1094 a.box="off";
1095
1096 // Example with 3D axes
1097 clf(); //clear the graphics window
1098 x=0.1:0.1:2*%pi;plot2d(x-.3,sin(x)*7+.2);
1099 a=gca(); // get the handle of the current axes
1100 a.grid=[1 -1 -1]; //make x-grid
1101 a.rotation_angles=[70 250]; //turn the axes with giving angles
1102 a.grid=[1 6 -1]; //make y-grid
1103 a.view="2d"; //return te the 2d view
1104 a.box="back_half";
1105 a.labels_font_color=5;
1106 a.children.children.thickness=4;
1107 a.children.children.polyline_style=3;
1108 a.view="3d"; //return te the 3d view
1109 a.children.children.thickness=1;
1110 a.children.children.foreground=2;
1111 a.grid=[1 6 3]; //make z-grid
1112 a.parent.background=4;
1113 a.background=7;
1114 plot2d(cos(x)+1,3*sin(x)-3);
1115 plot2d(cos(x)+7,3*sin(x)+3);
1116 a.children(2).children.polyline_style=2;
1117 a.children(1).children.polyline_style=4;
1118 a.children(1).children.foreground=5;
1119 a.children(2).children.foreground=14;
1120 a.parent.figure_size= [1200,800];
1121 a.box="on";
1122 a.labels_font_size=4;
1123 a.parent.background=8;
1124 a.parent.figure_size= [400,200];
1125 a.rotation_angles=[0 260];
1126 delete(a.children(2));
1127 delete(); // delete current object
1128
1129 a = gca();
1130 a.labels_font_size=1;
1131 a.auto_clear= "on";
1132 x=0:0.1:2.5*%pi;plot2d(10*cos(x),sin(x));
1133
1134 a.data_bounds(:,1) = [1;15] ; // set positive bounds for X axe
1135 a.log_flags = "lnn" ; // set X axes to logarithmic scale
1136 a.log_flags = "nnn" ; // switch back to linear scale
1137
1138 a=gca();
1139 a.rotation_angles=[45 45];
1140 a.data_bounds=[-20,-3,-2;20 3 ,2];
1141 xrect([-4 0.5 8 1]);
1142 a.auto_clear = "off" ;
1143 a.isoview="on"; // isoview mode
1144 xrect([-2 0.25 4 0.5]);
1145 a.children(1).fill_mode="on";
1146 a.axes_visible="off";
1147 a.children(1).data=[-2 0.25 -1 4 0.5];
1148 a.children(2).data=[-4 0.5 1 8 1];
1149 x=2*%pi*(0:7)/8;
1150 xv=[.2*sin(x);.9*sin(x)];yv=[.2*cos(x);.9*cos(x)];
1151 xsegs(10*xv,yv,1:8)
1152 s=a.children(1);
1153 s.arrow_size=1;
1154 s.segs_color=5;
1155 a.data_bounds //the boundary values for the x,y and z coordinates
1156 a.view="2d";
1157 a.data_bounds=[-10,-1; 10,1]; // set the boundary values for the two-dimensional views
1158
1159 // Example on axes model
1160 da=gda() // get the handle on axes model to view and edit the fields
1161 // title by default
1162 da.title.text="My Default@Title"
1163 da.title.foreground = 12;
1164 da.title.font_size = 4;
1165 // x labels default
1166 da.x_label.text="x";
1167 da.x_label.text="x"; // Latex or MathML can be used here also
1168 da.x_label.font_style = 8;
1169 da.x_label.font_size = 2;
1170 da.x_label.foreground = 5;
1171 da.x_location = "middle";
1172 // y labels default
1173 da.y_label.text="y";
1174 da.y_label.font_style = 3;
1175 da.y_label.font_size = 5;
1176 da.y_label.foreground = 3;
1177 da.y_location = "right";
1178 da.thickness = 2;
1179 da.foreground = 7;
1180 // the plot
1181 x=(0:0.1:2*%pi)';
1182 plot2d(x,[sin(x),sin(2*x),sin(3*x)],style=[1,2,3],rect=[0,-2,2*%pi,2]);
1183 sda() // back to default axes model
1184
1185
1186 // Example with LaTeX / MathML ticks:
1187 plot2d();
1188 a=gca();
1189
1190 mathml = "<mrow><mfrac><mrow><mi>d</mi>  <mi>y</mi></mrow><mrow>  <mi>d</mi>  <mi>x</mi></mrow></mfrac> <mo>=</mo>" + ...
1191     "<mfrac><mn>1</mn><msup> <mi>y</mi>  <mn>2</mn></msup> </mfrac> </mrow>";
1192 // Only LaTeX expression
1193 a.x_ticks = tlist(["ticks", "locations", "labels"], (0:6)', [mathml;"1";"$\sin(x)$";"3";"$\cos(a) - test$";"5";"6"]);
1194
1195 // Mixed expression: MathML and LaTex
1196 a.y_ticks = tlist(["ticks", "locations", "labels"], (-2:0.5:2)', ["0";"1";"2";"3";"$\cos(a)$";"5";"6";mathml;"8"]);
1197
1198  ]]>
1199         </programlisting>
1200         <para/>
1201         <programlisting role="example"><![CDATA[
1202 m = [66.425514; 66.425513];
1203 plot([69;70], m);
1204 a = gca();
1205 a.ticks_format = ["" sprintf("%.2f", m(2))+"%+.1e"];
1206 a.ticks_st = [1 1;0 m(2)];
1207 ]]></programlisting>
1208         <para>
1209             Example with vertical x_ticks labels:
1210         </para>
1211         <programlisting role="example" id="axes_properties_vertical_xticks"><![CDATA[
1212 rain_Nice  = [51  45  39 69 45 34 12 18 73 133 104 93 ];
1213 months = _(["January" "February" "March" "April" "May" "June" "July" ...
1214             "August" "September" "October" "November" "December"]);
1215 clf
1216 bar(rain_Nice,1,"cyan");
1217 title(_("Rain - Nice (France)"), "fontsize",3)
1218 ylabel("[mm]")
1219 gca().x_ticks.labels = "$\rotatebox{90}{\mathsf{"+months'+"}}$";
1220 set(gca(), "tight_limits", "on", "font_size", 2);
1221 gcf().axes_size = [460 320];
1222 ]]></programlisting>
1223     <scilab:image localized="true">
1224 rain_Nice  = [51  45  39 69 45 34 12 18 73 133 104 93 ];
1225 months = _(["January" "February" "March" "April" "May" "June" "July" ..
1226             "August" "September" "October" "November" "December"]);
1227 clf
1228 bar(rain_Nice, 1, "cyan")
1229 title(_("Rain - Nice (France)"), "fontsize",3);
1230 ylabel("[mm]");
1231 gca().x_ticks.labels = "$\rotatebox{90}{\mathsf{"+months'+"}}$";
1232 set(gca(), "tight_limits", "on", "font_size", 2);
1233 gcf().axes_size = [420 320];
1234     </scilab:image>
1235     </refsection>
1236     <refsection role="see also">
1237         <title>See also</title>
1238         <simplelist type="inline">
1239             <member>
1240                 <link linkend="axis_properties">axis_properties</link>
1241             </member>
1242             <member>
1243                 <link linkend="drawaxis">drawaxis</link>
1244             </member>
1245             <member>
1246                 <link linkend="set">set</link>
1247             </member>
1248             <member>
1249                 <link linkend="get">get</link>
1250             </member>
1251             <member>
1252                 <link linkend="gca">gca</link>
1253             </member>
1254             <member>
1255                 <link linkend="gda">gda</link>
1256             </member>
1257             <member>
1258                 <link linkend="sda">sda</link>
1259             </member>
1260             <member>
1261                 <link linkend="polyline_properties">polyline_properties</link>
1262             </member>
1263             <member>
1264                 <link linkend="graphics_entities">graphics_entities</link>
1265             </member>
1266         </simplelist>
1267     </refsection>
1268     <refsection>
1269         <title>History</title>
1270         <revhistory>
1271             <revision>
1272                 <revnumber>5.4.0</revnumber>
1273                 <revremark>.line_style value 0 is replaced with 1 (for solid line).</revremark>
1274             </revision>
1275             <revision>
1276                 <revnumber>5.5.0</revnumber>
1277                 <revremark>
1278                     <itemizedlist>
1279                         <listitem>.grid_style and .grid_thickness properties added.</listitem>
1280                         <listitem>
1281                             .line_style values 9 and 10 can be used to have respectively longblank
1282                             dot and bigblank dot styles.
1283                         </listitem>
1284                         <listitem>
1285                             .auto_margins property added to allow automatic computation of the margins.
1286                         </listitem>
1287                         <listitem>
1288                             .ticks_format and .ticks_st properties added to improve ticks labels
1289                             display.
1290                         </listitem>
1291                         <listitem>
1292                             For an axes drawn in a uicontrol frame, .axes_bounds now refers to
1293                             the frame area instead of the figure area.
1294                         </listitem>
1295                     </itemizedlist>
1296                 </revremark>
1297             </revision>
1298             <revision>
1299                 <revnumber>5.5.2</revnumber>
1300                 <revremark>.tight_limits property can now manage X, Y and Z axis separately.</revremark>
1301             </revision>
1302             <revision>
1303                 <revnumber>6.1.0</revnumber>
1304                 <revremark>Default .grid_style is now [7 7] instead of [3 3].</revremark>
1305             </revision>
1306         </revhistory>
1307     </refsection>
1308 </refentry>