找回密码
 注册
查看: 5978|回复: 0

R语言 SVGAnnotation包 addToolTips()函数中文帮助文档(中英文对照)

[复制链接]
发表于 2012-2-22 21:13:51 | 显示全部楼层 |阅读模式
addToolTips(SVGAnnotation)
addToolTips()所属R语言包:SVGAnnotation

                                        Add tooltips to SVG elements
                                         SVG元素添加工具提示

                                         译者:生物统计家园网 机器人LoveR

描述----------Description----------

This function and methods add tooltips to SVG elements of a plot that appear when the viewer places the  mouse over the element and leaves it there for a second or two. These tooltips can provide more information about the element such as the observation number of a point, its values for other variables, a description of the units of a variable for the axis label, or an overview of a plot from its  title element.
这个函数和方法添加工具提示SVG元素的图出现时,观众把鼠标在元素和第二个或两个离开那里。这些工具提示可以提供更多的元素,如一个点的观测数量的信息,对其他变量的值,轴标签,或从它的标题元素的图概述变量的单位的描述。


用法----------Usage----------


addToolTips(file, text = seq(along = paths),
            which = seq(along = text),
            doc = xmlPlot(file), save = FALSE,
            paths = getPlotPoints(doc),
            elName = "title", addArea = NA,
            style = "tooltip", addTitleAttribute = TRUE,
            addCSS = NA, silent = missing(addCSS), ...)



参数----------Arguments----------

参数:file
the name of the SVG file, the parsed XML document or an XML node or list of nodes
SVG文件的名称,解析XML文档或XML节点或节点列表


参数:text
the text of the tooltip
工具提示文本


参数:which
the indices of the elements within file being given a tooltip. This is used when putting tooltips on points in a plot and is expected to be used to index both text and  paths.
内file元素的指数得到一个提示。这是使用时,在图上点工具提示,并预计将使用索引都text和paths。


参数:doc
the parsed XML document.
解析XML文档。


参数:save
a logical value or a file name that indicates whether the resulting document is to be written to a file. If this is TRUE, the name of the file is taken from the XML document (doc). If it is FALSE, the document is not  written to a file but returned for further processing and then serialized. If this is a character string, its (first) value is used as the name of the file to which to write the modified document.
一个逻辑值,表明是否产生的文件被写入到一个文件或文件名。如果这是真的,该文件的名称是从XML文档(doc)。如果是假的,没有书面文件到一个文件,但作进一步处理,然后返回序列。如果这是一个字符串,它的(第一)值用作要在其中写入修改后的文件的文件名。


参数:paths
these are the nodes of the elements in the SVG document which are to be given the tooltips.
这些都是在SVG文档中的元素,这些都是可以给工具提示的节点。


参数:elName
either "title" or "desc" for the short or longer tooltip.
无论是“标题”或“降序”短期或长期的工具提示。


参数:addArea
either a logical value or integer value of 0, 1, or 2. This indicates whether the function should attempt to make the entire area covered by each of the SVG elements active for the tooltip.  If this is NA, the package functions try to infer what to do.  If this is FALSE, only the actual pixels that are rendered, i.e. the path or stroke of the SVG element, will be active. If this is specified as TRUE, we try to make the entire area for the SVG element active by, e.g., adding an invisible enclosing rectangle &quot;under&quot; text or filling in a circle with the background color so as not to alter its appearance, but making it active.  If this is 2, we do the same operations as we do for FALSE,  but also enclose the SVG element within an <a> node which has an attribute xlink:title with the tooltip as its value.  This then allows the tooltip to appear in Safari and Chrome, i.e. WebKit-based browsers.  
无论是逻辑值或整数值0,1或2。这表明函数是否应该尝试让每个工具提示活跃的SVG元素覆盖整个区域。如果这是NA,包功能尝试推断做什么。如果这是FALSE,只有呈现的实际像素,即路径或中风的SVG元素,将积极。如果这是指定为TRUE,我们尽量使整个区域,积极为SVG元素,如加入“下”的文字或与背景颜色填充了一圈无形的封闭矩形以免改变它的外观,但它的积极。如果这是2,我们做的做相同的操作,因为我们FALSE,也括在<a>节点,其中有一个属性XLINK SVG元素:作为其工具提示的标题值。这就允许出现在工具提示,即Safari和Chrome基于WebKit的浏览器。


参数:style
a character string giving the name of the CSS class to use for any new SVG element that might be added to represent the event area, i.e. if a rectangle is added to &quot;enclose&quot; text or a phrase. This can be be either a class name or an inline CSS specification of the form &quot;name: value; name: value; ...&quot;. To remove any ambiguity about whether it is a class name or inine specfication     of CSS values, one can use I to indicate it is a collection of CSS values, e.g. style =       I("fill: red; stroke: orange;")  
给予为代表的活动区域,也就是说,如果一个矩形添加“括”的文字或短语可能被添加到任何新的SVG元素的CSS类的名称,使用一个字符串。这可以是一个类的名称或内联CSS规范的形式“的名字:值名称:值; ......”。为了消除任何含糊之处,它是否是一个类的名称或CSS值inine specfication,可以使用I表明它是一个CSS值的集合,例如style =       I("fill: red; stroke: orange;")


参数:addTitleAttribute
a logical value indicating whether to add a xlink:title attribute to the SVG element. The value of the attribute is the tooltip.  When this is TRUE, the tooltips for the resulting  SVG elements will appear in Firefox, i.e. Mozilla-based browsers.
一个逻辑值,该值指示是否添加xlink:title属性,SVG元素。该属性的值是工具提示。当这是TRUE,SVG元素的工具提示会出现在Firefox中,即基于Mozilla的浏览器。


参数:addCSS
a logical value indicating whether to add the default CSS file for controlling the appearance of tooltip rectangles. If this is NA, we determine whether this is needed.  The code should only add each unique CSS file to the document once regardless of how many times the caller specifies that it should be added.
一个逻辑值,该值指示是否添加默认的CSS文件控制的工具提示矩形的外观。如果这是NA,我们确定这是否是需要。代码应该只每一个独特的CSS文件添加一次,无论多少次来电指定它应该被添加到该文件。


参数:silent
a logical controlling whether addCSS emits a warning if there is a directive to load the  CSS file is already in the target document.   
逻辑控制是否addCSS发出警告,如果有一个指令加载CSS文件已经在目标文件中。


参数:...
additional parameters for methods
额外参数的方法


值----------Value----------

If save is FALSE, the updated XML document is returned. If save is TRUE or a string, the name of the file to which the document was written is returned.
save如果是FALSE,更新的XML文档返回。 save如果是TRUE或一个字符串,返回的文件,该文件是书面的名称。


注意----------Note----------

The interface to this function and its methods is likely to change and
接口功能和它的方法是有可能改变和


作者(S)----------Author(s)----------


Duncan Temple Lang



参见----------See Also----------

addAxesLinks
addAxesLinks


举例----------Examples----------



doc = svgPlot(plot(mpg ~ wt, mtcars))
addToolTips(getAxesLabelNodes(doc), c("Weight", "Miles per US Gallon"),
              addArea = TRUE)
addToolTips(doc, rownames(mtcars),  addArea = TRUE,
              style = "fill: white; stroke: red;")


doc = svgPlot(plot(mpg ~ wt, mtcars))
tips = apply(mtcars, 1,
               function(x)
                 paste(names(mtcars), x, sep = " = ", collapse = ", "))
addToolTips(doc, tips)

转载请注明:出自 生物统计家园网(http://www.biostatistic.net)。


注:
注1:为了方便大家学习,本文档为生物统计家园网机器人LoveR翻译而成,仅供个人R语言学习参考使用,生物统计家园保留版权。
注2:由于是机器人自动翻译,难免有不准确之处,使用时仔细对照中、英文内容进行反复理解,可以帮助R语言的学习。
注3:如遇到不准确之处,请在本贴的后面进行回帖,我们会逐渐进行修订。
回复

使用道具 举报

您需要登录后才可以回帖 登录 | 注册

本版积分规则

手机版|小黑屋|生物统计家园 网站价格

GMT+8, 2025-1-22 13:30 , Processed in 0.036663 second(s), 15 queries .

Powered by Discuz! X3.5

© 2001-2024 Discuz! Team.

快速回复 返回顶部 返回列表