OpenSpout\Writer\XLSX\Options Class Reference

Inheritance diagram for OpenSpout\Writer\XLSX\Options:

Public Types
enum	PageOrientation : string { LANDSCAPE = 'landscape' }
enum	PaperSize : int { B6 = 35 }

Public Member Functions
	getColumnWidths ()
	getHeaderFooter ()
	getMergeCells ()
	getPageMargin ()
	getPageSetup ()
	mergeCells (int $topLeftColumn, int $topLeftRow, int $bottomRightColumn, int $bottomRightRow, int $sheetIndex=0,)
	Row coordinates are indexed from 1, columns from 0 (A = 0), so a merge B2:G2 looks like $writer->mergeCells(1, 2, 6, 2);.
	setColumnWidth (float $width, int ... $columns)
	setColumnWidthForRange (float $width, int $start, int $end)
	setHeaderFooter (HeaderFooter $headerFooter)
	setPageMargin (PageMargin $pageMargin)
	setPageSetup (PageSetup $pageSetup)

Public Attributes
float	$DEFAULT_COLUMN_WIDTH = null
float	$DEFAULT_ROW_HEIGHT = null
Style	$DEFAULT_ROW_STYLE
bool	$SHOULD_CREATE_NEW_SHEETS_AUTOMATICALLY = true
bool	$SHOULD_USE_INLINE_STRINGS = true
const	DEFAULT_FONT_NAME = 'Calibri'
const	DEFAULT_FONT_SIZE = 12

Constructor & Destructor Documentation

__construct()

OpenSpout\Writer\XLSX\Options::__construct

(

)

Reimplemented from OpenSpout\Writer\Common\AbstractOptions.

Member Function Documentation

getMergeCells()

OpenSpout\Writer\XLSX\Options::getMergeCells

(

)

Return values

MergeCell[]

mergeCells()

OpenSpout\Writer\XLSX\Options::mergeCells	(	int	$topLeftColumn,
		int	$topLeftRow,
		int	$bottomRightColumn,
		int	$bottomRightRow,
		int	$sheetIndex = 0 )

Row coordinates are indexed from 1, columns from 0 (A = 0), so a merge B2:G2 looks like $writer->mergeCells(1, 2, 6, 2);.

Parameters

0 | positive-int	$topLeftColumn
positive-int	$topLeftRow
0 | positive-int	$bottomRightColumn
positive-int	$bottomRightRow
0 | positive-int	$sheetIndex

setColumnWidth()

OpenSpout\Writer\Common\AbstractOptions::setColumnWidth ( float $width, int ... $columns )

finalinherited

Parameters

positive-int

...$columns One or more columns with this width

setColumnWidthForRange()

OpenSpout\Writer\Common\AbstractOptions::setColumnWidthForRange ( float $width, int $start, int $end )

finalinherited

Parameters

float	$width	The width to set
positive-int	$start	First column index of the range
positive-int	$end	Last column index of the range

---

The documentation for this class was generated from the following files:

• lib/openspout/src/Writer/XLSX/Options.php
• lib/openspout/src/Writer/XLSX/Options/PageOrientation.php
• lib/openspout/src/Writer/XLSX/Options/PaperSize.php