setSVGShapeToolTip      package:RSVGTipsDevice      R Documentation

_S_e_t _t_h_e _t_o_o_l _t_i_p _f_o_r _t_h_e _n_e_x_t _g_r_a_p_h_i_c_s _s_h_a_p_e _d_r_a_w_n _w_i_t_h _t_h_e _R_S_V_G_T_i_p_s _d_e_v_i_c_e.

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

     Set the tool tip for the next graphics shape drawn with the
     RSVGTips device.

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

     setSVGShapeToolTip(title = NULL, desc = NULL, desc1 = desc, desc2 =
     NULL, sub.special=TRUE)

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

   title: A title for the tool tip box. (optional)

    desc: The text of the tool tip. 

   desc1: The first line of text of the tool tip. 

   desc2: The second line of text of the tool tip (used when the tool
          tip mode is 2.) 

sub.special: If 'FALSE', do NOT replace special characters by their XML
          encodings (see details).

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

     This function sets tool tip text that will be used by the next
     graphics shape drawn with 'RSVGTipsDevice'.

     The RSVGTips device "consumes" the tooltip with the first shape
     that it draws, e.g., using 'rect', 'points', 'polygon', etc.  If
     multiple objects are drawn (e.g., by supplying a vector to
     'points'), only the first shape drawn will have a tooltip.  Note
     that 'lines' does NOT use a tooltip.

     Unless 'sub.special=FALSE', the following special characters in
     'title', 'desc', etc. will be substituted by the XML entity as
     shown:

        '&'  &amp;
       '\''  &apos;
       '\"'  &quot;
       '\<'  &lt;
       '\>'  &gt;

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

     Returns an invisible NULL.

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

     Tony Plate tplate@acm.org

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

     Examples here: 'RSVGTipsDevice'

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

     ## Not run: setSVGShapeToolTip(title="A rectangle", desc="that is yellow")

