addBackgroundImage

CONTENTS

LAYOUT AND SETTINGS

TEMPLATES

SAVE

FORMAT CONVERSION

XLSXUTILITIES

INDEXER

PERFORMANCE

CRYPTO

DIGITAL SIGNATURE

BASIC / ADVANCED / PREMIUM

Description

public addBackgroundImage($image, $options = array())

This method allows the insertion of a background image into the Excel spreadsheet.

The image can have the following extensions:

A background image does not behave exactly like a watermark but like a standard HTML background image: it tiles the entire background.

Parameters

image

Image file path, base64 or stream.

options

Key	Type	Description
replace	bool	If true replaces existing background images. Default as true.

Exceptions

Image doesn't exist.

Code samples

Example #1

require_once 'classes/CreateXlsx.php';

$xlsx = new CreateXlsx();

$xlsx->addBackgroundImage('image.png');

$xlsx->saveXlsx('output');

The resulting XLSX looks like:

Release notes

phpxlsx 2.5:
- overwrite option renamed to replace.
- stream and base64 as image source.
phpxlsx 1.0: new method.