figure_properties
figure_properties — description of the
graphics figure entity properties
Description
The figure entity is the top level of the graphics entities
hierarchy. This entity contain a number of properties designed to control
many aspects of displaying Scilab graphics objects.
These properties fall into two categories. Properties that contain information
about figure itself and others related to set default values for the children creation.
| Figure properties: | | figure_style: | The value of this field difines the figure style, it
should be "old" or "new". The
"new" value sets the entity based style. The
"old" value represents the old Scilab graphic mode. In
this case figure_style is the only defined property. | | figure_position: | This field contains the position in pixel of the graphic
window on the screen. The size is the vector
[x,y]. The point [0,0] if the
upper-left corner of the screen. | | figure_size: | This property controls the size in pixel of the screen's graphics
window. The size is the vector [width,height] . | | axes_size: | Used to Specifies the size in pixel of the virtual graphics
window. The size is the vector [width,height] .
The virtual graphic window should be bigger than the part really
visible on the screen. | | auto_resize: | This property determines if graphics window is resized.
If the value is "on" then the axes_size
property is equaled to the figure_size and the axes
children are zoomed accordingly. If the value is "off" that indicate
that axes_size cannot be resized when figure_size
is changed. | | figure_name: | This field contains the name of the figure. This name is a
character string displayed at the top of the graphics_window. | | figure_id: | This field contains the identifier of the figure. This is a
integer number which is prefexed to the figure_window, set at
figure creation and cannot be changed after . | | color_map: | Property which defines the colormap used by this figure. The
colormap is a m by 3 matrix.
m is the number of colors. Color number i is given
as a 3-uple R, G, B corresponding
respectively to red, green and blue intensity between 0 and 1 | | background: | This property controls the figure window background color. IT takes as value
an index relative to the current colormap. | | pixel_drawing_mode: |
This field defines the bitwise operation used to draw the pixel
on the screen. The default mode is copy what is to
say the pixel is drawn as required. More generally the bitwise
operation is performed between the color of the source pixel and
the color of the pixel already present on the screen.
operations are :
"clear",
"and",
"andReverse" ,
"copy", src
"andInverted" ,
"noop" ,
"xor" ,
"or" ,
"nor" ,
"equiv" ,
"invert" ,
"orReverse" ,
"copyInverted" ,
"orInverted" ,
"nand" ,
"set" ,
| | children: | This handles represent
the vector of the figure's children . Note that all figure children are of type "Axes" |
|
| Children s default values: | | auto_scale: | This field contains the default auto_scale property value
for axes creation. It's value should
be "on" or "off" | | auto_clear: | This field contains the default auto_clear property value
for axes creation. It's value should
be "on" or "off" | | visible: | This field contains the default visible property value
for axes creation. It's value should
be "on" or "off" | | 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 a non negative integer. | | fill_mode: | This field contains the default fill_mode property
value for Rectangle, Arcs and Polyline objects.
It's value should be "on" or
"off". if the value 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]. | | mark_size: | This field contains the default mark_size property
value for Segs Rectangle and Polyline objects.
mark_style selects the font size of mark to be
displayed. It's value should be an integer in [0 9]. | | foreground: | This field contains the default foreground property
value for all objects. It's value should be a color index
(relative to the current colormap). | | clip_state: | This field contains the default clip_state property
value for all objects. It's value should be : | "off" under this state all objects created are not clipped
| | "cliprf" this means that all objects created after
that are clipped outside the Axes rectangle.
| | "on" objects created are clipped outside the rectangle given
by the determinate 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". If not objects are clipped to
the bounding box [x,y,w,h] (upper-left point, width, height) | | rotation_style: | This field is related to the "3D Rot" button. It takes unary
as value (default) in the aim to rotate only selected 3D plot.
In the other case its value ca be multiple all 3D plots are rotated. |
|
Examples
set("figure_style","new") //create a figure
f=get("current_figure") //get the handle of the newly created figure
f.figure_position
f.figure_size=[200,200]
f.background=2
See also
set, get, delete, axes_properties
