Commands › General › Set View To Scope Box
Set View To Scope Box
Coming soon
Before you run this
Active view must support scope box assignment (plan, section, elevation — not sheet or schedule).
After it runs
View crop region is controlled by the assigned scope box, or scope box is removed.
When to use this
- User wants to align a view's crop to a named scope box for consistent sheet output.
Don't use this when
Manual crop rectangles (use SetCropViewCommand). Creating new scope boxes.
Inputs
| Name | Kind | Type | Required | Default | Description |
|---|---|---|---|---|---|
scopeBoxId |
config | int |
no | null | Element ID of the scope box to assign |
scopeBoxName |
config | string |
no | null | Name of the scope box to assign |
removeScopeBox |
config | bool |
no | false | If true, removes the current scope box |
Returns
| Name | Type | Description |
|---|---|---|
ScopeBoxName | string | Name of assigned scope box |
Result | string | Summary message |
What you'll see in the chat
on start
Assigning scope box to the current view...
Setting up scope box for this view...
Setting up scope box for this view...
thinking
Checking view supports scope boxes...
Finding available scope boxes...
Resolving scope box selection...
Applying scope box to view...
Finding available scope boxes...
Resolving scope box selection...
Applying scope box to view...
on success
Scope box '{ScopeBoxName}' applied to the view.
on failure
Failed to set scope box: {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/set_view_to_scope_box- Request body schema (from
[RestApiParam]) - Response schema (from
[RestApiResponse]) - curl / JS / Python code examples
Keywords & intent patterns
scope box · set view scope box · assign scope box · remove scope box · view scope
Patterns: set view to scope box · assign * scope box · scope box * view
Related
| Related commands | SetCropViewCommand |
|---|---|
| Pillar | General |