Appearance
zeropdf / FlowImageOptions
Interface: FlowImageOptions
Defined in: src/types.ts:1183
Options for placing images through the flow layout API.
Extends
Omit<JpegImageOptions,"x"|"y"|"width"|"height">.Omit<PngImageOptions,"x"|"y"|"width"|"height">.Omit<BmpImageOptions,"x"|"y"|"width"|"height">.Omit<TiffImageOptions,"x"|"y"|"width"|"height">.Omit<Jp2ImageOptions,"x"|"y"|"width"|"height">.FlowBlockSpacingOptions
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
align? | "left" | "center" | "right" | Horizontal alignment for laid-out content. | - | src/types.ts:1198 |
altText? | string | Alternate text for tagged non-text content. | JpegImageOptions.altText | src/types.ts:2112 |
height? | number | Height in PDF points. | - | src/types.ts:1194 |
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:2122 |
margin? | FlowMarginShorthand | CSS-like margin shorthand in PDF points. | FlowBlockSpacingOptions.margin | src/types.ts:1137 |
marginBottom? | number | Bottom margin in PDF points. | FlowBlockSpacingOptions.marginBottom | src/types.ts:1143 |
marginLeft? | number | Left margin in PDF points. | FlowBlockSpacingOptions.marginLeft | src/types.ts:1145 |
marginRight? | number | Right margin in PDF points. | FlowBlockSpacingOptions.marginRight | src/types.ts:1141 |
marginTop? | number | Top margin in PDF points. | FlowBlockSpacingOptions.marginTop | src/types.ts:1139 |
maxWidth? | number | Maximum image width in PDF points. | - | src/types.ts:1196 |
structure? | PdfStructureOptions | Additional structure metadata for tagged PDF output. | JpegImageOptions.structure | src/types.ts:2116 |
tag? | | PdfFigureStructureTag | "Artifact" | Structure tag used for tagged PDF output. | JpegImageOptions.tag | src/types.ts:2114 |
width? | number | Width in PDF points. | - | src/types.ts:1192 |