Wrapper for ggplot2::theme() that passes as_asp() with flip = TRUE
to the
aspect.ratio argument to force a plot to match the aspect ratio of the
provided page.
Arguments
- page
If character, page is passed as the name parameter to
get_page_size()
.- orientation
Page orientation, Default:
NULL
. Supported options are "portrait", "landscape", or "square".- ...
Arguments passed on to
ggplot2::theme
line
all line elements (
element_line()
)rect
all rectangular elements (
element_rect()
)text
all text elements (
element_text()
)title
all title elements: plot, axes, legends (
element_text()
; inherits fromtext
)aspect.ratio
aspect ratio of the panel
axis.title,axis.title.x,axis.title.y,axis.title.x.top,axis.title.x.bottom,axis.title.y.left,axis.title.y.right
labels of axes (
element_text()
). Specify all axes' labels (axis.title
), labels by plane (usingaxis.title.x
oraxis.title.y
), or individually for each axis (usingaxis.title.x.bottom
,axis.title.x.top
,axis.title.y.left
,axis.title.y.right
).axis.title.*.*
inherits fromaxis.title.*
which inherits fromaxis.title
, which in turn inherits fromtext
axis.text,axis.text.x,axis.text.y,axis.text.x.top,axis.text.x.bottom,axis.text.y.left,axis.text.y.right,axis.text.theta,axis.text.r
tick labels along axes (
element_text()
). Specify all axis tick labels (axis.text
), tick labels by plane (usingaxis.text.x
oraxis.text.y
), or individually for each axis (usingaxis.text.x.bottom
,axis.text.x.top
,axis.text.y.left
,axis.text.y.right
).axis.text.*.*
inherits fromaxis.text.*
which inherits fromaxis.text
, which in turn inherits fromtext
axis.ticks,axis.ticks.x,axis.ticks.x.top,axis.ticks.x.bottom,axis.ticks.y,axis.ticks.y.left,axis.ticks.y.right,axis.ticks.theta,axis.ticks.r
tick marks along axes (
element_line()
). Specify all tick marks (axis.ticks
), ticks by plane (usingaxis.ticks.x
oraxis.ticks.y
), or individually for each axis (usingaxis.ticks.x.bottom
,axis.ticks.x.top
,axis.ticks.y.left
,axis.ticks.y.right
).axis.ticks.*.*
inherits fromaxis.ticks.*
which inherits fromaxis.ticks
, which in turn inherits fromline
axis.minor.ticks.x.top,axis.minor.ticks.x.bottom,axis.minor.ticks.y.left,axis.minor.ticks.y.right,axis.minor.ticks.theta,axis.minor.ticks.r
minor tick marks along axes (
element_line()
).axis.minor.ticks.*.*
inherit from the corresponding major ticksaxis.ticks.*.*
.axis.ticks.length,axis.ticks.length.x,axis.ticks.length.x.top,axis.ticks.length.x.bottom,axis.ticks.length.y,axis.ticks.length.y.left,axis.ticks.length.y.right,axis.ticks.length.theta,axis.ticks.length.r
length of tick marks (
unit
)axis.minor.ticks.length,axis.minor.ticks.length.x,axis.minor.ticks.length.x.top,axis.minor.ticks.length.x.bottom,axis.minor.ticks.length.y,axis.minor.ticks.length.y.left,axis.minor.ticks.length.y.right,axis.minor.ticks.length.theta,axis.minor.ticks.length.r
length of minor tick marks (
unit
), or relative toaxis.ticks.length
when provided withrel()
.axis.line,axis.line.x,axis.line.x.top,axis.line.x.bottom,axis.line.y,axis.line.y.left,axis.line.y.right,axis.line.theta,axis.line.r
lines along axes (
element_line()
). Specify lines along all axes (axis.line
), lines for each plane (usingaxis.line.x
oraxis.line.y
), or individually for each axis (usingaxis.line.x.bottom
,axis.line.x.top
,axis.line.y.left
,axis.line.y.right
).axis.line.*.*
inherits fromaxis.line.*
which inherits fromaxis.line
, which in turn inherits fromline
legend.background
background of legend (
element_rect()
; inherits fromrect
)legend.margin
the margin around each legend (
margin()
)legend.spacing,legend.spacing.x,legend.spacing.y
the spacing between legends (
unit
).legend.spacing.x
&legend.spacing.y
inherit fromlegend.spacing
or can be specified separatelylegend.key
background underneath legend keys (
element_rect()
; inherits fromrect
)legend.key.size,legend.key.height,legend.key.width
size of legend keys (
unit
); key background height & width inherit fromlegend.key.size
or can be specified separatelylegend.key.spacing,legend.key.spacing.x,legend.key.spacing.y
spacing between legend keys given as a
unit
. Spacing in the horizontal (x) and vertical (y) direction inherit fromlegend.key.spacing
or can be specified separately.legend.frame
frame drawn around the bar (
element_rect()
).legend.ticks
tick marks shown along bars or axes (
element_line()
)legend.ticks.length
length of tick marks in legend (
unit
)legend.axis.line
lines along axes in legends (
element_line()
)legend.text
legend item labels (
element_text()
; inherits fromtext
)legend.text.position
placement of legend text relative to legend keys or bars ("top", "right", "bottom" or "left"). The legend text placement might be incompatible with the legend's direction for some guides.
legend.title
title of legend (
element_text()
; inherits fromtitle
)legend.title.position
placement of legend title relative to the main legend ("top", "right", "bottom" or "left").
legend.position
the default position of legends ("none", "left", "right", "bottom", "top", "inside")
legend.position.inside
A numeric vector of length two setting the placement of legends that have the
"inside"
position.legend.direction
layout of items in legends ("horizontal" or "vertical")
legend.byrow
whether the legend-matrix is filled by columns (
FALSE
, the default) or by rows (TRUE
).legend.justification
anchor point for positioning legend inside plot ("center" or two-element numeric vector) or the justification according to the plot area when positioned outside the plot
legend.justification.top,legend.justification.bottom,legend.justification.left,legend.justification.right,legend.justification.inside
Same as
legend.justification
but specified perlegend.position
option.legend.location
Relative placement of legends outside the plot as a string. Can be
"panel"
(default) to align legends to the panels or"plot"
to align legends to the plot as a whole.legend.box
arrangement of multiple legends ("horizontal" or "vertical")
legend.box.just
justification of each legend within the overall bounding box, when there are multiple legends ("top", "bottom", "left", or "right")
legend.box.margin
margins around the full legend area, as specified using
margin()
legend.box.background
background of legend area (
element_rect()
; inherits fromrect
)legend.box.spacing
The spacing between the plotting area and the legend box (
unit
)panel.background
background of plotting area, drawn underneath plot (
element_rect()
; inherits fromrect
)panel.border
border around plotting area, drawn on top of plot so that it covers tick marks and grid lines. This should be used with
fill = NA
(element_rect()
; inherits fromrect
)panel.spacing,panel.spacing.x,panel.spacing.y
spacing between facet panels (
unit
).panel.spacing.x
&panel.spacing.y
inherit frompanel.spacing
or can be specified separately.panel.grid,panel.grid.major,panel.grid.minor,panel.grid.major.x,panel.grid.major.y,panel.grid.minor.x,panel.grid.minor.y
grid lines (
element_line()
). Specify major grid lines, or minor grid lines separately (usingpanel.grid.major
orpanel.grid.minor
) or individually for each axis (usingpanel.grid.major.x
,panel.grid.minor.x
,panel.grid.major.y
,panel.grid.minor.y
). Y axis grid lines are horizontal and x axis grid lines are vertical.panel.grid.*.*
inherits frompanel.grid.*
which inherits frompanel.grid
, which in turn inherits fromline
panel.ontop
option to place the panel (background, gridlines) over the data layers (
logical
). Usually used with a transparent or blankpanel.background
.plot.background
background of the entire plot (
element_rect()
; inherits fromrect
)plot.title
plot title (text appearance) (
element_text()
; inherits fromtitle
) left-aligned by defaultplot.title.position,plot.caption.position
Alignment of the plot title/subtitle and caption. The setting for
plot.title.position
applies to both the title and the subtitle. A value of "panel" (the default) means that titles and/or caption are aligned to the plot panels. A value of "plot" means that titles and/or caption are aligned to the entire plot (minus any space for margins and plot tag).plot.subtitle
plot subtitle (text appearance) (
element_text()
; inherits fromtitle
) left-aligned by defaultplot.caption
caption below the plot (text appearance) (
element_text()
; inherits fromtitle
) right-aligned by defaultplot.tag
upper-left label to identify a plot (text appearance) (
element_text()
; inherits fromtitle
) left-aligned by defaultplot.tag.position
The position of the tag as a string ("topleft", "top", "topright", "left", "right", "bottomleft", "bottom", "bottomright") or a coordinate. If a coordinate, can be a numeric vector of length 2 to set the x,y-coordinate relative to the whole plot. The coordinate option is unavailable for
plot.tag.location = "margin"
.plot.tag.location
The placement of the tag as a string, one of
"panel"
,"plot"
or"margin"
. Respectively, these will place the tag inside the panel space, anywhere in the plot as a whole, or in the margin around the panel space.plot.margin
margin around entire plot (
unit
with the sizes of the top, right, bottom, and left margins)strip.background,strip.background.x,strip.background.y
background of facet labels (
element_rect()
; inherits fromrect
). Horizontal facet background (strip.background.x
) & vertical facet background (strip.background.y
) inherit fromstrip.background
or can be specified separatelystrip.clip
should strip background edges and strip labels be clipped to the extend of the strip background? Options are
"on"
to clip,"off"
to disable clipping or"inherit"
(default) to take the clipping setting from the parent viewport.strip.placement
placement of strip with respect to axes, either "inside" or "outside". Only important when axes and strips are on the same side of the plot.
strip.text,strip.text.x,strip.text.y,strip.text.x.top,strip.text.x.bottom,strip.text.y.left,strip.text.y.right
facet labels (
element_text()
; inherits fromtext
). Horizontal facet labels (strip.text.x
) & vertical facet labels (strip.text.y
) inherit fromstrip.text
or can be specified separately. Facet strips have dedicated position-dependent theme elements (strip.text.x.top
,strip.text.x.bottom
,strip.text.y.left
,strip.text.y.right
) that inherit fromstrip.text.x
andstrip.text.y
, respectively. As a consequence, some theme stylings need to be applied to the position-dependent elements rather than to the parent elementsstrip.switch.pad.grid
space between strips and axes when strips are switched (
unit
)strip.switch.pad.wrap
space between strips and axes when strips are switched (
unit
)complete
set this to
TRUE
if this is a complete theme, such as the one returned bytheme_grey()
. Complete themes behave differently when added to a ggplot object. Also, when settingcomplete = TRUE
all elements will be set to inherit from blank elements.validate
TRUE
to runvalidate_element()
,FALSE
to bypass checks.
Value
A ggplot theme
class object with the aspect.ratio argument set to
match the page height / width.