Commands › Drainage › Drainage Notes
Drainage Notes
Coming soon
Before you run this
Active document must be open. User must be in a plan view. At least one drainage pipe must exist in the current view.
After it runs
Text notes are placed next to drainage pipes showing size and slope. Note positions are calculated relative to the drainage system bounding region.
When to use this
- User has placed drainage pipes and wants to annotate them with pipe-size notes.
- User wants to add notes after running DesignDrainageSystemCommand.
- User wants to re-annotate an existing drainage layout.
Don't use this when
Not for placing pipes (use PlaceSVPCommand or DesignDrainageSystemCommand). Not for placing fixture notes (handled by GetFixtureNotes within the orchestrator).
Returns
| Name | Type | Description |
|---|---|---|
NotesPlaced | int | Number of notes placed |
PipeCount | int | Number of drainage pipes found in view |
What you'll see in the chat
on start
Placing drainage notes on your pipes...
Annotating drainage system in current view...
Adding pipe size and slope notes...
Annotating drainage system in current view...
Adding pipe size and slope notes...
thinking
Collecting drainage pipes in view...
Calculating drainage system bounds...
Determining note positions...
Placing annotation notes...
Calculating drainage system bounds...
Determining note positions...
Placing annotation notes...
on success
Done! Placed {NotesPlaced} drainage notes.
on failure
Could not place drainage notes: {error}
REST API
Not yet exposed
This command does not carry a [RestApi] attribute today. Once tagged, this section will auto-populate with:
POST /api/v1/commands/drainage_notes- Request body schema (from
[RestApiParam]) - Response schema (from
[RestApiResponse]) - curl / JS / Python code examples
Keywords & intent patterns
drainage notes · place drainage notes · annotate drainage · mep notes · pipe notes · drainage annotation
Patterns: place * drainage notes · annotate * drainage · add * pipe notes · note * drainage
Related
| Related commands | DesignDrainageSystemCommand · PlaceSVPCommand |
|---|---|
| Pillar | Drainage |