\PhpOffice\PhpSpreadsheet\ChartChart

Summary

Methods

Properties

Constants

__construct()
getName()
getWorksheet()
setWorksheet()
getTitle()
setTitle()
getLegend()
setLegend()
getXAxisLabel()
setXAxisLabel()
getYAxisLabel()
setYAxisLabel()
getPlotArea()
getPlotVisibleOnly()
setPlotVisibleOnly()
getDisplayBlanksAs()
setDisplayBlanksAs()
getChartAxisY()
getChartAxisX()
getMajorGridlines()
getMinorGridlines()
setTopLeftPosition()
getTopLeftPosition()
getTopLeftCell()
setTopLeftCell()
setTopLeftOffset()
getTopLeftOffset()
setTopLeftXOffset()
getTopLeftXOffset()
setTopLeftYOffset()
getTopLeftYOffset()
setBottomRightPosition()
getBottomRightPosition()
setBottomRightCell()
getBottomRightCell()
setBottomRightOffset()
getBottomRightOffset()
setBottomRightXOffset()
getBottomRightXOffset()
setBottomRightYOffset()
getBottomRightYOffset()
refresh()
render()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

$name
$worksheet
$title
$legend
$xAxisLabel
$yAxisLabel
$plotArea
$plotVisibleOnly
$displayBlanksAs
$yAxis
$xAxis
$majorGridlines
$minorGridlines
$topLeftCellRef
$topLeftXOffset
$topLeftYOffset
$bottomRightCellRef
$bottomRightXOffset
$bottomRightYOffset

N/A

File: vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Chart/Chart.php
Package: Default
Class hierarchy: \PhpOffice\PhpSpreadsheet\Chart\Chart

Properties

$name

$name : string

Chart Name.

Type

string

$worksheet

$worksheet : \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet

Worksheet.

Type

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet

$title

$title : \PhpOffice\PhpSpreadsheet\Chart\Title

Chart Title.

Type

\PhpOffice\PhpSpreadsheet\Chart\Title

$legend

$legend : \PhpOffice\PhpSpreadsheet\Chart\Legend

Chart Legend.

Type

\PhpOffice\PhpSpreadsheet\Chart\Legend

$xAxisLabel

$xAxisLabel : \PhpOffice\PhpSpreadsheet\Chart\Title

X-Axis Label.

Type

\PhpOffice\PhpSpreadsheet\Chart\Title

$yAxisLabel

$yAxisLabel : \PhpOffice\PhpSpreadsheet\Chart\Title

Y-Axis Label.

Type

\PhpOffice\PhpSpreadsheet\Chart\Title

$plotArea

$plotArea : \PhpOffice\PhpSpreadsheet\Chart\PlotArea

Chart Plot Area.

Type

\PhpOffice\PhpSpreadsheet\Chart\PlotArea

$plotVisibleOnly

$plotVisibleOnly : boolean

Plot Visible Only.

Type

boolean

$displayBlanksAs

$displayBlanksAs : string

Display Blanks as.

Type

string

$yAxis

$yAxis : \PhpOffice\PhpSpreadsheet\Chart\Axis

Chart Asix Y as.

Type

\PhpOffice\PhpSpreadsheet\Chart\Axis

$xAxis

$xAxis : \PhpOffice\PhpSpreadsheet\Chart\Axis

Chart Asix X as.

Type

\PhpOffice\PhpSpreadsheet\Chart\Axis

$majorGridlines

$majorGridlines : \PhpOffice\PhpSpreadsheet\Chart\GridLines

Chart Major Gridlines as.

Type

\PhpOffice\PhpSpreadsheet\Chart\GridLines

$minorGridlines

$minorGridlines : \PhpOffice\PhpSpreadsheet\Chart\GridLines

Chart Minor Gridlines as.

Type

\PhpOffice\PhpSpreadsheet\Chart\GridLines

$topLeftCellRef

$topLeftCellRef : string

Top-Left Cell Position.

Type

string

$topLeftXOffset

$topLeftXOffset : integer

Top-Left X-Offset.

Type

integer

$topLeftYOffset

$topLeftYOffset : integer

Top-Left Y-Offset.

Type

integer

$bottomRightCellRef

$bottomRightCellRef : string

Bottom-Right Cell Position.

Type

string

$bottomRightXOffset

$bottomRightXOffset : integer

Bottom-Right X-Offset.

Type

integer

$bottomRightYOffset

$bottomRightYOffset : integer

Bottom-Right Y-Offset.

Type

integer

Methods

__construct()

__construct(mixed  $name, null|\PhpOffice\PhpSpreadsheet\Chart\Title  $title = null, null|\PhpOffice\PhpSpreadsheet\Chart\Legend  $legend = null, null|\PhpOffice\PhpSpreadsheet\Chart\PlotArea  $plotArea = null, mixed  $plotVisibleOnly = true, mixed  $displayBlanksAs = 'gap', null|\PhpOffice\PhpSpreadsheet\Chart\Title  $xAxisLabel = null, null|\PhpOffice\PhpSpreadsheet\Chart\Title  $yAxisLabel = null, null|\PhpOffice\PhpSpreadsheet\Chart\Axis  $xAxis = null, null|\PhpOffice\PhpSpreadsheet\Chart\Axis  $yAxis = null, null|\PhpOffice\PhpSpreadsheet\Chart\GridLines  $majorGridlines = null, null|\PhpOffice\PhpSpreadsheet\Chart\GridLines  $minorGridlines = null)

Create a new Chart.

Parameters

mixed	$name
null\|\PhpOffice\PhpSpreadsheet\Chart\Title	$title
null\|\PhpOffice\PhpSpreadsheet\Chart\Legend	$legend
null\|\PhpOffice\PhpSpreadsheet\Chart\PlotArea	$plotArea
mixed	$plotVisibleOnly
mixed	$displayBlanksAs
null\|\PhpOffice\PhpSpreadsheet\Chart\Title	$xAxisLabel
null\|\PhpOffice\PhpSpreadsheet\Chart\Title	$yAxisLabel
null\|\PhpOffice\PhpSpreadsheet\Chart\Axis	$xAxis
null\|\PhpOffice\PhpSpreadsheet\Chart\Axis	$yAxis
null\|\PhpOffice\PhpSpreadsheet\Chart\GridLines	$majorGridlines
null\|\PhpOffice\PhpSpreadsheet\Chart\GridLines	$minorGridlines

getName()

getName() : string

Get Name.

Returns

string

getWorksheet()

getWorksheet() : \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet

Get Worksheet.

Returns

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet

setWorksheet()

setWorksheet(\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $pValue = null) : $this

Set Worksheet.

Parameters

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet

$pValue

Returns

$this

getTitle()

getTitle() : \PhpOffice\PhpSpreadsheet\Chart\Title

Get Title.

Returns

\PhpOffice\PhpSpreadsheet\Chart\Title

setTitle()

setTitle(\PhpOffice\PhpSpreadsheet\Chart\Title  $title) : $this

Set Title.

Parameters

\PhpOffice\PhpSpreadsheet\Chart\Title

$title

Returns

$this

getLegend()

getLegend() : \PhpOffice\PhpSpreadsheet\Chart\Legend

Get Legend.

Returns

\PhpOffice\PhpSpreadsheet\Chart\Legend

setLegend()

setLegend(\PhpOffice\PhpSpreadsheet\Chart\Legend  $legend) : $this

Set Legend.

Parameters

\PhpOffice\PhpSpreadsheet\Chart\Legend

$legend

Returns

$this

getXAxisLabel()

getXAxisLabel() : \PhpOffice\PhpSpreadsheet\Chart\Title

Get X-Axis Label.

Returns

\PhpOffice\PhpSpreadsheet\Chart\Title

setXAxisLabel()

setXAxisLabel(\PhpOffice\PhpSpreadsheet\Chart\Title  $label) : $this

Set X-Axis Label.

Parameters

\PhpOffice\PhpSpreadsheet\Chart\Title

$label

Returns

$this

getYAxisLabel()

getYAxisLabel() : \PhpOffice\PhpSpreadsheet\Chart\Title

Get Y-Axis Label.

Returns

\PhpOffice\PhpSpreadsheet\Chart\Title

setYAxisLabel()

setYAxisLabel(\PhpOffice\PhpSpreadsheet\Chart\Title  $label) : $this

Set Y-Axis Label.

Parameters

\PhpOffice\PhpSpreadsheet\Chart\Title

$label

Returns

$this

getPlotArea()

getPlotArea() : \PhpOffice\PhpSpreadsheet\Chart\PlotArea

Get Plot Area.

Returns

\PhpOffice\PhpSpreadsheet\Chart\PlotArea

getPlotVisibleOnly()

getPlotVisibleOnly() : boolean

Get Plot Visible Only.

Returns

boolean

setPlotVisibleOnly()

setPlotVisibleOnly(boolean  $plotVisibleOnly) : $this

Set Plot Visible Only.

Parameters

boolean

$plotVisibleOnly

Returns

$this

getDisplayBlanksAs()

getDisplayBlanksAs() : string

Get Display Blanks as.

Returns

string

setDisplayBlanksAs()

setDisplayBlanksAs(string  $displayBlanksAs) : $this

Set Display Blanks as.

Parameters

string

$displayBlanksAs

Returns

$this

getChartAxisY()

getChartAxisY() : \PhpOffice\PhpSpreadsheet\Chart\Axis

Get yAxis.

Returns

\PhpOffice\PhpSpreadsheet\Chart\Axis

getChartAxisX()

getChartAxisX() : \PhpOffice\PhpSpreadsheet\Chart\Axis

Get xAxis.

Returns

\PhpOffice\PhpSpreadsheet\Chart\Axis

getMajorGridlines()

getMajorGridlines() : \PhpOffice\PhpSpreadsheet\Chart\GridLines

Get Major Gridlines.

Returns

\PhpOffice\PhpSpreadsheet\Chart\GridLines

getMinorGridlines()

getMinorGridlines() : \PhpOffice\PhpSpreadsheet\Chart\GridLines

Get Minor Gridlines.

Returns

\PhpOffice\PhpSpreadsheet\Chart\GridLines

setTopLeftPosition()

setTopLeftPosition(string  $cell, integer  $xOffset = null, integer  $yOffset = null) : $this

Set the Top Left position for the chart.

Parameters

string	$cell
integer	$xOffset
integer	$yOffset

Returns

$this

getTopLeftPosition()

getTopLeftPosition() : array

Get the top left position of the chart.

Returns

array —

an associative array containing the cell address, X-Offset and Y-Offset from the top left of that cell

getTopLeftCell()

getTopLeftCell() : string

Get the cell address where the top left of the chart is fixed.

Returns

string

setTopLeftCell()

setTopLeftCell(string  $cell) : $this

Set the Top Left cell position for the chart.

Parameters

string

$cell

Returns

$this

setTopLeftOffset()

setTopLeftOffset(integer  $xOffset, integer  $yOffset) : $this

Set the offset position within the Top Left cell for the chart.

Parameters

integer	$xOffset
integer	$yOffset

Returns

$this

getTopLeftOffset()

getTopLeftOffset() : array<mixed,integer>

Get the offset position within the Top Left cell for the chart.

Returns

array<mixed,integer>

setTopLeftXOffset()

setTopLeftXOffset(  $xOffset)

Parameters

$xOffset

getTopLeftXOffset()

getTopLeftXOffset()

setTopLeftYOffset()

setTopLeftYOffset(  $yOffset)

Parameters

$yOffset

getTopLeftYOffset()

getTopLeftYOffset()

setBottomRightPosition()

setBottomRightPosition(string  $cell, integer  $xOffset = null, integer  $yOffset = null) : $this

Set the Bottom Right position of the chart.

Parameters

string	$cell
integer	$xOffset
integer	$yOffset

Returns

$this

getBottomRightPosition()

getBottomRightPosition() : array

Get the bottom right position of the chart.

Returns

array —

an associative array containing the cell address, X-Offset and Y-Offset from the top left of that cell

setBottomRightCell()

setBottomRightCell(  $cell)

Parameters

$cell

getBottomRightCell()

getBottomRightCell() : string

Get the cell address where the bottom right of the chart is fixed.

Returns

string

setBottomRightOffset()

setBottomRightOffset(integer  $xOffset, integer  $yOffset) : $this

Set the offset position within the Bottom Right cell for the chart.

Parameters

integer	$xOffset
integer	$yOffset

Returns

$this

getBottomRightOffset()

getBottomRightOffset() : array<mixed,integer>

Get the offset position within the Bottom Right cell for the chart.

Returns

array<mixed,integer>

setBottomRightXOffset()

setBottomRightXOffset(  $xOffset)

Parameters

$xOffset

getBottomRightXOffset()

getBottomRightXOffset()

setBottomRightYOffset()

setBottomRightYOffset(  $yOffset)

Parameters

$yOffset

getBottomRightYOffset()

getBottomRightYOffset()

refresh()

refresh()

render()

render(string  $outputDestination = null) : boolean

Render the chart to given file (or stream).

Parameters

string

$outputDestination

Name of the file render to

Returns

boolean —

true on success