modern-pdf-lib / ImageRef
Interface: ImageRef
Defined in: src/core/pdfPage.ts:485
Opaque handle for an image that has been embedded in the document.
Properties
height
readonlyheight:number
Defined in: src/core/pdfPage.ts:493
Intrinsic height in pixels.
name
readonlyname:string
Defined in: src/core/pdfPage.ts:487
Resource name used in content-stream operators (e.g. Im1).
ref
readonlyref:PdfRef
Defined in: src/core/pdfPage.ts:489
Indirect reference to the image XObject.
width
readonlywidth:number
Defined in: src/core/pdfPage.ts:491
Intrinsic width in pixels.
Methods
scale()
scale(
factor):object
Defined in: src/core/pdfPage.ts:499
Return a new { width, height } scaled by the given factor.
Parameters
factor
number
Scale multiplier (e.g. 0.5 for half size).
Returns
object
height
height:
number
width
width:
number
scaleToFit()
scaleToFit(
maxWidth,maxHeight):object
Defined in: src/core/pdfPage.ts:507
Return a new { width, height } that fits within the given bounds while preserving the aspect ratio.
Parameters
maxWidth
number
Maximum allowed width.
maxHeight
number
Maximum allowed height.
Returns
object
height
height:
number
width
width:
number