Commands  ›   ›  Sheet View Setup Create Callout On View At Bounding Box

Sheet View Setup Create Callout On View At Bounding Box

writes to model Public API · not yet exposed

Coming soon

Before you run this

Active document open; active view is a plan/section; Project contains at least one Detail ViewFamilyType; BoundingBoxXYZ supplied via resolvers is valid (min < max on X and Y).

After it runs

Exactly one new callout View added as a child of the parent view, inside a single committed Transaction, audit trail recorded.

When to use this

Don't use this when

Frame-a-room callouts (use SheetViewSetupCreateCalloutWrappingRoomOrSpaceBoundaryCommand).

Decision flow

1) User or Bot supplies parent view id (defaults to active view) + min x/Y/Z + max x/Y/Z in feet. 2) Validate — parent view exists and supports callouts; min < max on X and Y; else WireError + abort. 3) Resolve Detail ViewFamilyType id via ResolveDetailViewFamilyTypeId.FindFirstInDocument(doc); if invalid WireError + abort. 4) Open Transaction 'Create callout (bbox)'. 5) Build rect via GetCalloutRectangle.FromBoundingBox(bb). 6) callout = ViewSection.CreateCallout(doc, parentViewId, vftId, rect.min, rect.max); commit. 7) Bot: JSON {ok, callout_view_id, parent_view_id, min, max}. User: ribbon toast 'Callout placed in {parentView.Name}.' 8) Any exception → tracker.Fail(ex); WireFault {parent_view_id, min, max}.

What you'll see in the chat

on start
Creating callout in parent view at supplied bounding box…
thinking
Validating parent view + bounding box…
Resolving Detail view family type…
Calling ViewSection.CreateCallout…
on success
Callout view {callout_view_id} placed in {parent_view_name}.
on failure
Could not create callout: {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/sheet_view_setup_create_callout_on_view_at_bounding_box
  • Request body schema (from [RestApiParam])
  • Response schema (from [RestApiResponse])
  • curl / JS / Python code examples

Keywords & intent patterns

sheetviewsetupcreatecalloutonviewatboundingbox · callout · detail · view · architecture

Pillar