PolyLineAnnotation Class Documentation
classPolyLineAnnotation : AnnotationNamespace:datalogics_interface
- Inherits from:
Annotation
Detailed Description
A polyline is also called a polygonal chain or piecewise linear curve. It represents a finite number of line segments where the first and last vertex are not connected. In this case, the polyline is added as an annotation to a PDF file.
Constructor & Destructor Documentation
PolyLineAnnotation
PolyLineAnnotation(Page &page, const Rect &rect, const std::vector< Point > &vertices)Parameters
page: Page &The page to which the PolyLineAnnotation is added.
rect: const Rect &A rectangle specifying the annotation's bounds, specified in user space coordinates.
vertices: const std::vector< Point > &A list of points representing the coordinates of the vertices, specified in user space.
Create a new PolyLineAnnotation at the end of a page's annotation array. To create a PolyLineAnnotation and place it elsewhere in the page's annotation array, use the version of the constructor that takes an array position.
PolyLineAnnotation
PolyLineAnnotation(Page &page, const Rect &rect, const std::vector< Point > &vertices, intadd_after)Parameters
page: Page &The page to which the PolyLineAnnotation is added.
rect: const Rect &A rectangle specifying the annotation's bounds, specified in user space coordinates.
vertices: const std::vector< Point > &A list of points representing the coordinates of the vertices, specified in user space.
add_after: int
Create a new PolyLineAnnotation at the end of a page's annotation array. To create a PolyLineAnnotation and place it elsewhere in the page's annotation array, use the version of the constructor that takes an array position.
~PolyLineAnnotation
~PolyLineAnnotation()Member Function Documentation
clear_interior_color
voidclear_interior_color()Returns:
voidClear the interior color.
generate_appearance
std::unique_ptr< Form >generate_appearance()Returns:
A Form representing the visual appearance, or null if the appearance could not be generated.The resulting Form can then be used to set the annotation's appearance, such as by calling SetNormalAppearance.
get_annotation_feature_level
doubleget_annotation_feature_level()Returns:
The minimum PDF version level (e.g. 1.3, 1.4, or 1.5).The minimum PDF version necessary to support the features used in this annotation.
get_border_dash_pattern
std::vector< double >get_border_dash_pattern()Returns:
std::vector< double >An array defining a pattern of dashes and gaps to be used in drawing a dashed border (border style D).
The dash array is a series of numbers that specify the lengths of alternating dashes and gaps. Lengths must be nonnegative, and are expressed in user space units.
Default value is [3]
get_border_style
std::stringget_border_style()Returns:
std::stringThe border style.
Can be one of: S - Solid D - Dashed. The dash pattern is specified as an array (see DashPattern) B - Beveled I - Inset U - Underline Other border styles may be defined in the future. Default is "S"
get_border_style_width
doubleget_border_style_width()Returns:
doubleThe border width in points.
If this value is 0, no border is drawn. The default is 1.0.
get_color
Colorget_color()Returns:
The annotation's color.The color of the annotation.
get_contents
std::stringget_contents()Returns:
The annotation's text contents.The text to be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation's contents in human-readable form.
get_end_ending_style
LineEndingStyleget_end_ending_style()Returns:
LineEndingStyleThe line ending style applied to the last vertex of the polyline.
get_flags
AnnotationFlagsget_flags()Returns:
The annotation's flags.The flags for the annotation.
get_interior_color
std::unique_ptr< Color >get_interior_color()Returns:
The interior fill color, or null if no interior color is set.The color of the border itself can be retrieved from Annotation.Color.
get_normal_appearance
std::unique_ptr< Form >get_normal_appearance()Returns:
A Form representing the annotation's normal appearance, or null if no normal appearance has been set.The normal appearance of the annotation, represented as a Form XObject.
get_opacity
doubleget_opacity()Returns:
The opacity value for this annotation.Opacity is a range from 0.0 (fully transparent) to 1.0 (fully opaque).
get_rect
Rectget_rect()Returns:
The annotation's bounding rectangle in user space coordinates.The size and location of the annotation on its page.
get_start_ending_style
LineEndingStyleget_start_ending_style()Returns:
LineEndingStyleThe line ending style applied to the first vertex of the polyline.
get_subtype
std::stringget_subtype()Returns:
The subtype string (e.g. "Circle", "Square", "Line").The annotation's subtype.
get_title
std::stringget_title()Returns:
The title string.The title of the annotation.
get_vertices
std::vector< Point >get_vertices()Returns:
The array of points, in order, that define the vertices of the polyline in user space coordinates.has_rich_text_data
boolhas_rich_text_data()Returns:
true if the annotation contains Rich Text String content.Checks the annotation for Rich Text String content (PDFReference 1.7 Section 8.6.2). Annotations that contain Rich Text String content and do not have a normal appearance set will not be visible when rendering the page.
operator==
booloperator==(const Annotation &other)Parameters
other: const Annotation &The annotation to compare with this annotation.
Returns:
true if the two annotations are equal.Test annotations for equality (if they are the same annotation).
set_annotation_feature_level
voidset_annotation_feature_level(doublelevel)Parameters
level: doubleThe target PDF version level. Features requiring a higher version will be removed.
Returns:
voidRemoves features not supported in the supplied version number.
set_border_dash_pattern
voidset_border_dash_pattern(const std::vector< double > &pattern)Parameters
pattern: const std::vector< double > &the border style dash pattern
Returns:
voidset_border_style
voidset_border_style(const std::string &style)Parameters
style: const std::string &the border style
Returns:
voidset_border_style_width
voidset_border_style_width(doublewidth)Parameters
width: doublethe border style width
Returns:
voidset_color
voidset_color(const Color &color)Parameters
color: const Color &The new color to set.
Returns:
voidThe color of the annotation.
set_contents
voidset_contents(const std::string &contents)Parameters
contents: const std::string &The new text contents.
Returns:
voidThe text to be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation's contents in human-readable form.
set_end_ending_style
voidset_end_ending_style(LineEndingStylestyle)Parameters
style: LineEndingStyleThe line ending style to apply at the end point.
Returns:
voidThe line ending style applied to the last vertex of the polyline.
set_flags
voidset_flags(AnnotationFlagsflags)Parameters
flags: AnnotationFlagsThe new annotation flags to set.
Returns:
voidThe flags for the annotation.
set_interior_color
voidset_interior_color(const Color &color)Parameters
color: const Color &The new interior fill color. Pass null to remove the interior color.
Returns:
voidOnly RGB colors are allowed.
The color of the border itself can be retrieved from Annotation.Color.
set_normal_appearance
voidset_normal_appearance(Form &form)Parameters
form: Form &The Form to use as the annotation's normal appearance.
Returns:
voidThe normal appearance of the annotation, represented as a Form XObject.
set_opacity
voidset_opacity(doubleopacity)Parameters
opacity: doubleThe new opacity value to set.
Returns:
voidOpacity is a range from 0.0 (fully transparent) to 1.0 (fully opaque).
set_rect
voidset_rect(const Rect &rect)Parameters
rect: const Rect &The new bounding rectangle in user space coordinates.
Returns:
voidThe size and location of the annotation on its page.
set_start_ending_style
voidset_start_ending_style(LineEndingStylestyle)Parameters
style: LineEndingStyleThe line ending style to apply at the start point.
Returns:
voidThe line ending style applied to the first vertex of the polyline.
set_title
voidset_title(const std::string &title)Parameters
title: const std::string &The new title string.
Returns:
voidThe title of the annotation.
set_vertices
voidset_vertices(const std::vector< Point > &vertices)Parameters
vertices: const std::vector< Point > &The array of points, in order, that define the vertices of the polyline in user space coordinates.
Returns:
voidThe vertices that define the polyline annotation, in user space.
to_string
std::stringto_string()Returns:
A string describing this annotation, including its type and rectangle.Returns a string representation of this annotation.
try_as
T *try_as(typename T)Parameters
: typename T
Returns:
T *Attempt to downcast this annotation to a derived type. Returns a pointer to the derived type, or nullptr if the type doesn't match.
try_as
const T *try_as(typename T)Parameters
: typename T
Returns:
const T *Const overload of try_as(). Returns a const pointer, or nullptr.