<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
<!DOCTYPE MAN SYSTEM "../../manrev.dtd">
<MAN>
  <LANGUAGE>eng</LANGUAGE>

  <TITLE>grayplot_properties</TITLE>

  <TYPE>Scilab Data type</TYPE>

  <DATE>2002</DATE>

  <SHORT_DESCRIPTION name="grayplot_properties">description of the grayplot
  entities properties</SHORT_DESCRIPTION>

  <DESCRIPTION>
    <P>The Grayplot entity is a leaf of the graphics entities hierarchy. It
    represents 2D plots of surface using colors and images (see
    <VERB>grayplot</VERB>, <VERB>Sgrayplot</VERB>, <VERB>fgrayplot</VERB> and
    <VERB>Sfgrayplot</VERB>).</P>

    <DESCRIPTION_INDENT>
      <DESCRIPTION_ITEM label="parent: ">
        <SP>This property contains the handle of the parent. The parent of the
        grayplot entity should be of the type <VERB>"Axes"</VERB>.</SP>
      </DESCRIPTION_ITEM>

      <DESCRIPTION_ITEM label="children: ">
        <SP>This property contains a vector with the <VERB>children</VERB> of
        the handle. However, <VERB>grayplot</VERB> handles currently do not
        have any <VERB>children</VERB>.</SP>
      </DESCRIPTION_ITEM>

      <DESCRIPTION_ITEM label="visible: ">
        <SP>This field contains the <VERB>visible</VERB> property value for
        the entity . It should be <VERB>"on" </VERB> or <VERB>"off"</VERB> .
        By default, the plot is visible, the value's property is
        <VERB>"on"</VERB>. If <VERB>"off"</VERB> the plot is not drawn on the
        screen.</SP>
      </DESCRIPTION_ITEM>

      <DESCRIPTION_ITEM label="data: ">
        <SP>This field defines a <VERB>tlist</VERB> data structure of type
        <VERB>"grayplotdata"</VERB> composed of a row and column indices of
        each element : the x and y grid coordinates are contained respectively
        in <VERB>data.x</VERB> and <VERB>data.y</VERB>. The complementary
        field named <VERB>data.z</VERB> is the value of the surface at the
        point <VERB>(x(i),y(j))</VERB> (scaled mode) or the centered value of
        the surface defined between two consecutive <VERB>x(i)</VERB> and
        <VERB>y(j)</VERB> (direct mode). If <VERB>data_mapping</VERB> (see
        below) is set to <VERB>"scaled"</VERB>, the entire z data is used to
        perform a color interpolation whereas, if <VERB>data_mapping</VERB>'s
        value is <VERB>"direct"</VERB>, the last line and column of the z data
        indices are ignored and the color is determined directly in the
        colormap by the indices of the submatrix
        <VERB>data.z(1:$-1,1:$-1)</VERB>.</SP>
      </DESCRIPTION_ITEM>

      <DESCRIPTION_ITEM label="data_mapping: ">
        <SP>By default the value of this property is <VERB>"scaled"</VERB> :
        the indices of painting colors are proportional to the value
        <VERB>z</VERB> coordinates. In the other case, the property takes as
        value <VERB>"direct"</VERB> where the plot is a grayplot and the
        indices of painting colors are given by the data (see above).</SP>
      </DESCRIPTION_ITEM>

      <DESCRIPTION_ITEM label="user_data: ">
        <SP>This field can be use to store any scilab variable in the grayplot
        data structure, and to retreive it.</SP>
      </DESCRIPTION_ITEM>
    </DESCRIPTION_INDENT>
  </DESCRIPTION>

  <EXAMPLE><![CDATA[

   set("figure_style","new") //create a figure


   m=5;n=5;
   M=round(32*rand(m,n));
   grayplot(1:m,1:n,M)

   a=get("current_axes");
   a.data_bounds=  [-1,-1;7,7]
   h=a.children

   h.data_mapping="direct";
   
   // A 2D ploting of a matrix using colors 
   xbasc()
   a=get("current_axes");
   a.data_bounds=  [0,0;4,4];
  
   b=5*ones(11,11); b(2:10,2:10)=4; b(5:7,5:7)=2;
   Matplot1(b,[1,1,3,3])  ;
  
   h=a.children
   for i=1:7
    xclick(); // click the mouse to sets Matplot data
    h.data=h.data+4;
   end
   

 
  ]]></EXAMPLE>

  <SEE_ALSO>
    <SEE_ALSO_ITEM>
      <LINK>set</LINK>
    </SEE_ALSO_ITEM>

    <SEE_ALSO_ITEM>
      <LINK>get</LINK>
    </SEE_ALSO_ITEM>

    <SEE_ALSO_ITEM>
      <LINK>delete</LINK>
    </SEE_ALSO_ITEM>

    <SEE_ALSO_ITEM>
      <LINK>grayplot</LINK>
    </SEE_ALSO_ITEM>

    <SEE_ALSO_ITEM>
      <LINK>Matplot</LINK>
    </SEE_ALSO_ITEM>

    <SEE_ALSO_ITEM>
      <LINK>Matplot1</LINK>
    </SEE_ALSO_ITEM>

    <SEE_ALSO_ITEM>
      <LINK>graphics_entities</LINK>
    </SEE_ALSO_ITEM>

    <SEE_ALSO_ITEM>
      <LINK>Matplot_properties</LINK>
    </SEE_ALSO_ITEM>
  </SEE_ALSO>

  <AUTHOR>Djalel ABDEMOUCHE &amp; F.Leray</AUTHOR>
</MAN>