R语言:grid.ls()函数中文帮助文档(中英文对照)

loveR

grid.ls(grid)
grid.ls()所属R语言包：grid

                                         List the names of grobs or viewports
                                         列出的grobs或视口的名称

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

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

Returns a listing of the names of grobs or viewports.
返回一个的grobs或视口的名称上市。

This is a generic function with methods for grobs (including gTrees) and viewports (including vpTrees).
这是一个通用方法grobs（包括gTrees）和视口（包括vpTrees）功能。


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


grid.ls(x=NULL, grobs=TRUE, viewports=FALSE, fullNames=FALSE,
        recursive=TRUE, print=TRUE, flatten=TRUE, ...)

nestedListing(x, gindent="  ", vpindent=gindent)
pathListing(x, gvpSep=" | ", gAlign=TRUE)
grobPathListing(x, ...)



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

参数：x
A grob or viewport or NULL.  If NULL, the current grid display list is listed.  For print functions, this should be the result of a call to grid.ls.
一个GROB或视或NULL。如果NULL，当前网格显示列表中列出。对于打印功能，这应该是调用grid.ls一个结果。


参数：grobs
A logical value indicating whether to list grobs.
说明是否列出grobs的逻辑值。


参数：viewports
A logical value indicating whether to list viewports.
一个逻辑值，指示是否列出视口。


参数：fullNames
A logical value indicating whether to embellish object names with information about the object type.
一个逻辑值，指明是否美化对象名称，对象类型的信息。


参数：recursive
A logical value indicating whether recursive structures should also list their children.
一个逻辑值，表明递归结构是否还应该列出他们的孩子。


参数：print
A logical indicating whether to print the listing or a function that will print the listing.
一个逻辑指示是否打印上市或一个函数，将打印上市。


参数：flatten
A logical value indicating whether to flatten the listing.  Otherwise a more complex hierarchical object is produced.
一个逻辑值，指示是否压扁上市。否则产生一个更复杂的层次对象。


参数：gindent
The indent used to show nesting in the output for grobs.
缩进用来显示在输出grobs筑巢。


参数：vpindent
The indent used to show nesting in the output for viewports.
缩进用于显示在视口输出筑巢。


参数：gvpSep
The string used to separate viewport paths from grob paths.
字符串中使用分离从格罗路径视口的路径。


参数：gAlign
Logical indicating whether to align the left hand edge of all grob paths.
逻辑表明是否所有GROB路径的左手边缘对齐。


参数：...
Arguments passed to the print function.
print函数参数传递。


Details

详情----------Details----------

If the argument x is NULL, the current contents of the grid display list are listed (both viewports and grobs). In other words, all objects representing the current scene are listed.
如果参数x是NULL，网格显示列表中的当前内容列出（视口和grobs）。换句话说，列出所有代表当前场景中的对象。

Otherwise, x should be a grob or a viewport.
否则，x应该是GROB或视口中。

The default behaviour of this function is to print information about the grobs in the current scene.  It is also possible to add information about the viewports in the scene.  By default, the listing is recursive, so all children of gTrees and all nested viewports are reported.
这个函数的默认行为是打印在当前场景的grobs信息。它也可以添加在现场视口中的信息。默认情况下，上市是递归的，所以所有的孩子都报的gTrees和所有嵌套的视口。

The format of the information can be controlled via the print argument, which can be given a function to perform the formatting. The nestedListing function produces a line per grob or viewport, with indenting used to show nesting.  The pathListing function produces a line per grob or viewport, with viewport paths and grob paths used to show nesting.  The grobPathListing is a simple derivation that only shows lines for grobs.  The user can define new functions.
通过print的说法，这可以给出一个函数来执行的格式，可以控制信息的格式。 nestedListing函数产生GROB或视每行，缩进用于显示嵌套。 pathListing函数产生一个每GROB或视线，与视口路径和用来显示嵌套GROB路径。 grobPathListing是一个简单的推导，只显示为grobs行。用户可以定义新的功能。


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

The result of this function is either a "gridFlatListing" object (if flatten is TRUE) or a "gridListing" object.
这个函数的结果要么是一个"gridFlatListing"对象（flatten如果是TRUE）"gridListing"对象的。

The former is a simple (flat) list of vectors.  This is convenient, for example, for working programmatically with the list of grob and viewport names, or for writing a new display function for the listing.
前者是一个简单的向量列表（平面）。这是很方便的，例如，编程工作GROB和视口的名称列表，或写一个新上市的显示功能。

The latter is a more complex hierarchical object (list of lists), but it does contain more detailed information so may be of use for more advanced customisations.
后者是一个更复杂的层次结构对象（列表），但它确实包含更详细的信息，因此可能会使用更先进的定制。


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


Paul Murrell



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

grob viewport
grobviewport


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


# A gTree, called "parent", with childrenvp vpTree (vp2 within vp1)[一个gTree，被称为“父”与，（childrenvp vpTree：内VP1 VP2）]
# and child grob, called "child", with vp vpPath (down to vp2)[GROB和孩子，被称为“孩子”与VP vpPath，（下降到VP2）]
sampleGTree <- gTree(name="parent",
                     children=gList(grob(name="child", vp="vp1::vp2")),
                     childrenvp=vpTree(parent=viewport(name="vp1"),
                                       children=vpList(viewport(name="vp2"))))
grid.ls(sampleGTree)
# Show viewports too[显示视口太]
grid.ls(sampleGTree, view=TRUE)
# Only show viewports[只显示视口]
grid.ls(sampleGTree, view=TRUE, grob=FALSE)
# Alternate displays[备用显示器]
# nested listing, custom indent[嵌套列表，自定义缩进]
grid.ls(sampleGTree, view=TRUE, print=nestedListing, gindent="--")
# path listing[路径上市]
grid.ls(sampleGTree, view=TRUE, print=pathListing)
# path listing, without grobs aligned[路径上市，没有对齐grobs]
grid.ls(sampleGTree, view=TRUE, print=pathListing, gAlign=FALSE)
# grob path listing [GROB路径上市]
grid.ls(sampleGTree, view=TRUE, print=grobPathListing)
# path listing, grobs only[路径上市，仅grobs]
grid.ls(sampleGTree, print=pathListing)
# path listing, viewports only[路径上市，视口]
grid.ls(sampleGTree, view=TRUE, grob=FALSE, print=pathListing)
# raw flat listing[原平房源]
str(grid.ls(sampleGTree, view=TRUE, print=FALSE))

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


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