grid.annotation {RGrace}R Documentation

Multilined text

Description

This is a functions that draws multilined text in grid's viewport. Beside plain text this function also handles mathematical expression and simple graphical objects.

Usage

grid.annotation(x=vp$xscale[[1]],y=vp$yscale[[2]],label="",
just=c("left","bottom"),rot=0,frame=FALSE,gp=gpar(lwd=2),
check.overlap=TRUE,vp=viewport(),draw=TRUE)

Arguments

x,y Numeric vectors - coordinates of annotation's upper left corner.
label Either a character string or a list whose elements are character strings (for plain text strings) or expressions (for mathematical expressions, see plotmath). Each element is a single line ( mixing plain text and mathematics inside one line is not possible, use expression() in this case). It is also possible to draw simple grid graphic inside annotation, in that case list element have to be a function of class extplotmath which is evaluated when annotation is to be redrawn and inside this function actual drawing is done (see for example BULLET)
rot Angle in degrees between text base line and a horizontal line.
frame Logical value. If TRUE a frame around annotation is draw.
gp,draw,vp Standard parameters of grid objects (although with different default values). See gpar, viewport.
just Alignment of annotation text.
check.overlap Check overlapping of annotation with figure edges. If check.overlap=TRUE and annotation indeed overlaps with figure margins then annotation is not shown.

Value

Grob (GRaphic OBject, see grid.grob) of class "grid.annotation".

Author(s)

M.Kondrin

See Also

gpar, viewport, grid.text.


[Package RGrace version 0.6-6 Index]