\PHPExcel_Chart

PHPExcel_Chart

Copyright (c) 2006 - 2015 PHPExcel

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

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

Properties

$name

$name : string

Chart Name

Type

string

$plotVisibleOnly

$plotVisibleOnly : boolean

Plot Visible Only

Type

boolean

$displayBlanksAs

$displayBlanksAs : string

Display Blanks as

Type

string

$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(  $name, \PHPExcel_Chart_Title  $title = null, \PHPExcel_Chart_Legend  $legend = null, \PHPExcel_Chart_PlotArea  $plotArea = null,   $plotVisibleOnly = true,   $displayBlanksAs = '0', \PHPExcel_Chart_Title  $xAxisLabel = null, \PHPExcel_Chart_Title  $yAxisLabel = null, \PHPExcel_Chart_Axis  $xAxis = null, \PHPExcel_Chart_Axis  $yAxis = null, \PHPExcel_Chart_GridLines  $majorGridlines = null, \PHPExcel_Chart_GridLines  $minorGridlines = null) 

Create a new PHPExcel_Chart

Parameters

$name
\PHPExcel_Chart_Title $title
\PHPExcel_Chart_Legend $legend
\PHPExcel_Chart_PlotArea $plotArea
$plotVisibleOnly
$displayBlanksAs
\PHPExcel_Chart_Title $xAxisLabel
\PHPExcel_Chart_Title $yAxisLabel
\PHPExcel_Chart_Axis $xAxis
\PHPExcel_Chart_Axis $yAxis
\PHPExcel_Chart_GridLines $majorGridlines
\PHPExcel_Chart_GridLines $minorGridlines

getName()

getName() : string

Get Name

Returns

string

getWorksheet()

getWorksheet() : \PHPExcel_Worksheet

Get Worksheet

Returns

\PHPExcel_Worksheet

setWorksheet()

setWorksheet(\PHPExcel_Worksheet  $pValue = null) : \PHPExcel_Chart

Set Worksheet

Parameters

\PHPExcel_Worksheet $pValue

Throws

\PHPExcel_Chart_Exception

Returns

\PHPExcel_Chart

getPlotVisibleOnly()

getPlotVisibleOnly() : boolean

Get Plot Visible Only

Returns

boolean

setPlotVisibleOnly()

setPlotVisibleOnly(boolean  $plotVisibleOnly = true) : \PHPExcel_Chart

Set Plot Visible Only

Parameters

boolean $plotVisibleOnly

Returns

\PHPExcel_Chart

getDisplayBlanksAs()

getDisplayBlanksAs() : string

Get Display Blanks as

Returns

string

setDisplayBlanksAs()

setDisplayBlanksAs(string  $displayBlanksAs = '0') : \PHPExcel_Chart

Set Display Blanks as

Parameters

string $displayBlanksAs

Returns

\PHPExcel_Chart

setTopLeftPosition()

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

Set the Top Left position for the chart

Parameters

string $cell
integer $xOffset
integer $yOffset

Returns

\PHPExcel_Chart

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) : \PHPExcel_Chart

Set the Top Left cell position for the chart

Parameters

string $cell

Returns

\PHPExcel_Chart

setTopLeftOffset()

setTopLeftOffset(integer  $xOffset = null, integer  $yOffset = null) : \PHPExcel_Chart

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

Parameters

integer $xOffset
integer $yOffset

Returns

\PHPExcel_Chart

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) : \PHPExcel_Chart

Set the Bottom Right position of the chart

Parameters

string $cell
integer $xOffset
integer $yOffset

Returns

\PHPExcel_Chart

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 = null, integer  $yOffset = null) : \PHPExcel_Chart

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

Parameters

integer $xOffset
integer $yOffset

Returns

\PHPExcel_Chart

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(  $outputDestination = null) 

Parameters

$outputDestination