PhpOffice\PhpSpreadsheet\Chart\Legend Class Reference

Collaboration diagram for PhpOffice\PhpSpreadsheet\Chart\Legend:

Public Member Functions
	__construct ($position=self::POSITION_RIGHT, ?Layout $layout=null, $overlay=false)
	Create a new Legend. More...
	getPosition ()
	Get legend position as an excel string value. More...
	setPosition ($position)
	Get legend position using an excel string value. More...
	getPositionXL ()
	Get legend position as an Excel internal numeric value. More...
	setPositionXL ($positionXL)
	Set legend position using an Excel internal numeric value. More...
	getOverlay ()
	Get allow overlay of other elements? More...
	setOverlay ($overlay)
	Set allow overlay of other elements? More...
	getLayout ()
	Get Layout. More...

Data Fields
const	XL_LEGEND_POSITION_BOTTOM = -4107
	Legend positions. More...
const	XL_LEGEND_POSITION_CORNER = 2
const	XL_LEGEND_POSITION_CUSTOM = -4161
const	XL_LEGEND_POSITION_LEFT = -4131
const	XL_LEGEND_POSITION_RIGHT = -4152
const	XL_LEGEND_POSITION_TOP = -4160
const	POSITION_RIGHT = 'r'
const	POSITION_LEFT = 'l'
const	POSITION_BOTTOM = 'b'
const	POSITION_TOP = 't'
const	POSITION_TOPRIGHT = 'tr'

Private Attributes
	$position = self::POSITION_RIGHT
	$overlay = true
	$layout

Static Private Attributes
static	$positionXLref

Detailed Description

Definition at line 5 of file Legend.php.

Constructor & Destructor Documentation

__construct()

PhpOffice\PhpSpreadsheet\Chart\Legend::__construct	(		$position = self::POSITION_RIGHT,
		?Layout	$layout = null,
			$overlay = false
	)

Create a new Legend.

Parameters

string	$position
bool	$overlay

Definition at line 57 of file Legend.php.

References PhpOffice\PhpSpreadsheet\Chart\Legend\$layout, PhpOffice\PhpSpreadsheet\Chart\Legend\$overlay, PhpOffice\PhpSpreadsheet\Chart\Legend\$position, PhpOffice\PhpSpreadsheet\Chart\Legend\setOverlay(), and PhpOffice\PhpSpreadsheet\Chart\Legend\setPosition().

    {
        $this->setPosition($position);
        $this->layout = $layout;
        $this->setOverlay($overlay);
    }

Here is the call graph for this function:

Member Function Documentation

getLayout()

PhpOffice\PhpSpreadsheet\Chart\Legend::getLayout

(

)

Get Layout.

Returns

Layout

Definition at line 145 of file Legend.php.

References PhpOffice\PhpSpreadsheet\Chart\Legend\$layout.

    {
        return $this->layout;
    }

getOverlay()

PhpOffice\PhpSpreadsheet\Chart\Legend::getOverlay

(

)

Get allow overlay of other elements?

Returns

bool

Definition at line 125 of file Legend.php.

References PhpOffice\PhpSpreadsheet\Chart\Legend\$overlay.

    {
        return $this->overlay;
    }

getPosition()

PhpOffice\PhpSpreadsheet\Chart\Legend::getPosition

(

)

Get legend position as an excel string value.

Returns

string

Definition at line 69 of file Legend.php.

References PhpOffice\PhpSpreadsheet\Chart\Legend\$position.

    {
        return $this->position;
    }

getPositionXL()

PhpOffice\PhpSpreadsheet\Chart\Legend::getPositionXL

(

)

Get legend position as an Excel internal numeric value.

Returns

int

Definition at line 97 of file Legend.php.

    {
        return array_search($this->position, self::$positionXLref);
    }

setOverlay()

PhpOffice\PhpSpreadsheet\Chart\Legend::setOverlay

(

$overlay

)

Set allow overlay of other elements?

Parameters

bool

$overlay

Definition at line 135 of file Legend.php.

References PhpOffice\PhpSpreadsheet\Chart\Legend\$overlay.

Referenced by PhpOffice\PhpSpreadsheet\Chart\Legend\__construct().

                                        : void
    {
        $this->overlay = $overlay;
    }

Here is the caller graph for this function:

setPosition()

PhpOffice\PhpSpreadsheet\Chart\Legend::setPosition

(

$position

)

Get legend position using an excel string value.

Parameters

string

$position

see self::POSITION_*

Returns

bool

Definition at line 81 of file Legend.php.

References PhpOffice\PhpSpreadsheet\Chart\Legend\$position.

Referenced by PhpOffice\PhpSpreadsheet\Chart\Legend\__construct().

    {
        if (!in_array($position, self::$positionXLref)) {
            return false;
        }

        $this->position = $position;

        return true;
    }

Here is the caller graph for this function:

setPositionXL()

PhpOffice\PhpSpreadsheet\Chart\Legend::setPositionXL

(

$positionXL

)

Set legend position using an Excel internal numeric value.

Parameters

int

$positionXL

see self::XL_LEGEND_POSITION_*

Returns

bool

Definition at line 109 of file Legend.php.

    {
        if (!isset(self::$positionXLref[$positionXL])) {
            return false;
        }

        $this->position = self::$positionXLref[$positionXL];

        return true;
    }

Field Documentation

$layout

PhpOffice\PhpSpreadsheet\Chart\Legend::$layout

private

Definition at line 49 of file Legend.php.

Referenced by PhpOffice\PhpSpreadsheet\Chart\Legend\__construct(), and PhpOffice\PhpSpreadsheet\Chart\Legend\getLayout().

$overlay

PhpOffice\PhpSpreadsheet\Chart\Legend::$overlay = true

private

Definition at line 42 of file Legend.php.

Referenced by PhpOffice\PhpSpreadsheet\Chart\Legend\__construct(), PhpOffice\PhpSpreadsheet\Chart\Legend\getOverlay(), and PhpOffice\PhpSpreadsheet\Chart\Legend\setOverlay().

$position

PhpOffice\PhpSpreadsheet\Chart\Legend::$position = self::POSITION_RIGHT

private

Definition at line 35 of file Legend.php.

Referenced by PhpOffice\PhpSpreadsheet\Chart\Legend\__construct(), PhpOffice\PhpSpreadsheet\Chart\Legend\getPosition(), and PhpOffice\PhpSpreadsheet\Chart\Legend\setPosition().

$positionXLref

PhpOffice\PhpSpreadsheet\Chart\Legend::$positionXLref

staticprivate

Initial value:

= [
        self::XL_LEGEND_POSITION_BOTTOM => self::POSITION_BOTTOM

Definition at line 21 of file Legend.php.

POSITION_BOTTOM

const PhpOffice\PhpSpreadsheet\Chart\Legend::POSITION_BOTTOM = 'b'

Definition at line 17 of file Legend.php.

POSITION_LEFT

const PhpOffice\PhpSpreadsheet\Chart\Legend::POSITION_LEFT = 'l'

Definition at line 16 of file Legend.php.

POSITION_RIGHT

const PhpOffice\PhpSpreadsheet\Chart\Legend::POSITION_RIGHT = 'r'

Definition at line 15 of file Legend.php.

POSITION_TOP

const PhpOffice\PhpSpreadsheet\Chart\Legend::POSITION_TOP = 't'

Definition at line 18 of file Legend.php.

POSITION_TOPRIGHT

const PhpOffice\PhpSpreadsheet\Chart\Legend::POSITION_TOPRIGHT = 'tr'

Definition at line 19 of file Legend.php.

XL_LEGEND_POSITION_BOTTOM

const PhpOffice\PhpSpreadsheet\Chart\Legend::XL_LEGEND_POSITION_BOTTOM = -4107

Legend positions.

Definition at line 8 of file Legend.php.

XL_LEGEND_POSITION_CORNER

const PhpOffice\PhpSpreadsheet\Chart\Legend::XL_LEGEND_POSITION_CORNER = 2

Definition at line 9 of file Legend.php.

XL_LEGEND_POSITION_CUSTOM

const PhpOffice\PhpSpreadsheet\Chart\Legend::XL_LEGEND_POSITION_CUSTOM = -4161

Definition at line 10 of file Legend.php.

XL_LEGEND_POSITION_LEFT

const PhpOffice\PhpSpreadsheet\Chart\Legend::XL_LEGEND_POSITION_LEFT = -4131

Definition at line 11 of file Legend.php.

XL_LEGEND_POSITION_RIGHT

const PhpOffice\PhpSpreadsheet\Chart\Legend::XL_LEGEND_POSITION_RIGHT = -4152

Definition at line 12 of file Legend.php.

XL_LEGEND_POSITION_TOP

const PhpOffice\PhpSpreadsheet\Chart\Legend::XL_LEGEND_POSITION_TOP = -4160

Definition at line 13 of file Legend.php.

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Chart/Legend.php