PathObjectRef
Kind: class
Module/package: models
SDK: pdfdancer-client-python 2.0.0
Reference to a path object with stroke and fill color information.
Parameters (typically provided by the server):
- internal_id: Identifier of the path object.
- position: Position of the path.
- object_type: Should be ObjectType.PATH.
- stroke_color: Stroke/outline color of the path (optional).
- fill_color: Fill color of the path (optional).
Usage:
- Returned by find/snapshot APIs when querying paths.
- Pass to ModifyPathRequest to update path colors.
Declaration
PathObjectRef(internal_id: str, position: pdfdancer.models.Position, object_type: pdfdancer.models.ObjectType, stroke_color: pdfdancer.models.Color | None = None, fill_color: pdfdancer.models.Color | None = None)
Members
__init__
__init__(self, internal_id: str, position: pdfdancer.models.Position, object_type: pdfdancer.models.ObjectType, stroke_color: pdfdancer.models.Color | None = None, fill_color: pdfdancer.models.Color | None = None)
Initialize self. See help(type(self)) for accurate signature.
get_fill_color
get_fill_color(self) -> pdfdancer.models.Color | None
Get the fill color of the path.
get_internal_id
get_internal_id(self) -> str
Returns the internal identifier for the referenced object.
get_position
get_position(self) -> pdfdancer.models.Position
Returns the current position information for the referenced object.
get_stroke_color
get_stroke_color(self) -> pdfdancer.models.Color | None
Get the stroke/outline color of the path.
get_type
get_type(self) -> pdfdancer.models.ObjectType
Returns the type classification of the referenced object.
set_position
set_position(self, position: pdfdancer.models.Position) -> None
Updates the position information for the referenced object.
to_dict
to_dict(self) -> Dict[str, Any]
Convert to dictionary for JSON serialization.
object_type
object_type: pdfdancer.models.ObjectType
Return the object type using the public object naming convention.