add_line_rsketch
Kind: Function
Domain: Sketch
Canonical import: from cadflow import add_line_rsketch
Signature
def add_line_rsketch(sketch: 'Sketch', entity_id: 'str', start: 'Union[SketchRef, str]', end: 'Union[SketchRef, str]', *, construction: 'bool' = False) -> 'Sketch'
Description
Add a named line entity and return an updated sketch document.
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
sketch | 'Sketch' | yes | - | Not explicitly described in the source docstring. |
entity_id | 'str' | yes | - | Not explicitly described in the source docstring. |
start | 'Union[SketchRef, str]' | yes | - | Not explicitly described in the source docstring. |
end | 'Union[SketchRef, str]' | yes | - | Not explicitly described in the source docstring. |
construction | 'bool' | no | False | Not explicitly described in the source docstring. |
Returns
Type: 'Sketch'
The source docstring does not declare additional return semantics.
Errors
The source docstring does not declare a narrower exception contract. Invalid types, values, ownership, paths, or backend state may still raise the corresponding public error.
Behavior and constraints
- The contract below is generated from the current public runtime signature. Check domain notes for ownership and workflow constraints.
Import check
from cadflow import add_line_rsketch