hexapdf 1.2.0 → 1.4.0

data/lib/hexapdf/type/annotations/line.rb

@@ -43,10 +43,10 @@ module HexaPDF
       # A line annotation is a markup annotation that displays a single straight line.
       #
       # The style of the line annotation, like adding leader lines, changing the colors and so on,
-      # can be customized using the provided convenience methods.
+      # can be customized using the provided convenience methods and those from the included
+      # modules.
       #
-      # Note that changing the line width and color is done using the included
-      # BorderStyling#border_style. While that method allows special styling of the line (like
+      # Note that while BorderStyling#border_style allows special styling of the line (like
       # :beveled), only a simple line dash pattern is supported by the line annotation.
       #
       # Example:
@@ -70,6 +70,8 @@ module HexaPDF
       class Line < MarkupAnnotation
 
         include BorderStyling
+        include InteriorColor
+        include LineEndingStyling
 
         define_field :Subtype, type: Symbol, required: true, default: :Line
         define_field :L,       type: PDFArray, required: true
@@ -115,195 +117,6 @@ module HexaPDF
           end
         end
 
-        # Maps HexaPDF names to PDF names.
-        LINE_ENDING_STYLE_MAP = { # :nodoc:
-          Square: :Square, square: :Square,
-          Circle: :Circle, circle: :Circle,
-          Diamond: :Diamond, diamond: :Diamond,
-          OpenArrow: :OpenArrow, open_arrow: :OpenArrow,
-          ClosedArrow: :ClosedArrow, closed_arrow: :ClosedArrow,
-          None: :None, none: :None,
-          Butt: :Butt, butt: :Butt,
-          ROpenArrow: :ROpenArrow, ropen_arrow: :ROpenArrow,
-          RClosedArrow: :RClosedArrow, rclosed_arrow: :RClosedArrow,
-          Slash: :Slash, slash: :Slash,
-        }.freeze
-        LINE_ENDING_STYLE_REVERSE_MAP = LINE_ENDING_STYLE_MAP.invert # :nodoc:
-
-
-        # Describes the line ending style for a line annotation, i.e. the +start_style+ and the
-        # +end_style+.
-        #
-        # See Line#line_ending_style for more information.
-        LineEndingStyle = Struct.new(:start_style, :end_style)
-
-        # :call-seq:
-        #   line.line_ending_style                                         => style
-        #   line.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 line 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.
-        #
-        #       #>pdf-small-hide
-        #       doc.annotations.
-        #         create_line(doc.pages[0], start_point: [20, 20], end_point: [80, 60]).
-        #         interior_color("hp-orange").
-        #         line_ending_style(end_style: :square).
-        #         regenerate_appearance
-        #
-        # :circle or :Circle::
-        #     A circle filled with the annotation’s interior colour, if any.
-        #
-        #       #>pdf-small-hide
-        #       doc.annotations.
-        #         create_line(doc.pages[0], start_point: [20, 20], end_point: [80, 60]).
-        #         interior_color("hp-orange").
-        #         line_ending_style(end_style: :circle).
-        #         regenerate_appearance
-        #
-        # :diamond or :Diamond::
-        #     A diamond shape filled with the annotation’s interior colour, if any.
-        #
-        #       #>pdf-small-hide
-        #       doc.annotations.
-        #         create_line(doc.pages[0], start_point: [20, 20], end_point: [80, 60]).
-        #         interior_color("hp-orange").
-        #         line_ending_style(end_style: :diamond).
-        #         regenerate_appearance
-        #
-        # :open_arrow or :OpenArrow::
-        #     Two short lines meeting in an acute angle to form an open arrowhead.
-        #
-        #       #>pdf-small-hide
-        #       doc.annotations.
-        #         create_line(doc.pages[0], start_point: [20, 20], end_point: [80, 60]).
-        #         interior_color("hp-orange").
-        #         line_ending_style(end_style: :open_arrow).
-        #         regenerate_appearance
-        #
-        # :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.
-        #
-        #       #>pdf-small-hide
-        #       doc.annotations.
-        #         create_line(doc.pages[0], start_point: [20, 20], end_point: [80, 60]).
-        #         interior_color("hp-orange").
-        #         line_ending_style(end_style: :closed_arrow).
-        #         regenerate_appearance
-        #
-        # :none or :None::
-        #     No line ending.
-        #
-        #       #>pdf-small-hide
-        #       doc.annotations.
-        #         create_line(doc.pages[0], start_point: [20, 20], end_point: [80, 60]).
-        #         interior_color("hp-orange").
-        #         line_ending_style(end_style: :none).
-        #         regenerate_appearance
-        #
-        # :butt or :Butt::
-        #     A short line at the endpoint perpendicular to the line itself.
-        #
-        #       #>pdf-small-hide
-        #       doc.annotations.
-        #         create_line(doc.pages[0], start_point: [20, 20], end_point: [80, 60]).
-        #         interior_color("hp-orange").
-        #         line_ending_style(end_style: :butt).
-        #         regenerate_appearance
-        #
-        # :ropen_arrow or :ROpenArrow::
-        #     Two short lines in the reverse direction from +:open_arrow+.
-        #
-        #       #>pdf-small-hide
-        #       doc.annotations.
-        #         create_line(doc.pages[0], start_point: [20, 20], end_point: [80, 60]).
-        #         interior_color("hp-orange").
-        #         line_ending_style(end_style: :ropen_arrow).
-        #         regenerate_appearance
-        #
-        # :rclosed_arrow or :RClosedArrow::
-        #     A triangular closed arrowhead in the reverse direction from +:closed_arrow+.
-        #
-        #       #>pdf-small-hide
-        #       doc.annotations.
-        #         create_line(doc.pages[0], start_point: [20, 20], end_point: [80, 60]).
-        #         interior_color("hp-orange").
-        #         line_ending_style(end_style: :rclosed_arrow).
-        #         regenerate_appearance
-        #
-        # :slash or :Slash::
-        #      A short line at the endpoint approximately 30 degrees clockwise from perpendicular to
-        #      the line itself.
-        #
-        #       #>pdf-small-hide
-        #       doc.annotations.
-        #         create_line(doc.pages[0], start_point: [20, 20], end_point: [80, 60]).
-        #         interior_color("hp-orange").
-        #         line_ending_style(end_style: :slash).
-        #         regenerate_appearance
-        def line_ending_style(start_style: :UNSET, end_style: :UNSET)
-          if start_style == :UNSET && end_style == :UNSET
-            le = self[:LE]
-            LineEndingStyle.new(LINE_ENDING_STYLE_REVERSE_MAP.fetch(le[0], :none),
-                                LINE_ENDING_STYLE_REVERSE_MAP.fetch(le[1], :none))
-          else
-            start_style = self[:LE][0] if start_style == :UNSET
-            end_style = self[:LE][1] if end_style == :UNSET
-            start_style = LINE_ENDING_STYLE_MAP.fetch(start_style) do
-              raise ArgumentError, "Invalid line ending style: #{start_style.inspect}"
-            end
-            end_style = LINE_ENDING_STYLE_MAP.fetch(end_style) do
-              raise ArgumentError, "Invalid line ending style: #{end_style.inspect}"
-            end
-            self[:LE] = [start_style, end_style]
-            self
-          end
-        end
-
-        # :call-seq:
-        #   line.interior_color          => color or nil
-        #   line.interior_color(*color)   => line
-        #
-        # Returns the interior color or +nil+ (in case the interior color should be transparent)
-        # when no argument is given. Otherwise sets the interior color and returns self.
-        #
-        # The interior color is used to fill the line endings depending on the line ending styles.
-        #
-        # +color+:: The interior color. See
-        #           HexaPDF::Content::ColorSpace.device_color_from_specification for information on
-        #           the allowed arguments.
-        #
-        #           If the special value +:transparent+ is used when setting the color, no color is
-        #           used for filling the line endings.
-        #
-        # Also see: #line_ending_style
-        def interior_color(*color)
-          if color.empty?
-            color = self[:IC]
-            color && !color.empty? ?  Content::ColorSpace.prenormalized_device_color(color.value) : nil
-          else
-            color = if color.length == 1 && color.first == :transparent
-                      []
-                    else
-                      Content::ColorSpace.device_color_from_specification(color).components
-                    end
-            self[:IC] = color
-            self
-          end
-        end
-
         # :call-seq:
         #   line.leader_line_length          => leader_line_length
         #   line.leader_line_length(length)  => line

data/lib/hexapdf/type/annotations/line_ending_styling.rb

@@ -0,0 +1,208 @@
+# -*- encoding: utf-8; frozen_string_literal: true -*-
+#
+#--
+# This file is part of HexaPDF.
+#
+# HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
+# Copyright (C) 2014-2025 Thomas Leitner
+#
+# HexaPDF is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Affero General Public License version 3 as
+# published by the Free Software Foundation with the addition of the
+# following permission added to Section 15 as permitted in Section 7(a):
+# FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
+# THOMAS LEITNER, THOMAS LEITNER DISCLAIMS THE WARRANTY OF NON
+# INFRINGEMENT OF THIRD PARTY RIGHTS.
+#
+# HexaPDF is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public
+# License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with HexaPDF. If not, see <http://www.gnu.org/licenses/>.
+#
+# The interactive user interfaces in modified source and object code
+# versions of HexaPDF must display Appropriate Legal Notices, as required
+# under Section 5 of the GNU Affero General Public License version 3.
+#
+# In accordance with Section 7(b) of the GNU Affero General Public
+# License, a covered work must retain the producer line in every PDF that
+# is created or manipulated using HexaPDF.
+#
+# If the GNU Affero General Public License doesn't fit your need,
+# commercial licenses are available at <https://gettalong.at/hexapdf/>.
+#++
+
+require 'hexapdf/type/annotations'
+
+module HexaPDF
+  module Type
+    module Annotations
+
+      # 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
+      module LineEndingStyling
+
+        # Maps HexaPDF names to PDF names.
+        LINE_ENDING_STYLE_MAP = { # :nodoc:
+          Square: :Square, square: :Square,
+          Circle: :Circle, circle: :Circle,
+          Diamond: :Diamond, diamond: :Diamond,
+          OpenArrow: :OpenArrow, open_arrow: :OpenArrow,
+          ClosedArrow: :ClosedArrow, closed_arrow: :ClosedArrow,
+          None: :None, none: :None,
+          Butt: :Butt, butt: :Butt,
+          ROpenArrow: :ROpenArrow, ropen_arrow: :ROpenArrow,
+          RClosedArrow: :RClosedArrow, rclosed_arrow: :RClosedArrow,
+          Slash: :Slash, slash: :Slash,
+        }.freeze
+        LINE_ENDING_STYLE_REVERSE_MAP = LINE_ENDING_STYLE_MAP.invert # :nodoc:
+
+        # Describes the line ending style, i.e. the +start_style+ and the +end_style+.
+        #
+        # See LineEndingStyling#line_ending_style for more information.
+        LineEndingStyle = Struct.new(:start_style, :end_style)
+
+        # :call-seq:
+        #   annot.line_ending_style                                         => style
+        #   annot.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.
+        #
+        #       #>pdf-small-hide
+        #       doc.annotations.
+        #         create_line(doc.pages[0], start_point: [20, 20], end_point: [80, 60]).
+        #         interior_color("hp-orange").
+        #         line_ending_style(end_style: :square).
+        #         regenerate_appearance
+        #
+        # :circle or :Circle::
+        #     A circle filled with the annotation’s interior colour, if any.
+        #
+        #       #>pdf-small-hide
+        #       doc.annotations.
+        #         create_line(doc.pages[0], start_point: [20, 20], end_point: [80, 60]).
+        #         interior_color("hp-orange").
+        #         line_ending_style(end_style: :circle).
+        #         regenerate_appearance
+        #
+        # :diamond or :Diamond::
+        #     A diamond shape filled with the annotation’s interior colour, if any.
+        #
+        #       #>pdf-small-hide
+        #       doc.annotations.
+        #         create_line(doc.pages[0], start_point: [20, 20], end_point: [80, 60]).
+        #         interior_color("hp-orange").
+        #         line_ending_style(end_style: :diamond).
+        #         regenerate_appearance
+        #
+        # :open_arrow or :OpenArrow::
+        #     Two short lines meeting in an acute angle to form an open arrowhead.
+        #
+        #       #>pdf-small-hide
+        #       doc.annotations.
+        #         create_line(doc.pages[0], start_point: [20, 20], end_point: [80, 60]).
+        #         interior_color("hp-orange").
+        #         line_ending_style(end_style: :open_arrow).
+        #         regenerate_appearance
+        #
+        # :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.
+        #
+        #       #>pdf-small-hide
+        #       doc.annotations.
+        #         create_line(doc.pages[0], start_point: [20, 20], end_point: [80, 60]).
+        #         interior_color("hp-orange").
+        #         line_ending_style(end_style: :closed_arrow).
+        #         regenerate_appearance
+        #
+        # :none or :None::
+        #     No line ending.
+        #
+        #       #>pdf-small-hide
+        #       doc.annotations.
+        #         create_line(doc.pages[0], start_point: [20, 20], end_point: [80, 60]).
+        #         interior_color("hp-orange").
+        #         line_ending_style(end_style: :none).
+        #         regenerate_appearance
+        #
+        # :butt or :Butt::
+        #     A short line at the endpoint perpendicular to the line itself.
+        #
+        #       #>pdf-small-hide
+        #       doc.annotations.
+        #         create_line(doc.pages[0], start_point: [20, 20], end_point: [80, 60]).
+        #         interior_color("hp-orange").
+        #         line_ending_style(end_style: :butt).
+        #         regenerate_appearance
+        #
+        # :ropen_arrow or :ROpenArrow::
+        #     Two short lines in the reverse direction from +:open_arrow+.
+        #
+        #       #>pdf-small-hide
+        #       doc.annotations.
+        #         create_line(doc.pages[0], start_point: [20, 20], end_point: [80, 60]).
+        #         interior_color("hp-orange").
+        #         line_ending_style(end_style: :ropen_arrow).
+        #         regenerate_appearance
+        #
+        # :rclosed_arrow or :RClosedArrow::
+        #     A triangular closed arrowhead in the reverse direction from +:closed_arrow+.
+        #
+        #       #>pdf-small-hide
+        #       doc.annotations.
+        #         create_line(doc.pages[0], start_point: [20, 20], end_point: [80, 60]).
+        #         interior_color("hp-orange").
+        #         line_ending_style(end_style: :rclosed_arrow).
+        #         regenerate_appearance
+        #
+        # :slash or :Slash::
+        #      A short line at the endpoint approximately 30 degrees clockwise from perpendicular to
+        #      the line itself.
+        #
+        #       #>pdf-small-hide
+        #       doc.annotations.
+        #         create_line(doc.pages[0], start_point: [20, 20], end_point: [80, 60]).
+        #         interior_color("hp-orange").
+        #         line_ending_style(end_style: :slash).
+        #         regenerate_appearance
+        def line_ending_style(start_style: :UNSET, end_style: :UNSET)
+          if start_style == :UNSET && end_style == :UNSET
+            le = self[:LE]
+            LineEndingStyle.new(LINE_ENDING_STYLE_REVERSE_MAP.fetch(le[0], :none),
+                                LINE_ENDING_STYLE_REVERSE_MAP.fetch(le[1], :none))
+          else
+            start_style = self[:LE][0] if start_style == :UNSET
+            end_style = self[:LE][1] if end_style == :UNSET
+            start_style = LINE_ENDING_STYLE_MAP.fetch(start_style) do
+              raise ArgumentError, "Invalid line ending style: #{start_style.inspect}"
+            end
+            end_style = LINE_ENDING_STYLE_MAP.fetch(end_style) do
+              raise ArgumentError, "Invalid line ending style: #{end_style.inspect}"
+            end
+            self[:LE] = [start_style, end_style]
+            self
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/lib/hexapdf/type/annotations/markup_annotation.rb

@@ -61,7 +61,6 @@ module HexaPDF
 
         define_field :T,            type: String, version: '1.1'
         define_field :Popup,        type: :Annot, version: '1.3'
-        define_field :CA,           type: Numeric, default: 1.0, version: '1.4'
         define_field :RC,           type: [Stream, String], version: '1.5'
         define_field :CreationDate, type: PDFDate, version: '1.5'
         define_field :IRT,          type: Dictionary, version: '1.5'

data/lib/hexapdf/type/annotations/polygon.rb

@@ -0,0 +1,64 @@
+# -*- encoding: utf-8; frozen_string_literal: true -*-
+#
+#--
+# This file is part of HexaPDF.
+#
+# HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
+# Copyright (C) 2014-2025 Thomas Leitner
+#
+# HexaPDF is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Affero General Public License version 3 as
+# published by the Free Software Foundation with the addition of the
+# following permission added to Section 15 as permitted in Section 7(a):
+# FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
+# THOMAS LEITNER, THOMAS LEITNER DISCLAIMS THE WARRANTY OF NON
+# INFRINGEMENT OF THIRD PARTY RIGHTS.
+#
+# HexaPDF is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public
+# License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with HexaPDF. If not, see <http://www.gnu.org/licenses/>.
+#
+# The interactive user interfaces in modified source and object code
+# versions of HexaPDF must display Appropriate Legal Notices, as required
+# under Section 5 of the GNU Affero General Public License version 3.
+#
+# In accordance with Section 7(b) of the GNU Affero General Public
+# License, a covered work must retain the producer line in every PDF that
+# is created or manipulated using HexaPDF.
+#
+# If the GNU Affero General Public License doesn't fit your need,
+# commercial licenses are available at <https://gettalong.at/hexapdf/>.
+#++
+
+require 'hexapdf/type/annotations'
+
+module HexaPDF
+  module Type
+    module Annotations
+
+      # A polygon annotation displays a closed polygon inside the annotation rectangle.
+      #
+      # Also see PolygonPolyline for more information.
+      #
+      # Example:
+      #
+      #   #>pdf-small
+      #   doc.annotations.create_polygon(doc.pages[0], 20, 20, 30, 70, 80, 60, 40, 30).
+      #     border_style(color: "hp-blue", width: 2, style: [3, 1]).
+      #     interior_color("hp-orange").
+      #     regenerate_appearance
+      #
+      # See: PDF2.0 s12.5.6.9, HexaPDF::Type::Annotations::PolygonPolyline
+      class Polygon < PolygonPolyline
+
+        define_field :Subtype, type: Symbol, required: true, default: :Polygon
+
+      end
+
+    end
+  end
+end

data/lib/hexapdf/type/annotations/polygon_polyline.rb

@@ -0,0 +1,109 @@
+# -*- encoding: utf-8; frozen_string_literal: true -*-
+#
+#--
+# This file is part of HexaPDF.
+#
+# HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
+# Copyright (C) 2014-2025 Thomas Leitner
+#
+# HexaPDF is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Affero General Public License version 3 as
+# published by the Free Software Foundation with the addition of the
+# following permission added to Section 15 as permitted in Section 7(a):
+# FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
+# THOMAS LEITNER, THOMAS LEITNER DISCLAIMS THE WARRANTY OF NON
+# INFRINGEMENT OF THIRD PARTY RIGHTS.
+#
+# HexaPDF is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public
+# License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with HexaPDF. If not, see <http://www.gnu.org/licenses/>.
+#
+# The interactive user interfaces in modified source and object code
+# versions of HexaPDF must display Appropriate Legal Notices, as required
+# under Section 5 of the GNU Affero General Public License version 3.
+#
+# In accordance with Section 7(b) of the GNU Affero General Public
+# License, a covered work must retain the producer line in every PDF that
+# is created or manipulated using HexaPDF.
+#
+# If the GNU Affero General Public License doesn't fit your need,
+# commercial licenses are available at <https://gettalong.at/hexapdf/>.
+#++
+
+require 'hexapdf/type/annotations'
+
+module HexaPDF
+  module Type
+    module Annotations
+
+      # This is the base class for the polygon and polyline markup annotations which display either
+      # a closed polygon or a polyline inside the annotation rectangle.
+      #
+      # The styling is done through methods included by various modules:
+      #
+      # * Changing the line width, line dash pattern and color is done using the method
+      #   BorderStyling#border_style.  While that method allows special styling of the line (like
+      #   :beveled), only a simple line dash pattern is supported.
+      #
+      # * The border effect can be changed through BorderEffect#border_effect. Note that cloudy
+      #   borders are not supported.
+      #
+      # * The interior color can be changed through InteriorColor#interior_color.
+      #
+      # * The line ending style can be changed through LineEndingStyling#line_ending_style.
+      #
+      # See: PDF2.0 s12.5.6.9, HexaPDF::Type::Annotations::Polyline,
+      # HexaPDF::Type::Annotations::Polygon, HexaPDF::Type::MarkupAnnotation
+      class PolygonPolyline < MarkupAnnotation
+
+        include BorderStyling
+        include BorderEffect
+        include InteriorColor
+        include LineEndingStyling
+
+        # Field Subtype is defined in the two subclasses
+        define_field :Vertices, type: PDFArray, required: true
+        define_field :LE, type: PDFArray, default: [:None, :None]
+        define_field :BS, type: :Border
+        define_field :IC, type: PDFArray
+        define_field :BE, type: :XXBorderEffect, version: '1.5'
+        define_field :IT, type: Symbol, version: '1.6',
+                     allowed_values: [:PolygonCloud, :PolyLineDimension, :PolygonDimension]
+        define_field :Measure, type: :Measure, version: '1.7'
+        define_field :Path, type: PDFArray, version: '2.0'
+
+        # :call-seq:
+        #   annot.vertices            => [x0, y0, x1, y1, ...]
+        #   annot.vertices(*points)   => annot
+        #
+        # Returns the array with the vertices, alternating between horizontal and vertical
+        # coordinates, when no argument is given. Otherwise sets the vertices and returns self.
+        #
+        # This is the only required setting. Note, however, that without setting the appearance
+        # style through convenience methods like #border_style nothing will be shown.
+        #
+        # Example:
+        #
+        #   #>pdf-small
+        #   doc.annotations.
+        #     create_polyline(doc.pages[0], 20, 20, 30, 70, 80, 60, 40, 30).
+        #     regenerate_appearance
+        def vertices(*points)
+          if points.empty?
+            self[:Vertices].to_ary
+          elsif points.length % 2 != 0
+            raise ArgumentError, "An even number of arguments must be provided"
+          else
+            self[:Vertices] = points
+            self
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/hexapdf/type/annotations/polyline.rb

@@ -0,0 +1,64 @@
+# -*- encoding: utf-8; frozen_string_literal: true -*-
+#
+#--
+# This file is part of HexaPDF.
+#
+# HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
+# Copyright (C) 2014-2025 Thomas Leitner
+#
+# HexaPDF is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Affero General Public License version 3 as
+# published by the Free Software Foundation with the addition of the
+# following permission added to Section 15 as permitted in Section 7(a):
+# FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
+# THOMAS LEITNER, THOMAS LEITNER DISCLAIMS THE WARRANTY OF NON
+# INFRINGEMENT OF THIRD PARTY RIGHTS.
+#
+# HexaPDF is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public
+# License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with HexaPDF. If not, see <http://www.gnu.org/licenses/>.
+#
+# The interactive user interfaces in modified source and object code
+# versions of HexaPDF must display Appropriate Legal Notices, as required
+# under Section 5 of the GNU Affero General Public License version 3.
+#
+# In accordance with Section 7(b) of the GNU Affero General Public
+# License, a covered work must retain the producer line in every PDF that
+# is created or manipulated using HexaPDF.
+#
+# If the GNU Affero General Public License doesn't fit your need,
+# commercial licenses are available at <https://gettalong.at/hexapdf/>.
+#++
+
+require 'hexapdf/type/annotations'
+
+module HexaPDF
+  module Type
+    module Annotations
+
+      # A polyline annotation displays a polyline inside the annotation rectangle.
+      #
+      # Also see PolygonPolyline for more information.
+      #
+      # Example:
+      #
+      #   #>pdf-small
+      #   doc.annotations.create_polyline(doc.pages[0], 20, 20, 30, 70, 80, 60, 40, 30).
+      #     border_style(color: "hp-blue", width: 2, style: [3, 1]).
+      #     interior_color("hp-orange").
+      #     regenerate_appearance
+      #
+      # See: PDF2.0 s12.5.6.9, HexaPDF::Type::Annotations::PolygonPolyline
+      class Polyline < PolygonPolyline
+
+        define_field :Subtype, type: Symbol, required: true, default: :PolyLine
+
+      end
+
+    end
+  end
+end