InstantJsonSettings

Settings for InstantJson. 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: Advanced, Format

from nutrient_sdk import InstantJsonSettings

Construction

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

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

Properties

change_tracking_enabled

@property
def change_tracking_enabled(self) -> bool

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

Whether Instant JSON change tracking is enabled. When enabled, modifications to annotations, form fields, form field values, comments, and bookmarks are recorded so that export produces a diff containing only items that changed — matching Core SDK’s export_document_json behavior.

Type: bool

Default: true

render_theme

@property
def render_theme(self) -> InstantJsonRenderTheme

@render_theme.setter
def render_theme(self, value: InstantJsonRenderTheme) -> None

The annotation appearance theme to use when importing Instant JSON.

Type: InstantJsonRenderTheme

Default: InstantJsonRenderTheme.Default