Scilab Data type

axes_properties - description of the axes entity properties

### Description

The Axes entity is the second level of the graphics entities hierarchy. This entity defines the parameters allowing the change of coordinates and the axes drawing as well as the parameters's default values for the children creation.
- Axes properties
- visible: This field contains the `visible` property value for axes . It's value should be `"on"` or `"off"` . By default, axes is visible `"on"` in case all "visible" chidren are displayed on the screen, If `"off"` the axes and all its chidren are not drawn.
- axes_visible: This property specifies whether the axes are drawn or not. It's value should be `"on"` or `"off"`. The scaling data and if required the grids are drawn if the value is `"on"`
- box: This property specifies whether to enclose the axes in a box. Take as value `"off"` is to not display the box. The default is `"on"` .
- grid: This field controls a grid drawning and the its color. if the values is `-1` grids are not drawn, else the grids are drawn using the color given indexed by the grid value.
- log_flags: Property defines is linear or logarithmic scaling axes. The field value is a 2 character string, each of them can take the value `n` for linear (normal) or `l` for logarithmic scales for the respective X and Y axis.
- x_location: Specify the location of the x-axis. The possible values are:
- `"bottom"`. In this case the x axis is drawn at the bottom of the axes rectangle.
- `"top"`. In this case the x axis is drawn at the top of the axes rectangle.
- `"middle"` . In this case the x axis is drawn at the position nearest to the 0 y coordinates.
- y_location: Specify the location of the y-axis. The possible values are:
- `"left"`. In this case the y axis is drawn at the left of the axes rectangle.
- `"right"`. In this case the y axis is drawn at the right of the axes rectangle.
- `"middle"`. In this case the y axis is drawn at the position nearest to the 0 x coordinates.
- tics_color: The value of this properties is index of the color used to draw axis'lines and tics.
- labels_font_color: This property determines the color of the tics labels.
- labels_font_size: An integer specifying the font size used to draw the tics labels.
- sub_tics: This field sets the number of tics to draw between two main tics. The field value is the vector `[nx,ny]` where `nx` is the number of sub tics for the x-axis and `ny` respecting to the y-axis.
- tight_limits: If this property value is `"on"` axes adapt to fit exactly with the minima and maxima values of the data_bounds.

  If this field value is `"off"` a axes may enlarge boundary such as to produce pretty tics labels.
- data_bounds: This field contains the boundary values for the x and y coordinates. It is the vector `[xmin,xmax,ymin,ymax]`
- axes_bounds: A vector `[x_left,y_up,width,height]` specifying the portion of figure used by this axes. Where `x_left`, `y_up`, `width` and `height` are numbers in [0 1] give respectively the position of the upper-left corner and the dimension of the axes.
- children: A vector containing the handles of all graphics objects children of the axes These graphics objects are of type `"Agregation"`, `"Rectangle"`, `"Polyline"`, `"Patch"`, `"Segs"`, `"Arc"`, `"Grayplot"`,..
- parent: This field contains the handle of the parent figure.
- Properties for high level functions The `plot2dx` `grayplot` `matplot` functions use the following properties to decide how to merge consecutive plots if this is not stated by the `frameflag` calling argument.

  The result of the merge is decided through these two following properties:
- auto_clear: This property allows a new plot to erase the current axes and its children if value is equal to `"on"`. The plot creates a new axes entity. If the value is `"off"` it will be added to current axes according to `"auto_scale"` property.
- auto_scale: A property to uptate a data boundary. If value is `"on"` a new plot will adapt the current axes properties to fit with previous an current plots.

  If its value is `"off"` the new plot will be drawing under the current axes properties.
- Children s default values:
- line_style: This field contains the default `line_style` property value for Segs, Arcs, Rectangle and Polyline objects. `line_style` selects the type of line to be used to draw lines . It's value should be an integer in [0 9]. 0 stands for solid the other value stands for a selection of dashes.
- thickness: This field contains the default `thickness` property value for all objects using line drawing. It's value should be positive integer.
- fill_mode: This field contains the default state of `fill_mode` property for Rectangle, Arcs and Polyline objects. It's value should be `"on"` or `"off"`. if it is "on" the object is filled with the color given by it's "foreground" property value.
- mark_mode: This field contains the default `mark_mode` property value for Segs Rectangle and Polyline objects. It's value should be `"on"` or `"off"`.
- mark_style: This field contains the default `mark_style` property value for Segs Rectangle and Polyline objects. `mark_style` selects the type of mark to be displayed. It's value should be an integer in [0 9] which stands for: dot, plus, cross, star, diamond fill, diamond, triangle up, triangle down, trefle and circle.
- mark_size: This field contains the default `mark_size` property value for Segs Rectangle and Polyline objects. `mark_size` selects the font size of mark to be displayed. It's value should be an integer in [0 5] whith stands for 8pt, 10pt, 12pt, 14pt, 18pt and 24pt.
- foreground: This field contains the default `foreground` property value for all objects. It's value should be a color index (relative to the current color_map).
- clip_state: This field contains the default `clip_state` property value for all objects. It's value should be :
- `"off"` this means that all objects created after that are not clipped (default value).
- `"cliprf"` this means that all objects created after that are clipped outside the Axes boundaries.
- `"on"` this means that all objects created after that are clipped outside the rectangle given by property clip_box.
- clip_box: This field contains the default `clip_box` property value for all objects. Its value should be an empty matrix if clip_state is "off". Other case the clipping is given by the vector `[x,y,w,h]` (upper-left point width height).

### Examples

       set("figure_style","new") //create a figure
       a=get("current_axes")//get the handle of the newly created axes
       a.axes_visible="on"; // makes the axes visible
       a.tics_textsize=3; //set the tics label font size
       a.x_location="top"; //set the x axis position
       a.data_bounds=[-100,100;-2,2]; //set the boundary values for the x and y coordinates.
       a.sub_tics=[5,0];
       a.labels_font_color=5;
       a.grid=2;
       a.box="off";

### See Also

`set` `get` `delete` `graphics_entities`

### Author

Djalel ABDEMOUCHE