ImageItem

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

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

Extends

PageItemBase

Properties

alpha?

readonly optional alpha?: number

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

§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.

artifact?

readonly optional artifact?: "pagination"

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

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.

Inherited from

PageItemBase.artifact

behind?

readonly optional behind?: boolean

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

§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).

Inherited from

PageItemBase.behind

clip?

readonly optional clip?: object

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

§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.

paths

readonly paths: readonly VectorPath[]

transform

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

crop?

readonly optional crop?: ImageCrop

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

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

duotone?

readonly optional duotone?: object

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

§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.

highlightHex

readonly highlightHex: string

shadowHex

readonly shadowHex: string

flipH?

readonly optional flipH?: boolean

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

§20.1.7.6 — the picture drawn mirrored in its box.

flipV?

readonly optional flipV?: boolean

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

height

readonly height: Pt

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

imageResourceName

readonly imageResourceName: string

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

over?

readonly optional over?: boolean

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

The item stands IN FRONT of the page’s text and covers it — a drawing floating over a spreadsheet’s cells. A page paints its text after its shapes, so such items are painted as a second layer, every pass again, once the first layer’s text is down.

Inherited from

PageItemBase.over

pictureId?

readonly optional pictureId?: number

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

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.

Inherited from

PageItemBase.pictureId

rotationDeg?

readonly optional rotationDeg?: number

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

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

structId?

readonly optional structId?: number

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

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.

Inherited from

PageItemBase.structId

type

readonly type: "image"

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

wash?

readonly optional wash?: object

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

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

black

readonly black: number

gain

readonly gain: number

width

readonly width: Pt

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

window?

readonly optional window?: PageWindow

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

The part of the page the item may paint, when it is cut off — a spreadsheet’s drawing printed in pieces, each piece seen only over the rows and columns of its own page (TableOverlay). Top-left frame, like the item itself. Items sharing a window paint together, in their own order, after the rest of their layer.

Inherited from

PageItemBase.window

x

readonly x: Pt

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

y

readonly y: Pt

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

z?

readonly optional z?: number

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

§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.

Inherited from

PageItemBase.z