Interface: FlowImageOptions
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 |
|---|---|---|---|
align? | "left" | "center" | "right" | Horizontal alignment for laid-out content. | - |
altText? | string | Alternate text for tagged non-text content. | JpegImageOptions.altText |
height? | number | Height in PDF points. | - |
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 |
margin? | FlowMarginShorthand | CSS-like margin shorthand in PDF points. | FlowBlockSpacingOptions.margin |
marginBottom? | number | Bottom margin in PDF points. | FlowBlockSpacingOptions.marginBottom |
marginLeft? | number | Left margin in PDF points. | FlowBlockSpacingOptions.marginLeft |
marginRight? | number | Right margin in PDF points. | FlowBlockSpacingOptions.marginRight |
marginTop? | number | Top margin in PDF points. | FlowBlockSpacingOptions.marginTop |
maxWidth? | number | Maximum image width in PDF points. | - |
structure? | PdfStructureOptions | Additional structure metadata for tagged PDF output. | JpegImageOptions.structure |
tag? | | PdfFigureStructureTag | "Artifact" | Structure tag used for tagged PDF output. | JpegImageOptions.tag |
width? | number | Width in PDF points. | - |