ImageSettings

Settings for Image. 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 ImageSettings

Construction

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

# SDK-wide default (applies to all documents)
SdkSettings.image_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.image_settings = other_settings is rejected.

Properties

export_format

@property
def export_format(self) -> ImageExportFormat

@export_format.setter
def export_format(self, value: ImageExportFormat) -> None

The export format for the image.

Type: ImageExportFormat

Default: ImageExportFormat.Auto

jpeg_quality

@property
def jpeg_quality(self) -> int

@jpeg_quality.setter
def jpeg_quality(self, value: int) -> None

JPEG compression quality, in the 1..100 range. Only used when resolves to .

Type: int

Default: 90

mode

@property
def mode(self) -> ImageSettingMode

@mode.setter
def mode(self, value: ImageSettingMode) -> None

The mode options for image processing.

Type: ImageSettingMode

Default: ImageSettingMode.FollowExifRotation | ImageSettingMode.PreserveIccProfile

page_index

@property
def page_index(self) -> Optional[int]

@page_index.setter
def page_index(self, value: Optional[int]) -> None

Zero-based page index to render for single-page raster formats (PNG, JPEG, BMP).

Type: Optional[int]

Default: null

rasterization_dpi

@property
def rasterization_dpi(self) -> float

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

The rasterization DPI for image rasterization.

Type: float

Default: 200.0F