CaptionStyle

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

Style class for Caption

numbering_level

At which section level to restart numbering

Accepts Integer: a natural number (positive integer)

Default: 1

number_separator

Characters inserted between the section number and the caption number

Accepts StyledText: a list of styled text strings, separated by spaces. A styled text string is a quoted string (' or "), optionally followed by a style name enclosed in braces: 'text string' (style name)

Default: '.'

width

Width to render the flowable at (inherited from ParagraphStyle)

Accepts FlowableWidth: auto, fill or a numeric value followed by a unit (pt, in, pc, mm, cm, %, /4)

Default: fill

indent_first

Indentation of the first line of text (inherited from ParagraphStyle)

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

Default: 0pt

line_spacing

Spacing between the baselines of two successive lines of text (inherited from ParagraphStyle)

Accepts LineSpacing: a predefined line spacing type or the name of a line spacing type followed by comma-separated arguments enclosed in braces: <spacing type>(<arg1>, <arg2>, ...)

Default: default

text_align

Alignment of text to the margins (inherited from ParagraphStyle)

Accepts TextAlign: left, right, center, justify

Default: justify

tab_stops

List of tab positions (inherited from ParagraphStyle)

Accepts TabStopList: a comma-seperated list of tab stops. A tab stop is specified as <position> [align] [fill string], where position (Dimension) is required and align (TabAlign) and fill string (string enclosed in quotes) are optional.

Default: (no value)

horizontal_align

Horizontal alignment of the flowable (inherited from FlowableStyle)

Accepts HorizontalAlignment: left, right, center

Default: left

space_above

Vertical space preceding the flowable (inherited from FlowableStyle)

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

Default: 0

space_below

Vertical space following the flowable (inherited from FlowableStyle)

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

Default: 0

margin_left

Left margin (inherited from FlowableStyle)

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

Default: 0

margin_right

Right margin (inherited from FlowableStyle)

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

Default: 0

padding

Padding (inherited from FlowableStyle)

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

Default: 0

padding_left

Left padding (inherited from FlowableStyle)

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

Default: 0

padding_right

Right padding (inherited from FlowableStyle)

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

Default: 0

padding_top

Top padding (inherited from FlowableStyle)

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

Default: 0

padding_bottom

Bottom padding (inherited from FlowableStyle)

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

Default: 0

keep_with_next

Keep this flowable and the next on the same page (inherited from FlowableStyle)

Accepts Bool: true or false

Default: false

border

Border surrounding the flowable (inherited from FlowableStyle)

Accepts Stroke: the width (Dimension) and color (Color) of the stroke, separated by a comma (,)

Default: none

border_left

Border left of the flowable (inherited from FlowableStyle)

Accepts Stroke: the width (Dimension) and color (Color) of the stroke, separated by a comma (,)

Default: none

border_right

Border right of the flowable (inherited from FlowableStyle)

Accepts Stroke: the width (Dimension) and color (Color) of the stroke, separated by a comma (,)

Default: none

border_top

Border above the flowable (inherited from FlowableStyle)

Accepts Stroke: the width (Dimension) and color (Color) of the stroke, separated by a comma (,)

Default: none

border_bottom

Border below the flowable (inherited from FlowableStyle)

Accepts Stroke: the width (Dimension) and color (Color) of the stroke, separated by a comma (,)

Default: none

background_color

Color of the area within the flowable’s borders (inherited from FlowableStyle)

Accepts Color: HEX string with optional alpha component (#RRGGBB, #RRGGBBAA, #RGB or #RGBA)

Default: none

page_break

Type of page break to insert before rendering this flowable (inherited from FlowableStyle)

Accepts Break: none, any, left, right

Default: None

typeface

Typeface to set the text in (inherited from TextStyle)

Accepts Typeface: the name of a typeface. See rinoh --list-fonts for a list of the available typefaces.

Default: Times

font_weight

Thickness of character outlines relative to their height (inherited from TextStyle)

Accepts FontWeight: hairline, thin, ultra-light, extra-light, light, regular, normal, book, roman, medium, semi-bold, demi-bold, bold, extra-bold, ultra-bold, black, heavy, extra-black, ultra-black

Default: 500

font_slant

Slope style of the font (inherited from TextStyle)

Accepts FontSlant: upright, oblique, italic

Default: upright

font_width

Stretch of the characters (inherited from TextStyle)

Accepts FontWidth: ultra-condensed, extra-condensed, condensed, semi-condensed, normal, medium, semi-expanded, expanded, extra-expanded, ultra-expanded

Default: 5

font_size

Height of characters (inherited from TextStyle)

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

Default: 10pt

font_color

Color of the font (inherited from TextStyle)

Accepts Color: HEX string with optional alpha component (#RRGGBB, #RRGGBBAA, #RGB or #RGBA)

Default: #000

font_variant

Variant of the font (inherited from TextStyle)

Accepts FontVariant: normal, small capital, oldstyle figures

Default: normal

position

Vertical text position (inherited from TextStyle)

Accepts TextPosition: normal, superscript, subscript

Default: normal

kerning

Improve inter-letter spacing (inherited from TextStyle)

Accepts Bool: true or false

Default: true

ligatures

Run letters together where possible (inherited from TextStyle)

Accepts Bool: true or false

Default: true

hyphenate

Allow words to be broken over two lines (inherited from TextStyle)

Accepts Bool: true or false

Default: true

hyphen_chars

Minimum number of characters in a hyphenated part of a word (inherited from TextStyle)

Accepts Integer: a natural number (positive integer)

Default: 2

hyphen_lang

Language to use for hyphenation. Accepts locale codes such as ‘en_US’ (inherited from TextStyle)

Accepts Locale: locale identifier in the <language ID>_<region ID> format

Default: en_US

before

Item to insert before this one (inherited from InlineStyle)

Accepts StyledText: a list of styled text strings, separated by spaces. A styled text string is a quoted string (' or "), optionally followed by a style name enclosed in braces: 'text string' (style name)

Default: (no value)

after

Item to insert after this one (inherited from InlineStyle)

Accepts StyledText: a list of styled text strings, separated by spaces. A styled text string is a quoted string (' or "), optionally followed by a style name enclosed in braces: 'text string' (style name)

Default: (no value)

number_format

How numbers are formatted (inherited from NumberStyle)

Accepts NumberFormat: none, number, symbol, lowercase character, uppercase character, lowercase roman, uppercase roman

Default: number

label_prefix

Text to prepend to the label (inherited from LabelStyle)

Accepts StyledText: a list of styled text strings, separated by spaces. A styled text string is a quoted string (' or "), optionally followed by a style name enclosed in braces: 'text string' (style name)

Default: (no value)

label_suffix

Text to append to the label (inherited from LabelStyle)

Accepts StyledText: a list of styled text strings, separated by spaces. A styled text string is a quoted string (' or "), optionally followed by a style name enclosed in braces: 'text string' (style name)

Default: (no value)

custom_label

Use a custom label if specified (inherited from LabelStyle)

Accepts Bool: true or false

Default: false

hide

Suppress rendering this element (inherited from Style)

Accepts Bool: true or false

Default: false