Skip to main content
Version: API v2 Preview

Path

Kind: class
Module/package: models
SDK: pdfdancer-client-python 2.0.0

Vector path composed of one or more PathSegments.

Parameters:

  • position: Where to place the path on the page.
  • path_segments: List of Line and/or Bezier segments.
  • even_odd_fill: If True, use even-odd rule for fills; otherwise nonzero winding.

Example (adding a triangle to a page):

from pdfdancer.models import Path, Line, Point, Position, AddRequest

tri = Path(
    position=Position.at_page_coordinates(0, 100, 100),
    path_segments=[
        Line(Point(0, 0), Point(50, 100)),
        Line(Point(50, 100), Point(100, 0)),
        Line(Point(100, 0), Point(0, 0)),
    ],
    even_odd_fill=True,
)
payload = AddRequest(tri).to_dict()

Declaration​

Path(position: pdfdancer.models.Position | None = None, path_segments: List[pdfdancer.models.PathSegment] | None = None, even_odd_fill: bool | None = None) -> None

Members​

__init__​

__init__(self, position: pdfdancer.models.Position | None = None, path_segments: List[pdfdancer.models.PathSegment] | None = None, even_odd_fill: bool | None = None) -> None

Initialize self. See help(type(self)) for accurate signature.

get_even_odd_fill​

get_even_odd_fill(self) -> bool | None

Returns whether even-odd fill rule should be used (true) or nonzero (false).

get_path_segments​

get_path_segments(self) -> List[pdfdancer.models.PathSegment] | None

Returns the list of path segments that compose this path.

get_position​

get_position(self) -> pdfdancer.models.Position | None

Returns the position of this path.

set_position​

set_position(self, position: pdfdancer.models.Position) -> None

Sets the position of this path.

View source at af2a1171a1b9