class 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

Methods

__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

string
getName()

Get Name

setWorksheet(PHPExcel_Worksheet $pValue = null)

Set Worksheet

getXAxisLabel()

Get X-Axis Label

getYAxisLabel()

Get Y-Axis Label

boolean
getPlotVisibleOnly()

Get Plot Visible Only

setPlotVisibleOnly(boolean $plotVisibleOnly = true)

Set Plot Visible Only

string
getDisplayBlanksAs()

Get Display Blanks as

setDisplayBlanksAs(string $displayBlanksAs = '0')

Set Display Blanks as

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

Set the Top Left position for the chart

array
getTopLeftPosition()

Get the top left position of the chart

string
getTopLeftCell()

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

setTopLeftCell(string $cell)

Set the Top Left cell position for the chart

setTopLeftOffset(integer $xOffset = null, integer $yOffset = null)

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

integer[]
getTopLeftOffset()

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

setTopLeftXOffset($xOffset)

No description

getTopLeftXOffset()

No description

setTopLeftYOffset($yOffset)

No description

getTopLeftYOffset()

No description

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

Set the Bottom Right position of the chart

array
getBottomRightPosition()

Get the bottom right position of the chart

setBottomRightCell($cell)

No description

string
getBottomRightCell()

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

setBottomRightOffset(integer $xOffset = null, integer $yOffset = null)

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

integer[]
getBottomRightOffset()

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

setBottomRightXOffset($xOffset)

No description

getBottomRightXOffset()

No description

setBottomRightYOffset($yOffset)

No description

getBottomRightYOffset()

No description

refresh()

No description

render($outputDestination = null)

No description

Details

at line 181
__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

at line 202
string getName()

Get Name

Return Value

string

at line 212
PHPExcel_Worksheet getWorksheet()

Get Worksheet

Return Value

PHPExcel_Worksheet

at line 224
PHPExcel_Chart setWorksheet(PHPExcel_Worksheet $pValue = null)

Set Worksheet

Parameters

PHPExcel_Worksheet $pValue

Return Value

PHPExcel_Chart

Exceptions

PHPExcel_Chart_Exception

at line 236
PHPExcel_Chart_Title getTitle()

Get Title

Return Value

PHPExcel_Chart_Title

at line 247
PHPExcel_Chart setTitle(PHPExcel_Chart_Title $title)

Set Title

Parameters

PHPExcel_Chart_Title $title

Return Value

PHPExcel_Chart

at line 259
PHPExcel_Chart_Legend getLegend()

Get Legend

Return Value

PHPExcel_Chart_Legend

at line 270
PHPExcel_Chart setLegend(PHPExcel_Chart_Legend $legend)

Set Legend

Parameters

PHPExcel_Chart_Legend $legend

Return Value

PHPExcel_Chart

at line 282
PHPExcel_Chart_Title getXAxisLabel()

Get X-Axis Label

Return Value

PHPExcel_Chart_Title

at line 293
PHPExcel_Chart setXAxisLabel(PHPExcel_Chart_Title $label)

Set X-Axis Label

Parameters

PHPExcel_Chart_Title $label

Return Value

PHPExcel_Chart

at line 305
PHPExcel_Chart_Title getYAxisLabel()

Get Y-Axis Label

Return Value

PHPExcel_Chart_Title

at line 316
PHPExcel_Chart setYAxisLabel(PHPExcel_Chart_Title $label)

Set Y-Axis Label

Parameters

PHPExcel_Chart_Title $label

Return Value

PHPExcel_Chart

at line 328
PHPExcel_Chart_PlotArea getPlotArea()

Get Plot Area

at line 338
boolean getPlotVisibleOnly()

Get Plot Visible Only

Return Value

boolean

at line 349
PHPExcel_Chart setPlotVisibleOnly(boolean $plotVisibleOnly = true)

Set Plot Visible Only

Parameters

boolean $plotVisibleOnly

Return Value

PHPExcel_Chart

at line 361
string getDisplayBlanksAs()

Get Display Blanks as

Return Value

string

at line 372
PHPExcel_Chart setDisplayBlanksAs(string $displayBlanksAs = '0')

Set Display Blanks as

Parameters

string $displayBlanksAs

Return Value

PHPExcel_Chart

at line 383
PHPExcel_Chart_Axis getChartAxisY()

Get yAxis

Return Value

PHPExcel_Chart_Axis

at line 397
PHPExcel_Chart_Axis getChartAxisX()

Get xAxis

Return Value

PHPExcel_Chart_Axis

at line 411
PHPExcel_Chart_GridLines getMajorGridlines()

Get Major Gridlines

at line 425
PHPExcel_Chart_GridLines getMinorGridlines()

Get Minor Gridlines

at line 443
PHPExcel_Chart setTopLeftPosition(string $cell, integer $xOffset = null, integer $yOffset = null)

Set the Top Left position for the chart

Parameters

string $cell
integer $xOffset
integer $yOffset

Return Value

PHPExcel_Chart

at line 461
array getTopLeftPosition()

Get the top left position of the chart

Return Value

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

at line 475
string getTopLeftCell()

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

Return Value

string

at line 486
PHPExcel_Chart setTopLeftCell(string $cell)

Set the Top Left cell position for the chart

Parameters

string $cell

Return Value

PHPExcel_Chart

at line 500
PHPExcel_Chart setTopLeftOffset(integer $xOffset = null, integer $yOffset = null)

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

Parameters

integer $xOffset
integer $yOffset

Return Value

PHPExcel_Chart

at line 517
integer[] getTopLeftOffset()

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

Return Value

integer[]

at line 525
setTopLeftXOffset($xOffset)

Parameters

$xOffset

at line 532
getTopLeftXOffset()

at line 537
setTopLeftYOffset($yOffset)

Parameters

$yOffset

at line 544
getTopLeftYOffset()

at line 557
PHPExcel_Chart setBottomRightPosition(string $cell, integer $xOffset = null, integer $yOffset = null)

Set the Bottom Right position of the chart

Parameters

string $cell
integer $xOffset
integer $yOffset

Return Value

PHPExcel_Chart

at line 575
array getBottomRightPosition()

Get the bottom right position of the chart

Return Value

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

at line 584
setBottomRightCell($cell)

Parameters

$cell

at line 596
string getBottomRightCell()

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

Return Value

string

at line 608
PHPExcel_Chart setBottomRightOffset(integer $xOffset = null, integer $yOffset = null)

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

Parameters

integer $xOffset
integer $yOffset

Return Value

PHPExcel_Chart

at line 625
integer[] getBottomRightOffset()

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

Return Value

integer[]

at line 633
setBottomRightXOffset($xOffset)

Parameters

$xOffset

at line 640
getBottomRightXOffset()

at line 645
setBottomRightYOffset($yOffset)

Parameters

$yOffset

at line 652
getBottomRightYOffset()

at line 658
refresh()

at line 665
render($outputDestination = null)

Parameters

$outputDestination