sempdf v1.9.1Interfaces
Interface: FlowImageOptions
sempdf / FlowImageOptions
Defined in: src/types.ts:1454
Options for placing images through the flow layout API.
Extends
Omit<JpegImageOptions,FlowBoxKeys|"height">.Omit<PngImageOptions,FlowBoxKeys|"height">.Omit<BmpImageOptions,FlowBoxKeys|"height">.Omit<TiffImageOptions,FlowBoxKeys|"height">.Omit<Jp2ImageOptions,FlowBoxKeys|"height">.FlowBlockSpacingOptions
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
align? | BlockAlign | Horizontal alignment for laid-out content. | - | src/types.ts:1469 |
altText? | string | Alternate text for tagged non-text content. | JpegImageOptions.altText | src/types.ts:2757 |
artifactSubtype? | "Header" | "Footer" | "Watermark" | Optional artifact subtype, such as Header, Footer, or Watermark. | BmpImageOptions.artifactSubtype | src/types.ts:379 |
artifactType? | "Pagination" | "Layout" | "Page" | Artifact type written to the marked-content property dictionary. | BmpImageOptions.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:1465 |
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. | JpegImageOptions.iccProfile | src/types.ts:2767 |
margin? | FlowMarginShorthand | CSS-like margin shorthand in PDF points. | FlowBlockSpacingOptions.margin | src/types.ts:1271 |
marginBottom? | number | Bottom margin in PDF points. | FlowBlockSpacingOptions.marginBottom | src/types.ts:1277 |
marginLeft? | number | Left margin in PDF points. | FlowBlockSpacingOptions.marginLeft | src/types.ts:1279 |
marginRight? | number | Right margin in PDF points. | FlowBlockSpacingOptions.marginRight | src/types.ts:1275 |
marginTop? | number | Top margin in PDF points. | FlowBlockSpacingOptions.marginTop | src/types.ts:1273 |
maxWidth? | number | Maximum image width in PDF points. | - | src/types.ts:1467 |
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. | JpegImageOptions.structure | src/types.ts:2761 |
tag? | | "Artifact" | PdfFigureStructureTag | Structure tag used for tagged PDF output. | JpegImageOptions.tag | src/types.ts:2759 |
width? | number | Width in PDF points. | - | src/types.ts:1463 |