visVp {supraHex} | R Documentation

## Function to create viewports for multiple supra-hexagonal grids

### Description

`visVp` is supposed to create viewports, which describe rectangular regions on a graphics device and define a number of coordinate systems for each of supra-hexagonal grids.

### Usage

    visVp(
    height = 7,
    xdim = 1,
    ydim = 1,
    colNum = 1,
    rowNum = 1,
    gp = grid::gpar(),
    newpage = TRUE
    )

### Arguments

`height` | a numeric value specifying the height of device
`xdim` | an integer specifying x-dimension of the grid
`ydim` | an integer specifying y-dimension of the grid
`colNum` | an integer specifying the number of columns
`rowNum` | an integer specifying the number of rows
`gp` | an object of class gpar, typically the output from a call to the function gpar (i.e., a list of graphical parameter settings)
`newpage` | logical to indicate whether to open a new page. By default, it sets to true for opening a new page

### Value

`vpnames` | an R object of "viewport" class

### Note

none

### See Also

`visHexMulComp`, `visCompReorder`

### Examples

    # 1) create 5x5 viewports
    vpnames <- visVp(colNum=5, rowNum=5)

    # 2) look at names of these viewports
    vpnames

[Package supraHex version 1.26.0 Index]