BackgroundImageDto
A background image configured on a design theme for PDF rendering.
Properties
| Name | Type | Description |
|---|---|---|
| code | string | Unique code for this background image. |
Unique code for this background image. | ||
| imageAsset | CodeAndNameDto | |
| pageSelection | enum | None AllPages FirstPageOnly AllExceptFirstPage |
None AllPages FirstPageOnly AllExceptFirstPage | ||
| position | enum | FullPage TopCenter BottomCenter Center TopLeft TopRight BottomLeft BottomRight Custom |
FullPage TopCenter BottomCenter Center TopLeft TopRight BottomLeft BottomRight Custom | ||
| offsetXMm | number | Horizontal offset in mm from the left edge. Only used when Position is Custom. |
Horizontal offset in mm from the left edge. Only used when Position is Custom. | ||
| offsetYMm | number | Vertical offset in mm from the top edge. Only used when Position is Custom. |
Vertical offset in mm from the top edge. Only used when Position is Custom. | ||
| widthMm | number | Width in millimeters. Null means natural width or full page for FullPage position. |
Width in millimeters. Null means natural width or full page for FullPage position. | ||
| heightMm | number | Height in millimeters. Null means natural height or full page for FullPage position. |
Height in millimeters. Null means natural height or full page for FullPage position. | ||
| opacity | number | Opacity from 0.0 (transparent) to 1.0 (opaque). Useful for watermark effects. |
Opacity from 0.0 (transparent) to 1.0 (opaque). Useful for watermark effects. | ||
| overlayColor | string | Optional overlay color in hex format. Applied with mix-blend-mode: multiply for a tint effect. |
Optional overlay color in hex format. Applied with mix-blend-mode: multiply for a tint effect. | ||
| sortOrder | integer | Rendering order (z-index). Lower values render behind higher values. |
Rendering order (z-index). Lower values render behind higher values. | ||
JSON Example
{
"code": "string",
"imageAsset": {
"code": "string",
"name": "string"
},
"pageSelection": "None",
"position": "FullPage",
"offsetXMm": 0
}