class HexaPDF::Type::Annotations::SquareCircle

Parent	HexaPDF::Type::Annotations::MarkupAnnotation
Included Modules	HexaPDF::Type::Annotations::BorderStyling HexaPDF::Type::Annotations::BorderEffect HexaPDF::Type::Annotations::InteriorColor

This is the base class for the square and circle markup annotations which display a rectangle or ellipse 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 by the square and circle annotations.
The interior color can be changed through InteriorColor#interior_color.
The border effect can be changed through BorderEffect#border_effect. Note that cloudy borders are not supported.

Name	Type/Allowed Values	Required	Default Value
Type	Symbol	false	:Annot
Subtype	Symbol	true	nil
Rect	HexaPDF::Rectangle or Array	true	nil
Contents	String	false	nil
P	HexaPDF::Dictionary or Hash	false	nil
NM	String	false	nil
M	HexaPDF::DictionaryFields::PDFDate or String or Time or Date or DateTime	false	nil
F	Integer	false	0
AP	HexaPDF::Type::Annotation::AppearanceDictionary or Hash	false	nil
AS	Symbol	false	nil
Border	HexaPDF::PDFArray or Array	false	[0, 0, 1]
C	HexaPDF::PDFArray or Array	false	nil
StructParent	Integer	false	nil
OC	HexaPDF::Dictionary or Hash	false	nil
AF	HexaPDF::PDFArray or Array	false	nil
ca	Numeric	false	1.0
CA	Numeric	false	1.0
BM	Symbol	false	nil
Lang	String	false	nil
T	String	false	nil
Popup	HexaPDF::Type::Annotation or Hash	false	nil
RC	HexaPDF::Stream or String or Hash	false	nil
CreationDate	HexaPDF::DictionaryFields::PDFDate or String or Time or Date or DateTime	false	nil
IRT	HexaPDF::Dictionary or Hash	false	nil
Subj	String	false	nil
RT	Symbol One of: :R, :Group	false	:R
IT	Symbol	false	nil
ExData	HexaPDF::Type::Annotations::MarkupAnnotation::ExData or Hash	false	nil
BS	HexaPDF::Type::Annotation::Border or Hash	false	nil
IC	HexaPDF::PDFArray or Array	false	nil
BE	HexaPDF::Type::Annotation::BorderEffect or Hash	false	nil
RD	HexaPDF::PDFArray or Array	false	nil

Menu