Commands  ›  General  ›  Set Crop View

Set Crop View

General writes to model Public API · not yet exposed

Coming soon

Before you run this

Active view must be a plan, section, or elevation view (not sheet, schedule, or 3D).

After it runs

View crop region is set to the rectangle defined by the two picked corners. Crop is enabled.

When to use this

Don't use this when

Cropping 3D views or sheets. Resetting crop to default. Scope box assignment (use SetViewToScopeBoxCommand).

Returns

NameTypeDescription
WidthMmdoubleCrop width in mm
HeightMmdoubleCrop height in mm
ResultstringSummary message

What you'll see in the chat

on start
Setting the crop region from picked corners...
Drawing the crop rectangle...
thinking
Checking view type supports cropping...
Waiting for corner point 1...
Waiting for corner point 2...
Applying crop region...
on success
Crop region set — {WidthMm}mm × {HeightMm}mm.
on failure
Failed to set crop region: {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_crop_view
  • Request body schema (from [RestApiParam])
  • Response schema (from [RestApiResponse])
  • curl / JS / Python code examples

Keywords & intent patterns

set crop view · crop region · crop view · draw crop · custom crop · set crop
Patterns: set crop view · crop * view · set * crop region

Related commandsSetViewToScopeBoxCommand
PillarGeneral