InlineStyleSettings

Settings for InlineStyle. 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: Vision, Advanced

from nutrient_sdk import InlineStyleSettings

Construction

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

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

Properties

diagnostics_path

@property
def diagnostics_path(self) -> str

@diagnostics_path.setter
def diagnostics_path(self, value: str) -> None

Absolute path of a JSON-lines file that receives per-word typography diagnostics (candidate geometry, the model’s outputs, active execution provider). Diagnostics are off when empty.

Type: str

Default: string.Empty

glyph_extents_path

@property
def glyph_extents_path(self) -> str

@glyph_extents_path.setter
def glyph_extents_path(self, value: str) -> None

Absolute path of a local glyph-extent table: the vertical ink extents of the characters of the fonts the model names. With it, a word’s point size blends the model’s estimate with the size its ink height gives in the font its paragraph is recognized as; without it, the model’s estimate is kept.

Type: str

Default: string.Empty

model_path

@property
def model_path(self) -> str

@model_path.setter
def model_path(self, value: str) -> None

Absolute path to a typography ONNX model that overrides the packaged production model. The model carries its own decoding rules in its metadata. Intended for qualification and benchmarking of candidate models; the override bypasses the production artifact checksum pinning.

Type: str

Default: string.Empty

reference_mode

@property
def reference_mode(self) -> InlineStyleReferenceMode

@reference_mode.setter
def reference_mode(self, value: InlineStyleReferenceMode) -> None

Reference strategy used when classifying inline styles.

Type: InlineStyleReferenceMode

Default: InlineStyleReferenceMode.Nearest

thresholds_path

@property
def thresholds_path(self) -> str

@thresholds_path.setter
def thresholds_path(self, value: str) -> None

Absolute path to a JSON file of style thresholds (style_on) and calibration temperatures (temperature), seven values each in label order, that replace the ones in the model’s metadata. Ignored unless model_path is set.

Type: str

Default: string.Empty