R grid.ls 列出 grobs 或视口的名称

说明

返回 grobs 或视口名称的列表。

这是一个通用函数，具有用于 grobs(包括 gTree)和视口(包括 vpTree)的方法。

用法

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, ...)

参数

x	一个 grob 或视口或 NULL 。如果是 NULL ，则列出当前网格显示列表。 对于打印函数，这应该是调用 grid.ls 的结果。
grobs	指示是否列出 grobs 的逻辑值。
viewports	指示是否列出视口的逻辑值。
fullNames	一个逻辑值，指示是否用有关对象类型的信息修饰对象名称。
recursive	一个逻辑值，指示递归结构是否也应列出其子结构。
print	指示是否打印列表的逻辑或将打印列表的函数。
flatten	指示是否展平列表的逻辑值。否则会产生更复杂的层次对象。
gindent	缩进用于显示 grobs 输出中的嵌套。
vpindent	用于显示视口输出中的嵌套的缩进。
gvpSep	用于将视口路径与 grob 路径分开的字符串。
gAlign	逻辑指示是否对齐所有 grob 路径的左边。
...	传递给 print 函数的参数。

细节

如果参数 x 是 NULL ，则列出网格显示列表的当前内容(视口和 grobs)。换句话说，列出了代表当前场景的所有对象。

否则，x 应该是一个 grob 或一个视口。

此函数的默认行为是打印有关当前场景中的 grobs 的信息。还可以添加有关场景中视口的信息。默认情况下，列表是递归的，因此会报告 gTree 的所有子级和所有嵌套视口。

信息的格式可以通过 print 参数来控制，可以给它一个函数来执行格式化。 nestedListing 函数为每个 grob 或视口生成一行，并使用缩进来显示嵌套。 pathListing 函数为每个 grob 或视口生成一行，并使用视口路径和 grob 路径来显示嵌套。 grobPathListing 是一个简单的推导，仅显示 grobs 的行。用户可以定义新的函数。

值

此函数的结果是 "gridFlatListing" 对象(如果 flatten 是 TRUE )或 "gridListing" 对象。

前者是一个简单(平面)向量列表。例如，这对于以编程方式处理 grob 和视口名称列表或为列表编写新的显示函数来说很方便。

后者是一个更复杂的层次对象(列表的列表)，但它确实包含更详细的信息，因此可能用于更高级的自定义。

例子

# A gTree, called "parent", with childrenvp vpTree (vp2 within vp1)
# and child grob, called "child", with vp vpPath (down to 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, viewports=TRUE)
# Only show viewports
grid.ls(sampleGTree, viewports=TRUE, grobs=FALSE)
# Alternate displays
# nested listing, custom indent
grid.ls(sampleGTree, viewports=TRUE, print=nestedListing, gindent="--")
# path listing
grid.ls(sampleGTree, viewports=TRUE, print=pathListing)
# path listing, without grobs aligned
grid.ls(sampleGTree, viewports=TRUE, print=pathListing, gAlign=FALSE)
# grob path listing
grid.ls(sampleGTree, viewports=TRUE, print=grobPathListing)
# path listing, grobs only
grid.ls(sampleGTree, print=pathListing)
# path listing, viewports only
grid.ls(sampleGTree, viewports=TRUE, grobs=FALSE, print=pathListing)
# raw flat listing
str(grid.ls(sampleGTree, viewports=TRUE, print=FALSE))

作者

Paul Murrell

也可以看看

grob viewport