\PHPExcel_Chart_Legend

PHPExcel_Chart_Legend

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()
getPosition()
setPosition()
getPositionXL()
setPositionXL()
getOverlay()
setOverlay()
getLayout()
No public properties found
xlLegendPositionBottom
xlLegendPositionCorner
xlLegendPositionCustom
xlLegendPositionLeft
xlLegendPositionRight
xlLegendPositionTop
POSITION_RIGHT
POSITION_LEFT
POSITION_BOTTOM
POSITION_TOP
POSITION_TOPRIGHT
No protected methods found
No protected properties found
N/A
No private methods found
$positionXLref
$position
$overlay
$layout
N/A

Constants

xlLegendPositionBottom

xlLegendPositionBottom = -4107

Legend positions

xlLegendPositionCorner

xlLegendPositionCorner = 2

xlLegendPositionCustom

xlLegendPositionCustom = -4161

xlLegendPositionLeft

xlLegendPositionLeft = -4131

xlLegendPositionRight

xlLegendPositionRight = -4152

xlLegendPositionTop

xlLegendPositionTop = -4160

POSITION_RIGHT

POSITION_RIGHT = 'r'

POSITION_LEFT

POSITION_LEFT = 'l'

POSITION_BOTTOM

POSITION_BOTTOM = 'b'

POSITION_TOP

POSITION_TOP = 't'

POSITION_TOPRIGHT

POSITION_TOPRIGHT = 'tr'

Properties

$positionXLref

$positionXLref : 

Type

$position

$position : string

Legend position

Type

string

$overlay

$overlay : boolean

Allow overlay of other elements?

Type

boolean

Methods

__construct()

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

Create a new PHPExcel_Chart_Legend

Parameters

$position
\PHPExcel_Chart_Layout $layout
$overlay

getPosition()

getPosition() : string

Get legend position as an excel string value

Returns

string

setPosition()

setPosition(string  $position = self::POSITION_RIGHT) 

Get legend position using an excel string value

Parameters

string $position

getPositionXL()

getPositionXL() : \number

Get legend position as an Excel internal numeric value

Returns

\number

setPositionXL()

setPositionXL(\number  $positionXL = self::xlLegendPositionRight) 

Set legend position using an Excel internal numeric value

Parameters

\number $positionXL

getOverlay()

getOverlay() : boolean

Get allow overlay of other elements?

Returns

boolean

setOverlay()

setOverlay(boolean  $overlay = false) : boolean

Set allow overlay of other elements?

Parameters

boolean $overlay

Returns

boolean