class Legend (View source)

Constants

XL_LEGEND_POSITION_BOTTOM

Legend positions

XL_LEGEND_POSITION_CORNER

XL_LEGEND_POSITION_CUSTOM

XL_LEGEND_POSITION_LEFT

XL_LEGEND_POSITION_RIGHT

XL_LEGEND_POSITION_TOP

POSITION_RIGHT

POSITION_LEFT

POSITION_BOTTOM

POSITION_TOP

POSITION_TOPRIGHT

Methods

__construct(string $position = self::POSITION_RIGHT, Layout $layout = null, bool $overlay = false)

Create a new Legend.

string
getPosition()

Get legend position as an excel string value.

bool
setPosition(string $position)

Get legend position using an excel string value.

int
getPositionXL()

Get legend position as an Excel internal numeric value.

bool
setPositionXL(int $positionXL)

Set legend position using an Excel internal numeric value.

bool
getOverlay()

Get allow overlay of other elements?

bool
setOverlay(bool $overlay)

Set allow overlay of other elements?

getLayout()

Get Layout.

Details

__construct(string $position = self::POSITION_RIGHT, Layout $layout = null, bool $overlay = false)

Create a new Legend.

Parameters

string $position
Layout $layout
bool $overlay

string getPosition()

Get legend position as an excel string value.

Return Value

string

bool setPosition(string $position)

Get legend position using an excel string value.

Parameters

string $position see self::POSITION_*

Return Value

bool

int getPositionXL()

Get legend position as an Excel internal numeric value.

Return Value

int

bool setPositionXL(int $positionXL)

Set legend position using an Excel internal numeric value.

Parameters

int $positionXL see self::XL_LEGEND_POSITION_*

Return Value

bool

bool getOverlay()

Get allow overlay of other elements?

Return Value

bool

bool setOverlay(bool $overlay)

Set allow overlay of other elements?

Parameters

bool $overlay

Return Value

bool

Layout getLayout()

Get Layout.

Return Value

Layout