sempdf v1.9.1Interfaces
Interface: JpegImageOptions
sempdf / JpegImageOptions
Defined in: src/types.ts:2747
Options for placing JPEG images on a page.
Extends
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
altText? | string | Alternate text for tagged non-text content. | - | src/types.ts:2757 |
artifactSubtype? | "Header" | "Footer" | "Watermark" | Optional artifact subtype, such as Header, Footer, or Watermark. | ImageFitOptions.artifactSubtype | src/types.ts:379 |
artifactType? | "Pagination" | "Layout" | "Page" | Artifact type written to the marked-content property dictionary. | ImageFitOptions.artifactType | src/types.ts:377 |
clip? | ImageClip | Clip the image to a shape inscribed in its box: "ellipse" fills the box, "circle" uses the smaller box dimension (centered). Defaults to "none". | ImageFitOptions.clip | src/types.ts:2741 |
fit? | ImageFit | How the image fills its box: - "fill" (default) — stretch to the box, ignoring aspect ratio. - "contain" — scale to fit inside the box, preserving aspect (letterboxed). - "cover" — scale to cover the box, preserving aspect (overflow cropped). | ImageFitOptions.fit | src/types.ts:2734 |
height | number | Height in PDF points. | - | src/types.ts:2755 |
iccProfile? | BinaryData | ICC profile bytes used to tag the image's color space as ICCBased (ISO 32000-2 § 8.6.5.5). When provided, the image's ColorSpace becomes [/ICCBased ref] referencing the embedded profile stream. | - | src/types.ts:2767 |
position? | ImagePosition | Alignment within the box when fit leaves slack or overflow. Defaults to "center". | ImageFitOptions.position | src/types.ts:2736 |
structure? | PdfStructureOptions | Additional structure metadata for tagged PDF output. | - | src/types.ts:2761 |
tag? | | "Artifact" | PdfFigureStructureTag | Structure tag used for tagged PDF output. | - | src/types.ts:2759 |
width | number | Width in PDF points. | - | src/types.ts:2753 |
x | number | Horizontal position in PDF points. | - | src/types.ts:2749 |
y | number | Vertical position in PDF points. | - | src/types.ts:2751 |