Man Scilab

text_properties - description of the Text entity properties

Description

The Text entity is a leaf of the graphics entities hierarchy. This entity defines the parameters for string drawing

visible: This field contains the visible property value for the entity . It should be "on" or "off" .By default, the text is visible, the value's property is "on" . If "off" the text is not displayed on the screen.

text: This field is the character string vector which contains the text.

data: This field is the vector [x,y,[z]] of the origin of the text in the data units of the axes.

font_size: The font_size property is used to select the type of size of the text. Its value should be an integer in between 0 and 5 which stands for 8pt, 10pt, 12pt, 14pt, 18pt and 24pt.

font_style: Seven differents fonts are available : "Courrier", "Symbol", "Times", "Times Italic", "Times Bold", "User defined". The font_size property is an index in [0 6] which is associated to the previous font names.

font_angle: This property determines the orientation of the text string. Specify value of rotation in degrees.

foreground: This field contains the color used to display the text. Its value should be a color index (relative to the current colormap).

clip_state: This field contains the clip_state property value for the text. Its value should be :

"off" this means that the text is not clipped.

"cliprf" this means that the text is clipped outside the Axes box.

"on" this means that the text is clipped outside the rectangle given by the property clip_box .

clip_box: This field contains the clip_box property. Its value should be an empty matrix if clip_state is "off" or the vector [x,y,w,h ] (upper-left point width height).

parent: This property contains the handle of the parent. The parent of the text entity should be of the type "Axes" or "Agregation" .

Examples

   

  set("figure_style","new") //create a figure
   a=get("current_axes");
   a.data_bounds=[0,0;1,1];

   xstring(0.5,0.6,"Scilab is not esilaB",0,0)

   t=get("hdl")   //get the handle of the newly created object

   t.foreground=9;
   t.font_size=5;
   t.font_style=5;
   t.text="SCILAB";
   t.font_angle=90;

 

See Also

set ,   get ,   delete ,   xtitle ,   graphics_entities ,  

Author

Djalel ABDEMOUCHE

Back