textBoundingBox.Display: Determine the size of the text bounding box

Description Usage Arguments Value Note Author(s) See Also Examples

Description

Determine the size of the text bounding box taking into account the text angle (srt).

Usage

1
2
3
4
5
6
## Static method (use this):
## Display$textBoundingBox(stext, units="user", cex=1, srt=0, get.biggest=TRUE, ...)

## Don't use the below:
## S3 method for class 'Display'
textBoundingBox(static, stext, units="user", cex=1, srt=0, get.biggest=TRUE, ...)

Arguments

stext

The text which width and height to be determined.

units

If 'user' (default) the aspect ratio is calculated based on 'usr' and 'pin'. graphics parameters or kept equal to 1 otherwise.

cex

Text font size. Default is 1.

srt

Text angle.Default is 0.

get.biggest

If TRUE (default), returns the biggest bounding box in case stest contains multiple strings.

...

Not used

Value

The data.frame with two columns containing the width and height of the bounding box(es).

Note

The function should be called only on already created graphical device, otherwise an error will be thrown.

Author(s)

Alex Lisovich, Roger Day

See Also

For more information see Display.

Examples

1
2
3
4
## Not run: 
 bounding.box<-Display$textBoundingBox("text",cex=2,srt=30);
 
## End(Not run)

IdMappingAnalysis documentation built on Nov. 17, 2017, 11:12 a.m.