SpreadsheetSettings

Settings for Spreadsheet. 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 SpreadsheetSettings

Construction

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

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

Properties

bottom_margin_override

@property
def bottom_margin_override(self) -> float

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

Override for the bottom margin in millimeters. If negative, the default bottom margin is used.

Type: float

Default: -1

half_transparent_header_footer

@property
def half_transparent_header_footer(self) -> bool

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

Flag indicating if header/footer content should be rendered with half-transparency.

Type: bool

Default: false

left_margin_override

@property
def left_margin_override(self) -> float

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

Override for the left margin in millimeters. If negative, the default left margin is used.

Type: float

Default: -1

maximum_content_height_per_sheet

@property
def maximum_content_height_per_sheet(self) -> float

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

Maximum content height per sheet in millimeters. If 0, no limit is applied.

Type: float

Default: 0

maximum_content_width_per_sheet

@property
def maximum_content_width_per_sheet(self) -> float

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

Maximum content width per sheet in millimeters. If 0, no limit is applied.

Type: float

Default: 0

maximum_page_height

@property
def maximum_page_height(self) -> float

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

Maximum page height in millimeters.

Type: float

Default: 2800

maximum_page_width

@property
def maximum_page_width(self) -> float

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

Maximum page width in millimeters.

Type: float

Default: 1800

page_height_override

@property
def page_height_override(self) -> float

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

Override for the page height in millimeters. If not positive, the default page height is used.

Type: float

Default: 0

page_width_override

@property
def page_width_override(self) -> float

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

Override for the page width in millimeters. If not positive, the default page width is used.

Type: float

Default: 0

render_only_print_area

@property
def render_only_print_area(self) -> bool

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

Flag indicating if only the print area of spreadsheet sheets should be rendered. If no print area is defined in the sheet, the entire sheet will be rendered.

Type: bool

Default: true

render_sheet_headers_and_footers

@property
def render_sheet_headers_and_footers(self) -> bool

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

Flag indicating if sheet headers and footers should be rendered.

Type: bool

Default: false

right_margin_override

@property
def right_margin_override(self) -> float

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

Override for the right margin in millimeters. If negative, the default right margin is used.

Type: float

Default: -1

split_sheets_into_pages

@property
def split_sheets_into_pages(self) -> bool

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

Flag indicating if spreadsheet sheets should be split into multiple pages.

Type: bool

Default: false

top_margin_override

@property
def top_margin_override(self) -> float

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

Override for the top margin in millimeters. If negative, the default top margin is used.

Type: float

Default: -1