Images and Figures (rinoh.image)

class rinoh.image.Image(filename_or_file, scale=1.0, width=None, height=None, dpi=None, rotate=0, limit_width=<rinoh.dimension.Fraction object>, align=None, id=None, style=None, parent=None, source=None)

class rinoh.image.InlineImage(filename_or_file, scale=1.0, width=None, height=None, dpi=None, rotate=0, baseline=None, id=None, style=None, parent=None, source=None)

arguments

alias of rinoh.image.InlineImageArgs

class rinoh.image.BackgroundImage(filename_or_file, scale=1.0, width=None, height=None, dpi=None, rotate=0, limit_width=<rinoh.dimension.Fraction object>, align=None, id=None, style=None, parent=None, source=None)

Image to place in the background of a page

Takes the same arguments as Image.

arguments

alias of rinoh.image.ImageArgs

class rinoh.image.ImageArgs(base=None, **attributes)

limit_width

Limit the image width when none of scale, width and height are given and the image would be wider than the container

Accepts Dimension: a numeric value followed by a unit (pt, in, pc, mm, cm, %, /4)

Default: 100%

align

How to align the image within the page

Accepts HorizontalAlignment: left, right, center

Default: left

file_or_filename

Path to the image file (inherited from ImageArgsBase)

Accepts ImagePath: path to an image file enclosed in quotes

Default: none

scale

Scaling factor for the image (inherited from ImageArgsBase)

Accepts Scale: fit, fill or a float larger than 0

Default: fit

width

The width to scale the image to (inherited from ImageArgsBase)

Accepts Dimension: a numeric value followed by a unit (pt, in, pc, mm, cm, %, /4)

Default: none

height

The height to scale the image to (inherited from ImageArgsBase)

Accepts Dimension: a numeric value followed by a unit (pt, in, pc, mm, cm, %, /4)

Default: none

dpi

Overrides the DPI value set in the image (inherited from ImageArgsBase)

Accepts Integer: a natural number (positive integer)

Default: (no value)

rotate

Angle in degrees to rotate the image (inherited from ImageArgsBase)

Accepts Integer: a natural number (positive integer)

Default: (no value)

class rinoh.image.Scale

Scaling factor for images

Can be a numerical value where a value of 1 keeps the image’s original size or one of values.

Accepts: fit, fill or a float larger than 0

class rinoh.image.Caption(content, custom_label=None, id=None, style=None, parent=None)

style_class

alias of rinoh.image.CaptionStyle

prepare(flowable_target)

Determine number labels and register references with the document

class rinoh.image.Figure(flowables, align=None, width=None, id=None, style=None, parent=None, source=None)

style_class

alias of rinoh.image.FigureStyle

class rinoh.image.ListOfFiguresSection

list_class

alias of rinoh.image.ListOfFigures

class rinoh.image.ListOfFigures(local=False, id=None, style=None, parent=None)