height.figure: Get or set set figure object dimensions.

In PiotrTymoszuk/figur: Smart Handling of Figures, Tables and Code in RMarkdown Documents

Get or set set figure object dimensions.

Description

Get or set dimensions of a 'figure' class object.

Usage

height(x) <- value

width(x) <- value

height(x, ...)

width(x, ...)

resize(x, ...)

## S3 method for class 'figure'
height(x, ...)

## S3 method for class 'figure'
width(x, ...)

height(x) <- value

width(x) <- value

## S3 method for class 'figure'
resize(x, value, what = c("w", "h", "scale"), unit = x$unit, lock = TRUE, ...)

Arguments

x	a figure class object.
value	new height or width or a scaling factor.
...	extra arguments passed to methods.
what	The requested dimension to be changed or the scaling factor.
unit	The dimension unit of the final plot object.
lock	logical, if TRUE, the aspect ratio is kept constant (scaling).

Details

'height()', 'width()' and 'resize()' are S3 generic functions.

Value

A 'figure' object with the height or width property modified or the requested dimensions.

PiotrTymoszuk/figur documentation built on July 16, 2024, 1:15 a.m.