PathObject
Kind: class
Module/package: types
SDK: pdfdancer-client-python 2.0.0
Represents a vector path object inside a PDF page.
Declaration
PathObject(client: "'PDFDancer'", object_ref: 'ObjectRef')
Members
__init__
__init__(self, client: "'PDFDancer'", object_ref: 'ObjectRef')
Initialize a PathObject.
Args: client: PDFDancer client instance object_ref: ObjectRef or PathObjectRef with path data
clear_clipping
clear_clipping(self) -> 'bool'
Detach any active clipping path from this object.
delete
delete(self) -> 'bool'
Delete this object from the PDF document.
edit
edit(self) -> 'PathEditSession'
Start a fluent editing session to modify path colors.
get_fill_color
get_fill_color(self) -> "Optional['Color']"
Get the fill color of the path, or None if not set.
get_stroke_color
get_stroke_color(self) -> "Optional['Color']"
Get the stroke/outline color of the path, or None if not set.
move_to
move_to(self, x: 'float', y: 'float') -> 'bool'
Move this object to a new position.
object_ref
object_ref(self) -> 'ObjectRef'
Return an ObjectRef for this path.
bounding_box
bounding_box: 'Optional[ModelBoundingRect]'
Optional bounding rectangle (if available).
page_number
page_number: 'int'
Page index where this object resides.