- Scilab Online Help
- Graphics Library
- 2d_plot
- LineSpec
- Matplot
- Matplot1
- Matplot_properties
- Sfgrayplot
- Sgrayplot
- champ
- champ1
- champ_properties
- contour2d
- contour2di
- contourf
- errbar
- fchamp
- fcontour2d
- fec
- fec_properties
- fgrayplot
- fplot2d
- grayplot
- grayplot_properties
- graypolarplot
- histplot
- oldplot
- paramfplot2d
- plot
- plot2d
- plot2d1
- plot2d2
- plot2d3
- plot2d4
- plot2d_old_version
- polarplot

Please note that the recommended version of Scilab is 6.1.1. This page might be outdated.

See the recommended documentation of this function

# champ_properties

description of the 2D vector field entity properties

### Description

The Champ entity is a leaf of the graphics entities hierarchy. This entity defines the parameters for a 2D vector field.

- visible:
This properties contains the

`visible`

property value for the entity . It should be`"on"`

or`"off"`

. If`"on"`

the vector field is drawn, If`"off"`

the vector field is not displayed on the screen.- data:
This field defines a

`tlist`

data structure of type`"champdata"`

composed of a row and column indices of each element : the x and y grid coordinates are contained respectively in`data.x`

and`data.y`

. The complementary fields named`data.fx`

and`data.fy`

are matrices which describe respectively the`x`

and`y`

component of the vector field at point`(x(i),y(j))`

.- user_data:
This field can be use to store any scilab variable in the champ data structure, and to retreive it.

- line_style:
The

`line_style`

property value should be an integer in [0 8]. 0 and 1 stands for solid, the other value stands for a selection of dashes (see getlinestyle).- thickness:
This property is a positive real specifying the arrow width in pixels. The displayed width is actually determined by rounding the supplied width to the nearest integer. The only exception is vectorial export where the whole

`thickness`

value is considered.- colored:
If this this property value is

`"on"`

, fields vectors are drawn using a color proportional to the intensity of the field.- clip_state:
This field contains the

`clip_state`

property value for the champ. It should be :`"off"`

this means that the vector field is not clipped`"clipgrf"`

this means that the vector field is clipped outside the Axes box.`"on"`

this means that the vector field is clipped outside the rectangle given by property clip_box.

- clip_box:
This property contains the

`clip_box`

property. 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 vector field to display, however`clip_state`

property value will be changed.- parent:
This property contains the handle of the parent. The parent of the 2D vector field entity should be of the type

`"Axes"`

or`"Compound"`

.

### Examples

### Authors

Djalel ABDEMOUCHE

## Comments

Add a comment:Please login to comment this page.