Skip to content

ReferencePosition

ReferencePosition captures where an extracted element is located on the sheet. The model stores the reference_id of the associated element together with an optional Polygon outlining its position, so you can correlate each annotation with its place on the drawing. Because the identifier matches the reference_id used by the other extracted objects, positions can be joined to dimensions, notes, or features without additional lookups. With this structured location data you can build interactive viewers, highlight callouts in context, or support review workflows without manually interpreting every leader line.

Bases: BaseModel

Represents the position of a reference in the drawing.

PARAMETER DESCRIPTION
reference_id

Reference ID to identify the object.

TYPE: int

polygon

TYPE: Polygon | None

Source code in werk24/models/v2/models.py
class ReferencePosition(BaseModel):
    """
    Represents the position of a reference in the drawing.
    """

    reference_id: int = Field(
        ...,
        description="Reference ID to identify the object.",
        examples=[12345],
    )
    polygon: Optional[Polygon]