class HexaPDF::Layout::ImageBox

Parent

An Image box object is used for displaying an image.

How an image is displayed inside an image box, depends on whether the width and/or height of the box has been set:

  • If one of them has been set, the other is adjusted to retain the image ratio.

  • If both have been set, both are used as is.

  • If neither has been set, the image is scaled to fit the available space.

Also see: Canvas#image

Attributes

image[R]

The image that is shown in the box.

Public Class Methods

new(image, **kwargs)

Creates a new Image box object for the given image argument which needs to be an image object (e.g. returned by Images#add).

Calls superclass method Box.new

Public Instance Methods

fit(available_width, available_height, _)

Fits the image into the available space.