module HexaPDF::Type::Annotations::LineEndingStyling

This module provides a convenience method for getting and setting the line ending style for line and polyline annotations.

See: PDF2.0 s12.5.6.7

Constants

LineEndingStyle¶

Describes the line ending style, i.e. the start_style and the end_style.

See LineEndingStyling#line_ending_style for more information.

Public Instance Methods

line_ending_style → style ¶

line_ending_style(start_style: :none, end_style: :none) → line ¶

Returns a LineEndingStyle instance holding the current line ending styles when no argument is given. Otherwise sets the line ending style of the annotation and returns self.

When returning the styles, unknown line ending styles are mapped to :none.

When setting the line ending style, arguments that are not provided will use the currently defined value or fall back to the default of :none.

Possible line ending styles (the first one is the HexaPDF name, the second the PDF name):

:square or :Square

A square filled with the annotation’s interior colour, if any.

:circle or :Circle

A circle filled with the annotation’s interior colour, if any.

:diamond or :Diamond

A diamond shape filled with the annotation’s interior colour, if any.

:open_arrow or :OpenArrow

Two short lines meeting in an acute angle to form an open arrowhead.

:closed_arrow or :ClosedArrow

Two short lines meeting in an acute angle as in the :open_arrow style and connected by a third line to form a triangular closed arrowhead filled with the annotation’s interior colour, if any.

:none or :None