setBrushLocation.ggobi        package:Rggobi        R Documentation

_G_e_t_s _o_r _s_e_t_s _t_h_e _l_o_c_a_t_i_o_n _a_n_d/_o_r _d_i_m_e_n_s_i_o_n _o_f _t_h_e _s_e_l_e_c_t_i_o_n _r_e_g_i_o_n
_o_f _a _g_g_o_b_i _d_a_t_a_s_e_t.

_D_e_s_c_r_i_p_t_i_o_n:

     This  allows the user to query and set the location and  size of
     the brushing region of a ggobi dataset.

_U_s_a_g_e:

     setBrushLocation.ggobi(x, y, .data = 1, .gobi=getDefaultGGobi(), update=TRUE, units=0)
     getBrushLocation.ggobi(.data = 1, .gobi=getDefaultGGobi(), units=0)
     setBrushSize.ggobi(w, h, .data=1, .gobi=getDefaultGGobi(), update = TRUE, units=0)
     getBrushSize.ggobi(.data=1, .gobi=getDefaultGGobi(), units=0)

_A_r_g_u_m_e_n_t_s:

       x: the x coordinate at which to locate the brushing region (in
          pixels)

       y: the x coordinate at which to locate the brushing region (in
          pixels)

       w: the width to which to set the brushing region (in pixels)

       h: the height to which to set the brushing region (in pixels)

   .data: the dataset identifier for which the brush should be set or
          queried. This can be a simple index or an object of class
          'ggobiDataset'. If the latter is set, no value for '.gobi'
          need be specified.

   .gobi: the identifier for the ggobi instance in which the  dataset
          can be resolved. This can be either an index identifying the
          ggobi instance by order, or an object of class 'ggobi' 
          returned from a call to 'ggobi' or 'getGGobi'.

  update: whether to force the recomputation of the points within  the
          brushing region and the updating of the display giving the
          number of points within this region. This is often supressed
          when changing both location and size in two separate actions.

   units: currently ignored, but will allow specification of what units

_D_e_t_a_i_l_s:

_V_a_l_u_e:

_N_o_t_e:

     The settings are in pixel coordinates relative to the plot and not
     the coordinates of the data being plotted.  In the future, we will
     provide functions to map between these different units.

_A_u_t_h_o_r(_s):

     Duncan Temple Lang

_R_e_f_e_r_e_n_c_e_s:

     <URL: http://www.ggobi.org>

_S_e_e _A_l_s_o:

     'getSelectedIndices.ggobi' 'getBrushColor.ggobi'
     'setBrushColor.ggobi' 'getBrushGlyph.ggobi' 'setBrushGlyph.ggobi'

_E_x_a_m_p_l_e_s:

      g <- ggobi(system.file("data", "flea.xml", package="Rggobi"), args="-noinit")
      g$setMode("Brush"); 
      g$setBrushLocation(50, 50); 
      g$setBrushSize(100, 50); 
      g$getSelectedIndices()

