Skip to content

ImageItem

Defined in: src/layout/page-doc.ts:409

A placed raster image (resource name binds to the page XObject dict); (x, y) is its top-left corner.

readonly optional alpha?: number

Defined in: src/layout/page-doc.ts:424

§20.1.8.4 a:alphaModFix — how opaque the picture is drawn, 0…1. A slide backed by a photograph at 70 % shows a pale wash of it, not the photograph.


readonly optional artifact?: "pagination"

Defined in: src/layout/page-doc.ts:330

Tagged PDF: explicitly mark this item as a pagination artifact (running header/footer, §14.8.2.2.2). Distinguishes header/footer text from not-yet-tagged body content so it is typed /Artifact /Pagination, never a P.

PageItemBase.artifact


readonly optional behind?: boolean

Defined in: src/layout/page-doc.ts:314

§20.4.2.3 @behindDoc — the item is BEHIND the page’s content: a watermark, a slide’s backdrop. Such items paint before everything else, in their own order. Without that they rode the ordinary passes, where every shape paints after every image — so a slide’s white backdrop covered the photograph the slide is made of (corpus: tdf156808, tdf157635, tdf156856).

PageItemBase.behind


readonly optional clip?: object

Defined in: src/layout/page-doc.ts:440

§20.1.8.14 — a picture FILL is the shape’s outline painted with a picture, so it is clipped to that outline: the paths in the shape’s local frame and the matrix that maps them onto the page.

readonly paths: readonly VectorPath[]

readonly transform: readonly [number, number, number, number, number, number]


readonly optional crop?: ImageCrop

Defined in: src/layout/page-doc.ts:417

§20.1.8.55 a:srcRect — the part of the source the frame shows.


readonly optional duotone?: object

Defined in: src/layout/page-doc.ts:429

§20.1.8.23 a:duotone — the picture painted between two colours instead of its own: its dark end is the first, its light end the second.

readonly highlightHex: string

readonly shadowHex: string


readonly optional flipH?: boolean

Defined in: src/layout/page-doc.ts:433

§20.1.7.6 — the picture drawn mirrored in its box.


readonly optional flipV?: boolean

Defined in: src/layout/page-doc.ts:434


readonly height: Pt

Defined in: src/layout/page-doc.ts:414


readonly imageResourceName: string

Defined in: src/layout/page-doc.ts:415


readonly optional pictureId?: number

Defined in: src/layout/page-doc.ts:324

The picture this item belongs to, when it is part of one. A metafile is a list of drawing orders, and text among them is BOTH over what came before and under what comes after: an embedded diagram writes a label, lays a panel over it and writes the label again, offset, as its own drop shadow. Painted in the ordinary passes — every shape, then every line — the buried copy would show through the panel. Items sharing this id are held out of those passes and painted together, in list order.

PageItemBase.pictureId


readonly optional rotationDeg?: number

Defined in: src/layout/page-doc.ts:431

§20.1.7.6 — degrees clockwise about the box’s centre.


readonly optional structId?: number

Defined in: src/layout/page-doc.ts:306

Tagged PDF (§14.8): the logical structure node this item’s content belongs to. Set only on body content in tagged mode; undefined text in the line pass is treated as an artifact. Ignored when not tagging.

PageItemBase.structId


readonly type: "image"

Defined in: src/layout/page-doc.ts:410


readonly optional wash?: object

Defined in: src/layout/page-doc.ts:419

§14.1.2.10 — the contrast/brightness wash the picture is drawn through.

readonly black: number

readonly gain: number


readonly width: Pt

Defined in: src/layout/page-doc.ts:413


readonly x: Pt

Defined in: src/layout/page-doc.ts:411


readonly y: Pt

Defined in: src/layout/page-doc.ts:412


readonly optional z?: number

Defined in: src/layout/page-doc.ts:300

§20.4.2.3 — the float’s relativeHeight. Items with one are sorted by it inside their layer before the page is written; the rest keep their order.

PageItemBase.z