How to size embedded figures in landscape

[KipBalkcom-USDA]

Description

I don't know the correct options for how to size a figure embedded from another quarto document into a second quarto document to fill the page in landscape. I can resize the figure each time it is rendered, but I would like to know the code based approach to accomplish this task. I see different options in the documentation, but it is not clear to me when the figure is embedded.

There are two quarto documents below. The first contains code to create the example figure. The second is the document that renders the embedded figure.

---
notebook-links: false
title: "Figures"
format: html
execute: 
  echo: false
  message: false
  warning: false
  freeze: auto
---

```{r}
#| label: plot-pkgs

library(tidyverse)
library(patchwork)

```

```{r}
#| label: fig-starwars
#| fig-width: 10
#| fig-asp: 0.722
#| fig-dpi: 300
#| fig-cap: " A long caption that will go across the entire page in landscape mode for an unfiltered Star Wars height and mass plot and two filtered Star Wars height and mass plots."

plot1 <- starwars |> 
  ggplot(aes(height, mass)) + 
  geom_point()

plot2 <- starwars |> 
  filter(height > 100) |> 
  ggplot(aes(height, mass)) + 
  geom_point()

plot3 <- starwars |> 
  filter(height > 200) |> 
  ggplot(aes(height, mass)) + 
  geom_point()

plot_summary <- (plot1 + plot2 + plot3) 

plot_summary

```

---
number-sections: true
format: docx
keep-tex: false
execute: 
  echo: false
  message: false
  warning: false
  freeze: auto
page-width: 6.5
tbl-colwidths: auto
always_allow_html: true
---

Here is a plot of some Star Wars data ([Fig. @fig-starwars]).

::: landscape

# note `_figs.qmd` was my original file name with the figure code. 

{{< embed _figs.qmd#fig-starwars >}} 

:::

[mcanouil]

The figure dimension is defined by the document from which the figure comes from.

[KipBalkcom-USDA]

o.k., how do I adjust the dimensions correctly? For example, if you have an 8.5" wide by 11" long piece of paper with 1" margins around the page in landscape the width of the figure to fill the page would be 9". Currently, my figure is very skinny with respect to the width of the page which requires me to manually adjust the figure after rendering to fit the page. It does not seem to matter how I adjust the fig-width or fig-asp parameters.

[mcanouil]

I don't understand, set the dimension you want in the document that generates the figure using fig-height and fig-width.

See below a small reproducible example.
Note that tidyverse is not a small package to install and nearly all the options you've set are unrelated to the issue or if they do are unrelated it's hidden amongst all the unused ones.

---
format: html
---

{{< embed demo.qmd#fig-base-plot >}}

If I want fig-base-plot to be a square:

---
format: html
engine: knitr
---

```{r}
#| label: fig-base-plot
#| fig-width: 6
#| fig-height: 6
plot(seq_len(5), c(1, 4, 9, 16, 25))
```

In case it's not clear, the size is the physical/real size in inches.

[KipBalkcom-USDA]

Ok, perhaps this is a problem with the docx format. I agree with the previous solution you provided when the figure is presented in portrait mode, but when I render my document that contains the embedded figure using the landscape notation, the figure must be manually resized to fill the landscape page in a word document.

Note that I changed the dimensions of fig-width and fig-height below in your example to what I would expect the dimensions of the figure to be when printed on a landscape page. However, changing those values do not seem to affect the plot dimensions in landscape mode.

---
format: docx
---
::: landscape

{{< embed demo.qmd#fig-base-plot >}}

:::

---
format: html
engine: knitr
---

```{r}
#| label: fig-base-plot
#| fig-width: 9
#| fig-height: 5
plot(seq_len(5), c(1, 4, 9, 16, 25))
```

[mcanouil]

You would need to inspect the OpenXML code from your document to understand what is happening.
Word is using a lot of rules that it applies to content.

---
format:
  typst:
    keep-typ: true
  docx: default
---

## Landscape

::: {.landscape}

{{< embed demo.qmd#fig-base-plot >}}

:::

## Portrait

{{< embed demo.qmd#fig-base-plot >}}

Note that the figure has the proper physical size for me.

Note that for raster images, the DPI matters.

[KipBalkcom-USDA]

In the above example, how would you align the figure with Figure 1 (left margin) in the landscape orientation then allow the figure to expand across the page to the right margin? This would allow the figure to fill the entire width of the page in landscape mode.

[mcanouil]

It actually not even works without the embed shortcode.
Note that the two figures generated are properly sized and the intermediate markdown file is correct.
So, the issue is when rendering to Word.

---
format: docx
execute:
  echo: false
---

## Landscape

::: {.landscape}

```{r}
#| label: fig-base-plot
#| fig-width: 11.69
#| fig-height: 8.27
plot(seq_len(5), c(1, 4, 9, 16, 25))
```

:::

## Portrait

```{r}
#| ref-label: fig-base-plot
#| fig-width: 8.27
#| fig-height: 5.85
```

Note that it works just fine for Typst and LaTeX.

[mcanouil]

The issue appears in plain Pandoc:

---
format: docx
keep-md: true
execute:
  echo: false
---

## Landscape

```{=openxml}
<w:p><w:pPr><w:sectPr></w:sectPr></w:pPr></w:p>
```

```{r}
#| label: fig-base-plot
#| fig-width: 11.69
#| fig-height: 8.27
plot(seq_len(5), c(1, 4, 9, 16, 25))
```

```{=openxml}
<w:p>
  <w:pPr>
    <w:sectPr>
      <w:pgSz w:h="11906" w:w="16838" w:orient="landscape" />
    </w:sectPr>
  </w:pPr>
</w:p>
```

## Portrait

```{r}
#| ref-label: fig-base-plot
#| fig-width: 8.27
#| fig-height: 5.85
```

quarto render index.qmd
quarto pandoc --to docx index.docx.md -o pandoc.docx

[mcanouil]

Even when setting explicitly the output width, Pandoc seems to resize to the maximum width of the reference document in portrait mode.

---
format: docx
keep-md: true
execute:
  echo: false
---

## Landscape

```{=openxml}
<w:p><w:pPr><w:sectPr></w:sectPr></w:pPr></w:p>
```

```{r}
#| label: fig-base-plot
#| fig-width: 11.69
#| fig-height: 8.27
#| out-width: 11.69in
#| out-height: 8.27in
plot(seq_len(5), c(1, 4, 9, 16, 25))
```

```{=openxml}
<w:p>
  <w:pPr>
    <w:sectPr>
      <w:pgSz w:h="11906" w:w="16838" w:orient="landscape" />
    </w:sectPr>
  </w:pPr>
</w:p>
```

## Portrait

```{r}
#| ref-label: fig-base-plot
#| label: fig-base-plot-portrait
#| fig-width: 8.27
#| fig-height: 5.85
#| out-width: 8.27in
#| out-height: 5.85in
```

Which produces the following Markdown with explicit height and width:

---
format: docx
keep-md: true
execute:
  echo: false
---

## Landscape

```{=openxml}
<w:p><w:pPr><w:sectPr></w:sectPr></w:pPr></w:p>
```


::: {.cell}
::: {.cell-output-display}
![](index_files/figure-docx/fig-base-plot-1.png){#fig-base-plot width=11.69in height=8.27in}
:::
:::


```{=openxml}
<w:p>
  <w:pPr>
    <w:sectPr>
      <w:pgSz w:h="11906" w:w="16838" w:orient="landscape" />
    </w:sectPr>
  </w:pPr>
</w:p>
```

## Portrait


::: {.cell}
::: {.cell-output-display}
![](index_files/figure-docx/fig-base-plot-portrait-1.png){#fig-base-plot-portrait width=8.27in height=5.85in}
:::
:::

[mcanouil]

Pandoc resizes all images for Word to fit the page:

• https://github.com/jgm/pandoc/blob/ae68554538194d33681fac269b5325d158fd8c7c/src/Text/Pandoc/Writers/Docx/OpenXML.hs#L967-L974

[mcanouil]

It seems, multiple sections with different page dimensions were never considered in the Pandoc codebase.

The available width is taken from the template at the beginning and never recomputed:

• https://github.com/jgm/pandoc/blob/ae68554538194d33681fac269b5325d158fd8c7c/src/Text/Pandoc/Writers/Docx.hs#L93-L108

as this code is already checking for pgSz from sectPr, it might be possible for Pandoc to fix this.