CadSettings

Settings for Cad. Values fall back through three levels: document → SDK → built-in default. Writes target the document only when set on a document’s settings, otherwise the SDK globally when set on SdkSettings.

Tags: Format

from nutrient_sdk import CadSettings

Construction

# Per-document override
with Document.open("input.pdf") as doc:
    settings = doc.settings.cad_settings
    settings.some_field = new_value          # mutate fields directly

# SDK-wide default (applies to all documents)
SdkSettings.cad_settings.some_field = new_value

Settings are configured by writing to fields on the returned object. The settings property itself cannot be reassigned — doc.settings.cad_settings = other_settings is rejected.

Properties

canvas_background_color

@property
def canvas_background_color(self) -> Color

@canvas_background_color.setter
def canvas_background_color(self, value: Color) -> None

The canvas background color.

Type: Color

Default: Color.White

enable_line_weight

@property
def enable_line_weight(self) -> bool

@enable_line_weight.setter
def enable_line_weight(self, value: bool) -> None

This flags controls the support of line weight. It is the same command option as AutoCad “Lineweight”.

Type: bool

Default: true

rendering_layout_mode

@property
def rendering_layout_mode(self) -> RenderingLayoutMode

@rendering_layout_mode.setter
def rendering_layout_mode(self, value: RenderingLayoutMode) -> None

The rendering layout mode that determines how the canvas size and rendering origin are computed.

Type: RenderingLayoutMode

Default: RenderingLayoutMode.ZoomExtents

render_zoom

@property
def render_zoom(self) -> float

@render_zoom.setter
def render_zoom(self, value: float) -> None

The zoom level for rendering CAD documents.

Type: float

Default: The default value is 0.

thumbnail_mode

@property
def thumbnail_mode(self) -> bool

@thumbnail_mode.setter
def thumbnail_mode(self, value: bool) -> None

Indicates whether thumbnail mode is enabled for CAD rendering.

Type: bool

Default: false

unit_mode

@property
def unit_mode(self) -> UnitMode

@unit_mode.setter
def unit_mode(self, value: UnitMode) -> None

The unit mode for measurement in CAD documents.

Type: UnitMode

Default: UnitMode.UnitPoint