grid.add                package:grid                R Documentation

_A_d_d _a _G_r_i_d _G_r_a_p_h_i_c_a_l _O_b_j_e_c_t

_D_e_s_c_r_i_p_t_i_o_n:

     Add a grob to a gTree or a descendant of a gTree.

_U_s_a_g_e:

     grid.add(gPath, child, strict = FALSE, grep = FALSE,
              global = FALSE, allDevices = FALSE, redraw = TRUE) 

     addGrob(gTree, child, gPath = NULL, strict = FALSE, grep = FALSE,
             global = FALSE)

     setChildren(x, children)

_A_r_g_u_m_e_n_t_s:

gTree, x: A gTree object.

   gPath: A gPath object. For 'grid.add' this specifies a gTree on the
          display list.  For 'addGrob' this specifies a descendant of
          the specified gTree. 

   child: A grob object. 

children: A gList object. 

  strict: A boolean indicating whether the gPath must be matched
          exactly. 

    grep: A boolean indicating whether the 'gPath' should be treated as
          a regular expression.  Values are recycled across elements of
          the 'gPath' (e.g., 'c(TRUE, FALSE)' means that every odd
          element of the 'gPath' will be treated as a regular
          expression). 

  global: A boolean indicating whether the function should affect just
          the first match of the 'gPath', or whether all matches should
          be affected. 

allDevices: A boolean indicating whether all open devices should be
          searched for matches, or just the current device. NOT YET
          IMPLEMENTED. 

  redraw: A logical value to indicate whether to redraw the grob. 

_D_e_t_a_i_l_s:

     'addGrob' copies the specified grob and returns a modified grob.

     'grid.add' destructively modifies a grob on the display list. If
     'redraw' is 'TRUE' it then redraws everything to reflect the
     change.

     'setChildren' is a basic function for setting all children of a
     gTree at once (instead of repeated calls to 'addGrob').

_V_a_l_u_e:

     'addGrob' returns a grob object;  'grid.add' returns 'NULL'.

_A_u_t_h_o_r(_s):

     Paul Murrell

_S_e_e _A_l_s_o:

     'grob', 'getGrob', 'addGrob', 'removeGrob'.