OpenSpout\Writer\Common\Entity\Sheet Class Reference

Public Member Functions
	__construct (int $sheetIndex, string $associatedWorkbookId, SheetManager $sheetManager)
	getAssociatedWorkbookId ()
	getAutoFilter ()
	getColumnWidths ()
	getIndex ()
	getName ()
	getSheetView ()
	getWrittenRowCount ()
	incrementWrittenRowCount ()
	isVisible ()
	setAutoFilter (?AutoFilter $autoFilter)
	setColumnWidth (float $width, int ... $columns)
	setColumnWidthForRange (float $width, int $start, int $end)
	setIsVisible (bool $isVisible)
	setName (string $name)
	Sets the name of the sheet.
	setSheetView (SheetView $sheetView)

Public Attributes
const	DEFAULT_SHEET_NAME_PREFIX = 'Sheet'

Constructor & Destructor Documentation

__construct()

OpenSpout\Writer\Common\Entity\Sheet::__construct	(	int	$sheetIndex,
		string	$associatedWorkbookId,
		SheetManager	$sheetManager )

Parameters

0 | positive-int	$sheetIndex	Index of the sheet, based on order in the workbook (zero-based)
string	$associatedWorkbookId	ID of the sheet's associated workbook
SheetManager	$sheetManager	To manage sheets

Member Function Documentation

getIndex()

OpenSpout\Writer\Common\Entity\Sheet::getIndex

(

)

Return values

0|positive-int

Index of the sheet, based on order in the workbook (zero-based)

getName()

OpenSpout\Writer\Common\Entity\Sheet::getName

(

)

Return values

string

Name of the sheet

getWrittenRowCount()

OpenSpout\Writer\Common\Entity\Sheet::getWrittenRowCount

(

)

Return values

0|positive-int

isVisible()

OpenSpout\Writer\Common\Entity\Sheet::isVisible

(

)

Return values

bool	isVisible Visibility of the sheet

setAutoFilter()

OpenSpout\Writer\Common\Entity\Sheet::setAutoFilter

(

?AutoFilter

$autoFilter

)

Return values

$this

setColumnWidth()

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

Parameters

positive-int

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

setColumnWidthForRange()

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

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

setIsVisible()

OpenSpout\Writer\Common\Entity\Sheet::setIsVisible

(

bool

$isVisible

)

Parameters

bool

$isVisible

Visibility of the sheet

setName()

OpenSpout\Writer\Common\Entity\Sheet::setName

(

string

$name

)

Sets the name of the sheet.

Note that Excel has some restrictions on the name:

• it should not be blank
• it should not exceed 31 characters
• it should not contain these characters: / ? * : [ or ]
• it should be unique.

Parameters

string

$name

Name of the sheet

Exceptions

OpenSpout\Writer\Exception\InvalidSheetNameException

if the sheet's name is invalid

setSheetView()

OpenSpout\Writer\Common\Entity\Sheet::setSheetView

(

SheetView

$sheetView

)

Return values

$this

---

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

• lib/openspout/src/Writer/Common/Entity/Sheet.php