JavaScript API: addImage

CONTENTS

LAYOUTS

SETTINGS

TEMPLATES

OTHERS

addImage

PREMIUM

TRIAL / ADVANCED

Adds image.

Note

You are reading the JavaScript API documentation. For the PHP API method please go to addImage.

Description

addImage (image: ArrayBuffer, position: string, options: OptionsImage = {}): this

interface OptionsImage {
    /** Column offset: EMUs value */
    colOffset?: {
        from?: number;
        to?: number;
    };
    /** Number of columns spanned by the image */
    colSize?: number;
    /** Description */
    descr?: string;
    /** Edit as: absolute (don't move or size with cells), oneCell (move but don't size with cells), twoCell (move and size with cells). Default as oneCell */
    editAs?: "absolute" | "oneCell" | "twoCell";
    /** Name */
    name?: string;
    /** Row offset: EMUs value */
    rowOffset?: {
        from?: number;
        to?: number;
    };
    /** Number of rows spanned by the image */
    rowSize?: number;
}

Code samples

Example #1

import { CreateXlsx, OptionsImage } from "build";
import * as fs from "fs";

const xlsx = new CreateXlsx();

const filePng = fs.readFileSync("image.png").buffer;
const fileWebp = fs.readFileSync("image.webp").buffer;

let optionsImage: OptionsImage = {
    colSize: 3,
    rowSize: 7,
};
xlsx.addImage(filePng, "A1", optionsImage);

optionsImage = {
    colSize: 6,
    colOffset: {
        from: 129600,
        to: 137160,
    },
    rowSize: 11,
    rowOffset: {
        from: 152280,
        to: 159840,
    },
};
xlsx.addImage(fileWebp, "AB4", optionsImage);

xlsx.save().then(contents => {
    fs.writeFileSync("addImage_1.xlsx", Buffer.from(contents));
});

The resulting XLSX spreadsheet looks like:

Release notes

phpxlsx 5.0:
- new method.