Background Images

Background images can be assigned to every page in a document using the page-background-image document attribute. The attribute accepts an inline image macro. The target of the image macro can be a path relative to imagesdir or an absolute path.

By default, page background images are automatically scaled to fit the bounds of the page (i.e., fit=contain) and centered (i.e., position=center). You can set the fit, sizing, and position attributes on the image macro. The size of the background image can be controlled using any of the sizing attributes on the image macro when fit=none.

Background images, including front and back cover images, can be sized relative to the page using the fit attribute on the image macro. The fit attribute works similarly to the object-fit property in CSS. Its value must be specified as a single keyword, chosen from the table below. The starting size of the image is determined by the explicit width, if specified, or the implicit width. The height is always derived from the width while respecting the implicit aspect ratio of the image. The available space—​the canvas—​for a background image is the page. If the fit attribute is not specified, it defaults to contain. The contain value automatically scales the image to fit the bounds of the page.

If you need to scale the image using one of the sizing attributes (pdfwidth, scaledwidth, width), you must set the fit attribute for none.

The fit attribute is often combined with the position attribute, covered next, to control the placement of the image on the canvas.

In addition to scaling, background images for cover pages, content pages, and the title page support positioning using the position attribute. The position attribute accepts a syntax similar to the background-position property in CSS, except only the keyword positions are supported. The position consists of two values, the vertical position and the horizontal position (e.g., top center). If only one value is specified (e.g., top), the other value is assumed to be center. If the position attribute is not specified, its value defaults to is center center. The center center value centers the image vertically and horizontally on the page.

The following table lists of the vertical and horizontal positioning keywords the position attribute supports. You can use any combination of these keywords to position the image.

Here’s an example of how to place a background image at the top center of a page:

Here’s how to move it to the bottom right:

If an image dimension matches the height or width of the page, the positioning keyword for that axis has no effect.

If a background image is assigned to the recto pages (right-hand, odd-numbered pages) or verso pages (left-hand, even-numbered pages), the background will be used only for that side.

If a background image isn’t specified for a side, the converter will use the default page background image (page-background-image), if specified. To turn off the background image for a side, assign the value none.

You can configure any background image to be selected per page layout by including the escaped {page-layout} attribute reference in the image path. The reference has to be escaped so it’s not expanded until the converter resolves the image for a given page layout.

The image is resolved the first time a given page layout is used in the document. Using this technique requires that the page layout value be included in the filename of the image (e.g., footer-bg-landscape.png).