Image#

CONSTRUCTOR METHODS

Image(data: Buffer | ArrayBuffer | Uint8Array | string)#

Returns an Image from the supplied data buffer.

Parameters:

data – Buffer | ArrayBuffer | Uint8Array | string. Buffer of file data.

Returns:

Image.

EXAMPLE

let image = new mupdfjs.Image(fs.readFileSync("logo.png"))

INSTANCE METHODS

getWidth()#

Get the image width in pixels.

Returns:

number.

EXAMPLE

var width = image.getWidth();
getHeight()#

Get the image height in pixels.

Returns:

number.

EXAMPLE

var height = image.getHeight();
getXResolution()#

Returns the x resolution for the Image in dots per inch.

Returns:

number.

EXAMPLE

var xRes = image.getXResolution();
getYResolution()#

Returns the y resolution for the Image in dots per inch.

Returns:

number.

EXAMPLE

var yRes = image.getYResolution();
getColorSpace()#

Returns the ColorSpace for the Image.

Returns:

ColorSpace.

EXAMPLE

var cs = image.getColorSpace();
getNumberOfComponents()#

Number of colors; plus one if an alpha channel is present.

Returns:

number.

EXAMPLE

var num = image.getNumberOfComponents();
getBitsPerComponent()#

Returns the number of bits per component.

Returns:

number.

EXAMPLE

var bits = image.getBitsPerComponent();
getImageMask()#

Returns true if this image is an image mask.

Returns:

boolean.

EXAMPLE

var hasMask = image.getImageMask();
getMask()#

Get another Image used as a mask for this one.

Returns:

Image (or null).

EXAMPLE

var mask = image.getMask();
toPixmap()#

Create a Pixmap from the image.

Returns:

Pixmap.

EXAMPLE

var pixmap = image.toPixmap();

Code samples

Code samples are in TypeScript and assume that the following requirements are defined in your TypeScript file header as follows:

import * as fs from "fs"
import * as mupdfjs from "mupdf/mupdfjs"