plot_layout_properties: Slide layout properties plot

In officer: Manipulation of Microsoft Word and PowerPoint Documents

Slide layout properties plot

Description

Plot slide layout properties into corresponding placeholders. This can be useful to help visualize placeholders locations and identifiers. All information in the plot stems from the layout_properties() output. See Details section for more info.

Usage

plot_layout_properties(
  x,
  layout = NULL,
  master = NULL,
  labels = TRUE,
  title = TRUE,
  type = TRUE,
  id = TRUE,
  cex = NULL,
  legend = FALSE
)

Arguments

x	an rpptx object
layout	slide layout name or numeric index (row index from [layout_summary()).
master	master layout name where layout is located. Can be omitted if layout is unambiguous.
labels	if TRUE (default), adds placeholder labels (centered in red).
title	if TRUE (default), adds a title with the layout name at the top.
type	if TRUE (default), adds the placeholder type and its index (in square brackets) in the upper left corner (in blue).
id	if TRUE (default), adds the placeholder's unique id (see column id from layout_properties()) in the upper right corner (in green).
cex	named list or vector to specify font size for labels, type, and id. Default is c(labels = .5, type = .5, id = .5). See graphics::text() for details on how cex works.
legend	Add a legend to the plot (default FALSE).

Details

The plot contains all relevant information to reference a placeholder via the ⁠ph_location_*⁠ function family:

• label: ph label (red, center) to be used in ph_location_label(). NB: The label can be assigned by the user in PowerPoint.

• type[idx]: ph type + type index in brackets (blue, upper left) to be used in ph_location_type(). NB: The index is consecutive and is sorted by ph position (top -> bottom, left -> right).

• id: ph id (green, upper right) to be used in ph_location_id() (forthcoming). NB: The id is set by PowerPoint automatically and lack a meaningful order.

See Also

Other functions for reading presentation information: annotate_base(), color_scheme(), doc_properties(), layout_properties(), layout_summary(), length.rpptx(), slide_size(), slide_summary()

Examples

x <- read_pptx()

# select layout explicitly
plot_layout_properties(x = x, layout = "Title Slide", master = "Office Theme")
plot_layout_properties(x = x, layout = "Title Slide") # no master needed if layout name unique
plot_layout_properties(x = x, layout = 1) # use layout index instead of name

# plot current slide's layout (default if no layout is passed)
x <- read_pptx()
x <- add_slide(x, "Title Slide")
plot_layout_properties(x)

# change appearance: what to show, font size, legend etc.
plot_layout_properties(x, layout = "Two Content", title = FALSE, type = FALSE, id = FALSE)
plot_layout_properties(x, layout = 4, cex = c(labels = .8, id = .7, type = .7))
plot_layout_properties(x, 1, legend = TRUE)

officer documentation built on Oct. 10, 2024, 1:06 a.m.