class PHPExcel_Chart_Legend

PHPExcelChartLegend

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

Constants

xlLegendPositionBottom

Legend positions

xlLegendPositionCorner

xlLegendPositionCustom

xlLegendPositionLeft

xlLegendPositionRight

xlLegendPositionTop

POSITION_RIGHT

POSITION_LEFT

POSITION_BOTTOM

POSITION_TOP

POSITION_TOPRIGHT

Methods

__construct($position = self::POSITION_RIGHT, PHPExcel_Chart_Layout $layout = null, $overlay = false)

Create a new PHPExcelChartLegend

string
getPosition()

Get legend position as an excel string value

setPosition(string $position = self::POSITION_RIGHT)

Get legend position using an excel string value

number
getPositionXL()

Get legend position as an Excel internal numeric value

setPositionXL(number $positionXL = self::xlLegendPositionRight)

Set legend position using an Excel internal numeric value

boolean
getOverlay()

Get allow overlay of other elements?

boolean
setOverlay(boolean $overlay = false)

Set allow overlay of other elements?

Details

at line 87
__construct($position = self::POSITION_RIGHT, PHPExcel_Chart_Layout $layout = null, $overlay = false)

Create a new PHPExcelChartLegend

Parameters

$position
PHPExcel_Chart_Layout $layout
$overlay

at line 99
string getPosition()

Get legend position as an excel string value

Return Value

string

at line 109
setPosition(string $position = self::POSITION_RIGHT)

Get legend position using an excel string value

Parameters

string $position

at line 124
number getPositionXL()

Get legend position as an Excel internal numeric value

Return Value

number

at line 134
setPositionXL(number $positionXL = self::xlLegendPositionRight)

Set legend position using an Excel internal numeric value

Parameters

number $positionXL

at line 149
boolean getOverlay()

Get allow overlay of other elements?

Return Value

boolean

at line 160
boolean setOverlay(boolean $overlay = false)

Set allow overlay of other elements?

Parameters

boolean $overlay

Return Value

boolean

at line 175
PHPExcel_Chart_Layout getLayout()

Get Layout

Return Value

PHPExcel_Chart_Layout