\PhpOffice\PhpSpreadsheet\Writer\XlsxChart

Summary

Methods

Properties

Constants

getParentWriter()
__construct()
writeChart()

No public properties found

No constants found

No protected methods found

$calculateCellValues

N/A

writeTitle()
writeLegend()
writePlotArea()
writeDataLabels()
writeCategoryAxis()
writeValueAxis()
getChartType()
writePlotSeriesValuesElement()
writePlotGroup()
writePlotSeriesLabel()
writePlotSeriesValues()
writeBubbles()
writeLayout()
writeAlternateContent()
writePrintSettings()

$parentWriter
$seriesIndex

N/A

Properties

$calculateCellValues

$calculateCellValues :

Type

$parentWriter

$parentWriter : \PhpOffice\PhpSpreadsheet\Writer\Xlsx

Parent Xlsx object.

Type

\PhpOffice\PhpSpreadsheet\Writer\Xlsx

$seriesIndex

$seriesIndex : integer

Type

integer

Methods

getParentWriter()

getParentWriter() : \PhpOffice\PhpSpreadsheet\Writer\Xlsx

Get parent Xlsx object.

Returns

\PhpOffice\PhpSpreadsheet\Writer\Xlsx

__construct()

__construct(\PhpOffice\PhpSpreadsheet\Writer\Xlsx  $pWriter)

Set parent Xlsx object.

Parameters

\PhpOffice\PhpSpreadsheet\Writer\Xlsx

$pWriter

writeChart()

writeChart(\PhpOffice\PhpSpreadsheet\Chart\Chart  $pChart, mixed  $calculateCellValues = true) : string

Write charts to XML format.

Parameters

\PhpOffice\PhpSpreadsheet\Chart\Chart	$pChart
mixed	$calculateCellValues

Throws

\PhpOffice\PhpSpreadsheet\Writer\Exception

Returns

string —

XML Output

writeTitle()

writeTitle(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter  $objWriter, \PhpOffice\PhpSpreadsheet\Chart\Title  $title = null)

Write Chart Title.

Parameters

\PhpOffice\PhpSpreadsheet\Shared\XMLWriter	$objWriter	XML Writer
\PhpOffice\PhpSpreadsheet\Chart\Title	$title

Throws

\PhpOffice\PhpSpreadsheet\Writer\Exception

writeLegend()

writeLegend(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter  $objWriter, \PhpOffice\PhpSpreadsheet\Chart\Legend  $legend = null)

Write Chart Legend.

Parameters

\PhpOffice\PhpSpreadsheet\Shared\XMLWriter	$objWriter	XML Writer
\PhpOffice\PhpSpreadsheet\Chart\Legend	$legend

Throws

\PhpOffice\PhpSpreadsheet\Writer\Exception

writePlotArea()

writePlotArea(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter  $objWriter, \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $pSheet, \PhpOffice\PhpSpreadsheet\Chart\PlotArea  $plotArea, \PhpOffice\PhpSpreadsheet\Chart\Title  $xAxisLabel = null, \PhpOffice\PhpSpreadsheet\Chart\Title  $yAxisLabel = null, \PhpOffice\PhpSpreadsheet\Chart\Axis  $xAxis = null, \PhpOffice\PhpSpreadsheet\Chart\Axis  $yAxis = null, null|\PhpOffice\PhpSpreadsheet\Chart\GridLines  $majorGridlines = null, null|\PhpOffice\PhpSpreadsheet\Chart\GridLines  $minorGridlines = null)

Write Chart Plot Area.

Parameters

\PhpOffice\PhpSpreadsheet\Shared\XMLWriter	$objWriter	XML Writer
\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet	$pSheet
\PhpOffice\PhpSpreadsheet\Chart\PlotArea	$plotArea
\PhpOffice\PhpSpreadsheet\Chart\Title	$xAxisLabel
\PhpOffice\PhpSpreadsheet\Chart\Title	$yAxisLabel
\PhpOffice\PhpSpreadsheet\Chart\Axis	$xAxis
\PhpOffice\PhpSpreadsheet\Chart\Axis	$yAxis
null\|\PhpOffice\PhpSpreadsheet\Chart\GridLines	$majorGridlines
null\|\PhpOffice\PhpSpreadsheet\Chart\GridLines	$minorGridlines

Throws

\PhpOffice\PhpSpreadsheet\Writer\Exception

writeDataLabels()

writeDataLabels(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter  $objWriter, \PhpOffice\PhpSpreadsheet\Chart\Layout  $chartLayout = null)

Write Data Labels.

Parameters

\PhpOffice\PhpSpreadsheet\Shared\XMLWriter	$objWriter	XML Writer
\PhpOffice\PhpSpreadsheet\Chart\Layout	$chartLayout	Chart layout

writeCategoryAxis()

writeCategoryAxis(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter  $objWriter, \PhpOffice\PhpSpreadsheet\Chart\Title  $xAxisLabel, string  $id1, string  $id2, boolean  $isMultiLevelSeries, \PhpOffice\PhpSpreadsheet\Chart\Axis  $yAxis)

Write Category Axis.

Parameters

\PhpOffice\PhpSpreadsheet\Shared\XMLWriter	$objWriter	XML Writer
\PhpOffice\PhpSpreadsheet\Chart\Title	$xAxisLabel
string	$id1
string	$id2
boolean	$isMultiLevelSeries
\PhpOffice\PhpSpreadsheet\Chart\Axis	$yAxis

Throws

\PhpOffice\PhpSpreadsheet\Writer\Exception

writeValueAxis()

writeValueAxis(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter  $objWriter, \PhpOffice\PhpSpreadsheet\Chart\Title  $yAxisLabel, string  $groupType, string  $id1, string  $id2, boolean  $isMultiLevelSeries, \PhpOffice\PhpSpreadsheet\Chart\Axis  $xAxis, \PhpOffice\PhpSpreadsheet\Chart\GridLines  $majorGridlines, \PhpOffice\PhpSpreadsheet\Chart\GridLines  $minorGridlines)

Write Value Axis.

Parameters

\PhpOffice\PhpSpreadsheet\Shared\XMLWriter	$objWriter	XML Writer
\PhpOffice\PhpSpreadsheet\Chart\Title	$yAxisLabel
string	$groupType	Chart type
string	$id1
string	$id2
boolean	$isMultiLevelSeries
\PhpOffice\PhpSpreadsheet\Chart\Axis	$xAxis
\PhpOffice\PhpSpreadsheet\Chart\GridLines	$majorGridlines
\PhpOffice\PhpSpreadsheet\Chart\GridLines	$minorGridlines

Throws

\PhpOffice\PhpSpreadsheet\Writer\Exception

getChartType()

getChartType(\PhpOffice\PhpSpreadsheet\Chart\PlotArea  $plotArea) : array|string

Get the data series type(s) for a chart plot series.

Parameters

\PhpOffice\PhpSpreadsheet\Chart\PlotArea

$plotArea

Throws

\PhpOffice\PhpSpreadsheet\Writer\Exception

Returns

array|string

writePlotSeriesValuesElement()

writePlotSeriesValuesElement(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter  $objWriter, integer  $val = 3, string  $fillColor = 'FF9900') : \PhpOffice\PhpSpreadsheet\Shared\XMLWriter

Method writing plot series values.

Parameters

\PhpOffice\PhpSpreadsheet\Shared\XMLWriter	$objWriter	XML Writer
integer	$val	value for idx (default: 3)
string	$fillColor	hex color (default: FF9900)

Returns

\PhpOffice\PhpSpreadsheet\Shared\XMLWriter —

XML Writer

writePlotGroup()

writePlotGroup(\PhpOffice\PhpSpreadsheet\Chart\DataSeries  $plotGroup, string  $groupType, \PhpOffice\PhpSpreadsheet\Shared\XMLWriter  $objWriter,   $catIsMultiLevelSeries,   $valIsMultiLevelSeries,   $plotGroupingType)

Write Plot Group (series of related plots).

Parameters

\PhpOffice\PhpSpreadsheet\Chart\DataSeries	$plotGroup
string	$groupType	Type of plot for dataseries
\PhpOffice\PhpSpreadsheet\Shared\XMLWriter	$objWriter	XML Writer
	$catIsMultiLevelSeries
	$valIsMultiLevelSeries
	$plotGroupingType

Throws

\PhpOffice\PhpSpreadsheet\Writer\Exception

writePlotSeriesLabel()

writePlotSeriesLabel(\PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues  $plotSeriesLabel, \PhpOffice\PhpSpreadsheet\Shared\XMLWriter  $objWriter)

Write Plot Series Label.

Parameters

\PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues	$plotSeriesLabel
\PhpOffice\PhpSpreadsheet\Shared\XMLWriter	$objWriter	XML Writer

writePlotSeriesValues()

writePlotSeriesValues(\PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues  $plotSeriesValues, \PhpOffice\PhpSpreadsheet\Shared\XMLWriter  $objWriter, string  $groupType, string  $dataType = 'str')

Write Plot Series Values.

Parameters

\PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues	$plotSeriesValues
\PhpOffice\PhpSpreadsheet\Shared\XMLWriter	$objWriter	XML Writer
string	$groupType	Type of plot for dataseries
string	$dataType	Datatype of series values

writeBubbles()

writeBubbles(\PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues  $plotSeriesValues, \PhpOffice\PhpSpreadsheet\Shared\XMLWriter  $objWriter)

Write Bubble Chart Details.

Parameters

\PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues	$plotSeriesValues
\PhpOffice\PhpSpreadsheet\Shared\XMLWriter	$objWriter	XML Writer

writeLayout()

writeLayout(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter  $objWriter, \PhpOffice\PhpSpreadsheet\Chart\Layout  $layout = null)

Write Layout.

Parameters

\PhpOffice\PhpSpreadsheet\Shared\XMLWriter	$objWriter	XML Writer
\PhpOffice\PhpSpreadsheet\Chart\Layout	$layout

writeAlternateContent()

writeAlternateContent(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter  $objWriter)

Write Alternate Content block.

Parameters

\PhpOffice\PhpSpreadsheet\Shared\XMLWriter

$objWriter

XML Writer

writePrintSettings()

writePrintSettings(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter  $objWriter)

Write Printer Settings.

Parameters

\PhpOffice\PhpSpreadsheet\Shared\XMLWriter

$objWriter

XML Writer