Man Scilab

polyline_properties - description of the Polyline entity properties

Description

The Polyline entity is a leaf of the graphics entities hierarchy. This entity defines the parameters for polylines.

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

data: This field contains the values for the x and y coordinates. Component Z is to be added in the case of three-dimensional axes. It is a two (three) column matrix [x,y,[z]] of points.

line_style: The line_style property 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 line thickness property. It's value should be positive integer.

polyline_style: This property sets several polyline drawing mode:

If the value is 0 or 1 lines are drawn between two consecutives points.

If the value is 2 the polyline produces a staircase plot. Two consecutives points are linked by an horizontal line followed by a vertical line.

If the value is 3 the polyline produces a bar plot. For each given point (x,y) a vertical line is drawn from (x,y) to (x,0).

If the value is 4 arrows are drawn between two consecutives points.

If the value is 5 the polyline is filled (patch).

mark_mode: If mark_mode property is "on" the polyline is represented by a mark drawn at each given points. If is the default value "off" the polyline is represented using lines.

mark_style: The mark_style property value is used to select the type of mark to use when mark_mode property is "on" . The 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: The mark_size property is used to select the type of size of the marks when mark_mode property is "on" . Its value should be an integer between 0 and 5 whith stands for 8pt, 10pt, 12pt, 14pt, 18pt and 24pt.

foreground: This field contains the default foreground property used to draw the polyline. Its value should be a color index (relative to the current colormap).

clip_state: This field contains the clip_state property value for the polyline. It should be :

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

"clipgrf" this means that the polyline is clipped outside the Axes box.

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

clip_box: This field is to determinate the clip_box property. By Default its value should be an empty matrix if clip_state is "off". Other cases the vector [x,y,w,h] (upper-left point width height) defines the portions of the polyline to display, however clip_state property value will be changed.

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

Examples

  

   set("figure_style","new") //create a figure
   a=get("current_axes")//get the handle of the newly created axes
   a.data_bounds=[-2,2;-2,2];

   xpoly(sin(2*%pi*(0:5)/5),cos(2*%pi*(0:5)/5),"lines",0)
   p=get("hdl"); //get handle on current entity (here the polyline entity)
   p.foreground=2;
   p.thickness=3;
   p.mark_style=9;
   d=p.data;d(1,:)=[0 0];p.data=d;
   a.rotation_angles=[0 45];
   
   p.data=[(-2:0.1:2)' sin((-2:0.1:2)*%pi)']
   p.mark_mode="off";
   p.polyline_style=3;
   p.line_style=4;


 

See Also

set ,   get ,   delete ,   xpoly ,   xfpoly ,   xpolys ,   xfpolys ,   graphics_entities ,  

Author

Djalel ABDEMOUCHE

Back