Description Usage Arguments Details Value Author(s) See Also Examples
Set the tool tip for the next graphics shape drawn with the RSVGTips device.
1 2 |
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 |
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:
\& | \& |
\' | \' |
\" | \" |
\< | \< |
\> | \> |
The exception to this is that an ampersand followed by lower-case letters and then a semi-colon is always left alone, because it already looks like an XML entity.
Returns an invisible NULL.
Tony Plate tplate@acm.org
Examples here: RSVGTipsDevice
1 | ## Not run: setSVGShapeToolTip(title="A rectangle", desc="that is yellow")
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.