Home
/
R Documentation
/
grid
/
grid.pack: Pack an Object within a Frame

grid.pack: Pack an Object within a Frame

grid.packR Documentation

Pack an Object within a Frame

Description

these functions, together with grid.frame and frameGrob are part of a GUI-builder-like interface to constructing graphical images. The idea is that you create a frame with grid.frame or frameGrob then use these functions to pack objects into the frame.

Usage

grid.pack(gPath, grob, redraw = TRUE, side = NULL,
          row = NULL, row.before = NULL, row.after = NULL,
          col = NULL, col.before = NULL, col.after = NULL,
          width = NULL, height = NULL,
          force.width = FALSE, force.height = FALSE, border = NULL,
          dynamic = FALSE)

packGrob(frame, grob, side = NULL,
          row = NULL, row.before = NULL, row.after = NULL,
          col = NULL, col.before = NULL, col.after = NULL,
          width = NULL, height = NULL,
          force.width = FALSE, force.height = FALSE, border = NULL,
          dynamic = FALSE)

Arguments

gPath

A gPath object, which specifies a frame on the display list.

frame

An object of class frame, typically the output from a call to grid.frame.

grob

An object of class grob. The object to be packed.

redraw

A boolean indicating whether the output should be updated.

side

One of "left", "top", "right", "bottom" to indicate which side to pack the object on.

row

Which row to add the object to. Must be between 1 and the-number-of-rows-currently-in-the-frame + 1, or NULL in which case the object occupies all rows.

row.before

Add the object to a new row just before this row.

row.after

Add the object to a new row just after this row.

col

Which col to add the object to. Must be between 1 and the-number-of-cols-currently-in-the-frame + 1, or NULL in which case the object occupies all cols.

col.before

Add the object to a new col just before this col.

col.after

Add the object to a new col just after this col.

width

Specifies the width of the column that the object is added to (rather than allowing the width to be taken from the object).

height

Specifies the height of the row that the object is added to (rather than allowing the height to be taken from the object).

force.width

A logical value indicating whether the width of the column that the grob is being packed into should be EITHER the width specified in the call to grid.pack OR the maximum of that width and the pre-existing width.

force.height

A logical value indicating whether the height of the column that the grob is being packed into should be EITHER the height specified in the call to grid.pack OR the maximum of that height and the pre-existing height.

border

A unit object of length 4 indicating the borders around the object.

dynamic

If the width/height is taken from the grob being packed, this boolean flag indicates whether the grobwidth/height unit refers directly to the grob, or uses a gPath to the grob. In the latter case, changes to the grob will trigger a recalculation of the width/height.

Details

packGrob modifies the given frame grob and returns the modified frame grob.

grid.pack destructively modifies a frame grob on the display list (and redraws the display list if redraw is TRUE).

These are (meant to be) very flexible functions. There are many different ways to specify where the new object is to be added relative to the objects already in the frame. The function checks that the specification is not self-contradictory.

NOTE that the width/height of the row/col that the object is added to is taken from the object itself unless the width/height is specified.

Value

packGrob returns a frame grob, but grid.pack returns NULL.

Author(s)

Paul Murrell

See Also

grid.frame, grid.place, grid.edit, and gPath.


grid

absolute.size: Absolute Size of a Grob arrow: Describe arrows to add to a line. calcStringMetric: Calculate Metric Information for Text current.viewport: Get the Current Grid Viewport (Tree) dataViewport: Create a Viewport with Scales based on Data depth: Determine the number of levels in an object. deviceLoc: Convert Viewport Location to Device Location drawDetails: Customising grid Drawing editDetails: Customising grid Editing editViewport: Modify a Viewport explode: Explode a path into its components. gEdit: Create and Apply Edit Objects getNames: List the names of grobs on the display list gpar: Handling Grid Graphical Parameters gPath: Concatenate Grob Names Grid: Grid Graphics grid.add: Add a Grid Graphical Object grid.bezier: Draw a Bezier Curve grid.cap: Capture a raster image grid.circle: Draw a Circle grid.clip: Set the Clipping Region grid.convert: Convert Between Different grid Coordinate Systems grid.copy: Make a Copy of a Grid Graphical Object grid.curve: Draw a Curve Between Locations grid-defunct: Defunct Functions in Package 'grid' grid.delay: Encapsulate calculations and generating a grob grid.display.list: Control the Grid Display List grid.DLapply: Modify the Grid Display List grid.draw: Draw a grid grob grid.edit: Edit the Description of a Grid Graphical Object grid.force: Force a grob into its components grid.frame: Create a Frame for Packing Objects grid.function: Draw a curve representing a function grid.get: Get a Grid Graphical Object grid.grab: Grab the current grid output grid.grep: Search for grobs grid.grill: Draw a Grill grid.grob: Create Grid Graphical Objects, aka "Grob"s grid-internal: Internal Grid Functions grid.layout: Create a Grid Layout grid.lines: Draw Lines in a Grid Viewport grid.locator: Capture a Mouse Click grid.ls: List the names of grobs or viewports grid.move.to: Move or Draw to a Specified Position grid.newpage: Move to a New Page on a Grid Device grid.null: Null Graphical Object grid.pack: Pack an Object within a Frame grid-package: The Grid Graphics Package grid.path: Draw a Path grid.place: Place an Object within a Frame grid.plot.and.legend: A Simple Plot and Legend Demo grid.points: Draw Data Symbols grid.polygon: Draw a Polygon grid.pretty: Generate a Sensible Set of Breakpoints grid.raster: Render a raster object grid.record: Encapsulate calculations and drawing grid.rect: Draw rectangles grid.refresh: Refresh the current grid scene grid.remove: Remove a Grid Graphical Object grid.reorder: Reorder the children of a gTree grid.roundrect: Draw a rectangle with rounded corners grid.segments: Draw Line Segments grid.set: Set a Grid Graphical Object grid.show.layout: Draw a Diagram of a Grid Layout grid.show.viewport: Draw a Diagram of a Grid Viewport grid.text: Draw Text grid.xaxis: Draw an X-Axis grid.xspline: Draw an Xspline grid.yaxis: Draw a Y-Axis grobCoords: Calculate Points on the Perimeter of a Grob grobName: Generate a Name for a Grob grobWidth: Create a Unit Describing the Width of a Grob grobX: Create a Unit Describing a Grob Boundary Location legendGrob: Constructing a Legend Grob makeContent: Customised grid Grobs patterns: Define Gradient and Pattern Fills plotViewport: Create a Viewport with a Standard Plot Layout resolveRasterSize: Utility function to resolve the size of a raster grob showGrob: Label grid grobs. showViewport: Display grid viewports. stringWidth: Create a Unit Describing the Width and Height of a String or... unit: Function to Create a Unit Object unit.c: Combine Unit Objects unit.length: Length of a Unit Object unit.pmin: Parallel Unit Minima and Maxima unit.rep: Replicate Elements of Unit Objects unitType: Return the Units of a Unit Object validDetails: Customising grid grob Validation valid.just: Validate a Justification viewport: Create a Grid Viewport viewports: Maintaining and Navigating the Grid Viewport Tree vpPath: Concatenate Viewport Names widthDetails: Width and Height of a grid grob xDetails: Boundary of a grid grob xsplinePoints: Return the points that would be used to draw an Xspline (or a...

R Package Documentation

rdrr.io home R language documentation Run R code online

Browse R Packages

CRAN packages Bioconductor packages R-Forge packages GitHub packages

We want your feedback!

Note that we can't provide technical support on individual packages. You should contact the package authors for that.
GitHub issue tracker
ian@mutexlabs.com
Personal blog

 
Embedding an R snippet on your website

Add the following code to your website.

For more information on customizing the embed code, read Embedding Snippets.

Close