SketchRef
Kind: Class
Domain: Sketch
Canonical import: from cadflow import SketchRef
Signature
class SketchRef(sketch_id: 'str', entity_id: 'str', *, kind: 'str', subentity: 'str' = 'geometry') -> 'None'
Description
Stable reference to a sketch entity or subentity.
Other public imports
from cadflow.sketch_api import SketchRef
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
sketch_id | 'str' | yes | - | Not explicitly described in the source docstring. |
entity_id | 'str' | yes | - | Not explicitly described in the source docstring. |
kind | 'str' | yes | - | Not explicitly described in the source docstring. |
subentity | 'str' | no | 'geometry' | Not explicitly described in the source docstring. |
Returns
Type: 'None'
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.
Public members
| Member | Kind | Signature | Description |
|---|---|---|---|
from_dict | class method | (cls, data: 'Mapping[str, Any]') -> "'SketchRef'" | See the member signature. |
to_dict | method | (self) -> 'Dict[str, str]' | See the member signature. |
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 SketchRef