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