Practical phpxlsx

Settings

Introduction

phpxlsx provides the necessary methods to modify the layout and settings of the spreadsheet (workbook, sheets, columns and rows), as well as set the internal properties such as author, description and keywords.

Spreadsheet properties

Each spreadsheet has internal properties such as subject, creator, description or categories. Besides, it counts with full-customizable properties in its name and value.

phpxlsx includes addProperties to define the properties:

public function addProperties($values)

$values is an array of the properties to add. Besides its predefined properties like subject or creator, the custom key allows to add new properties.

For example, for inserting multiple properties in the spreadsheet, use the code:

$properties = array(
    'title' => 'My title',
    'subject' => 'My subject',
    'creator' => 'The creator',
    'keywords' => 'keyword 1, keyword 2, keyword 3',
    'description' => 'The description could be much longer than this',
    'category' => 'My category',
    'contentStatus' => 'Draft',
    'Manager' => 'The boss',
    'Company' => 'My company',
    'custom' => array(
	    'My custom text' => array('text' => 'This is a reasonably large text'),
	    'My custom number' => array('number' => '4567'),
	    'My custom date' => array('date' => '1962-01-27T23:00:00Z'),
	    'My custom boolean' => array('boolean' => true)
	)
);
$xlsx->addProperties($properties);

Workbook settings

The method for applying workbook settings is setWorkbookSettings:

    public function setWorkbookSettings($options = array())

$options is an array which can have these keys:

'activeTab': sets the active tab in the workbook
'activeSheetAsActiveTab': if true, sets the internal active sheet as the active tab

The following sample code sets the internal active sheet as the active tab:

$xlsx->setActiveSheet(array('position' => 2));
$xlsx->setWorkbookSettings(array('activeSheetAsActiveTab' => true));

A fixed value can also be set as the active tab:

$xlsx->setWorkbookSettings(array('activeTab' => 1));

Sheet settings

The method for applying sheet settings is setSheetSettings:

    public function setSheetSettings($options = array())

$options is an array to set sheet margins, paper properties, the orientation, the active cell and other settings in the active sheet.

The following sample code changes the settings of the active sheet:

$xlsx->setSheetSettings(array('paperType' => 'A4', 'marginTop' => 0.1, 'marginBottom' => 0.1,));

Column and row settings

Column and row settings can be changed using setColumnSettings and setRowSettings methods:

public function setColumnSettings($position, $options = array())

public function setRowSettings($position, $options = array())

The $position parameter sets the column or row position to be changed. The $options array allows applying the settings.

Let's set column and row sizes:

$xlsx->setColumnSettings('B', array('width' => 40));
$xlsx->setColumnSettings('C', array('width' => 30.25));

$xlsx->setRowSettings(4, array('height' => 90.25));
$xlsx->setRowSettings(2, array('height' => 60));

To get column and row settings, phpxlsx includes the following methods: getColumnSettings and getRowSettings.

Tips and tricks

The setRtl method sets global right to left options.

Next - Get information