Collaboration diagram for PhpOffice\PhpSpreadsheet\Chart\Layout:

Public Member Functions
	__construct (array $layout=[])
	Create a new Layout. More...

	getLayoutTarget ()
	Get Layout Target. More...

	setLayoutTarget ($value)
	Set Layout Target. More...

	getXMode ()
	Get X-Mode. More...

	setXMode ($value)
	Set X-Mode. More...

	getYMode ()
	Get Y-Mode. More...

	setYMode ($value)
	Set Y-Mode. More...

	getXPosition ()
	Get X-Position. More...

	setXPosition ($value)
	Set X-Position. More...

	getYPosition ()
	Get Y-Position. More...

	setYPosition ($value)
	Set Y-Position. More...

	getWidth ()
	Get Width. More...

	setWidth ($value)
	Set Width. More...

	getHeight ()
	Get Height. More...

	setHeight ($value)
	Set Height. More...

	getShowLegendKey ()
	Get show legend key. More...

	setShowLegendKey ($value)
	Set show legend key Specifies that legend keys should be shown in data labels. More...

	getShowVal ()
	Get show value. More...

	setShowVal ($value)
	Set show val Specifies that the value should be shown in data labels. More...

	getShowCatName ()
	Get show category name. More...

	setShowCatName ($value)
	Set show cat name Specifies that the category name should be shown in data labels. More...

	getShowSerName ()
	Get show data series name. More...

	setShowSerName ($value)
	Set show ser name Specifies that the series name should be shown in data labels. More...

	getShowPercent ()
	Get show percentage. More...

	setShowPercent ($value)
	Set show percentage Specifies that the percentage should be shown in data labels. More...

	getShowBubbleSize ()
	Get show bubble size. More...

	setShowBubbleSize ($value)
	Set show bubble size Specifies that the bubble size should be shown in data labels. More...

	getShowLeaderLines ()
	Get show leader lines. More...

	setShowLeaderLines ($value)
	Set show leader lines Specifies that leader lines should be shown in data labels. More...

Private Attributes
	$layoutTarget

	$xMode

	$yMode

	$xPos

	$yPos

	$width

	$height

	$showLegendKey

	$showVal

	$showCatName

	$showSerName

	$showPercent

	$showBubbleSize

	$showLeaderLines

Detailed Description

Definition at line 5 of file Layout.php.

Constructor & Destructor Documentation

◆ __construct()

PhpOffice\PhpSpreadsheet\Chart\Layout::__construct ( array $layout = [] )

Create a new Layout.

Definition at line 114 of file Layout.php.

    {
        if (isset($layout['layoutTarget'])) {
            $this->layoutTarget = $layout['layoutTarget'];
        }
        if (isset($layout['xMode'])) {
            $this->xMode = $layout['xMode'];
        }
        if (isset($layout['yMode'])) {
            $this->yMode = $layout['yMode'];
        }
        if (isset($layout['x'])) {
            $this->xPos = (float) $layout['x'];
        }
        if (isset($layout['y'])) {
            $this->yPos = (float) $layout['y'];
        }
        if (isset($layout['w'])) {
            $this->width = (float) $layout['w'];
        }
        if (isset($layout['h'])) {
            $this->height = (float) $layout['h'];
        }
    }

Member Function Documentation

◆ getHeight()

PhpOffice\PhpSpreadsheet\Chart\Layout::getHeight ( )

Get Height.

Returns: number

Definition at line 288 of file Layout.php.

    {
        return $this->height;
    }

References PhpOffice\PhpSpreadsheet\Chart\Layout\$height.

◆ getLayoutTarget()

PhpOffice\PhpSpreadsheet\Chart\Layout::getLayoutTarget ( )

Get Layout Target.

Returns: string

Definition at line 144 of file Layout.php.

    {
        return $this->layoutTarget;
    }

References PhpOffice\PhpSpreadsheet\Chart\Layout\$layoutTarget.

◆ getShowBubbleSize()

PhpOffice\PhpSpreadsheet\Chart\Layout::getShowBubbleSize ( )

Get show bubble size.

Returns: bool

Definition at line 437 of file Layout.php.

    {
        return $this->showBubbleSize;
    }

References PhpOffice\PhpSpreadsheet\Chart\Layout\$showBubbleSize.

◆ getShowCatName()

PhpOffice\PhpSpreadsheet\Chart\Layout::getShowCatName ( )

Get show category name.

Returns: bool

Definition at line 362 of file Layout.php.

    {
        return $this->showCatName;
    }

References PhpOffice\PhpSpreadsheet\Chart\Layout\$showCatName.

◆ getShowLeaderLines()

PhpOffice\PhpSpreadsheet\Chart\Layout::getShowLeaderLines ( )

Get show leader lines.

Returns: bool

Definition at line 462 of file Layout.php.

    {
        return $this->showLeaderLines;
    }

References PhpOffice\PhpSpreadsheet\Chart\Layout\$showLeaderLines.

◆ getShowLegendKey()

PhpOffice\PhpSpreadsheet\Chart\Layout::getShowLegendKey ( )

Get show legend key.

Returns: bool

Definition at line 312 of file Layout.php.

    {
        return $this->showLegendKey;
    }

References PhpOffice\PhpSpreadsheet\Chart\Layout\$showLegendKey.

◆ getShowPercent()

PhpOffice\PhpSpreadsheet\Chart\Layout::getShowPercent ( )

Get show percentage.

Returns: bool

Definition at line 412 of file Layout.php.

    {
        return $this->showPercent;
    }

References PhpOffice\PhpSpreadsheet\Chart\Layout\$showPercent.

◆ getShowSerName()

PhpOffice\PhpSpreadsheet\Chart\Layout::getShowSerName ( )

Get show data series name.

Returns: bool

Definition at line 387 of file Layout.php.

    {
        return $this->showSerName;
    }

References PhpOffice\PhpSpreadsheet\Chart\Layout\$showSerName.

◆ getShowVal()

PhpOffice\PhpSpreadsheet\Chart\Layout::getShowVal ( )

Get show value.

Returns: bool

Definition at line 337 of file Layout.php.

    {
        return $this->showVal;
    }

References PhpOffice\PhpSpreadsheet\Chart\Layout\$showVal.

◆ getWidth()

PhpOffice\PhpSpreadsheet\Chart\Layout::getWidth ( )

Get Width.

Returns: number

Definition at line 264 of file Layout.php.

    {
        return $this->width;
    }

References PhpOffice\PhpSpreadsheet\Chart\Layout\$width.

◆ getXMode()

PhpOffice\PhpSpreadsheet\Chart\Layout::getXMode ( )

Get X-Mode.

Returns: string

Definition at line 168 of file Layout.php.

    {
        return $this->xMode;
    }

References PhpOffice\PhpSpreadsheet\Chart\Layout\$xMode.

◆ getXPosition()

PhpOffice\PhpSpreadsheet\Chart\Layout::getXPosition ( )

Get X-Position.

Returns: number

Definition at line 216 of file Layout.php.

    {
        return $this->xPos;
    }

References PhpOffice\PhpSpreadsheet\Chart\Layout\$xPos.

◆ getYMode()

PhpOffice\PhpSpreadsheet\Chart\Layout::getYMode ( )

Get Y-Mode.

Returns: string

Definition at line 192 of file Layout.php.

    {
        return $this->yMode;
    }

References PhpOffice\PhpSpreadsheet\Chart\Layout\$yMode.

◆ getYPosition()

PhpOffice\PhpSpreadsheet\Chart\Layout::getYPosition ( )

Get Y-Position.

Returns: number

Definition at line 240 of file Layout.php.

    {
        return $this->yPos;
    }

References PhpOffice\PhpSpreadsheet\Chart\Layout\$yPos.

◆ setHeight()

PhpOffice\PhpSpreadsheet\Chart\Layout::setHeight ( $value )

Set Height.

Parameters

float $value

Returns: $this

Definition at line 300 of file Layout.php.

    {
        $this->height = $value;
 
        return $this;
    }

◆ setLayoutTarget()

PhpOffice\PhpSpreadsheet\Chart\Layout::setLayoutTarget ( $value )

Set Layout Target.

Parameters

string $value

Returns: $this

Definition at line 156 of file Layout.php.

    {
        $this->layoutTarget = $value;
 
        return $this;
    }

◆ setShowBubbleSize()

PhpOffice\PhpSpreadsheet\Chart\Layout::setShowBubbleSize ( $value )

Set show bubble size Specifies that the bubble size should be shown in data labels.

Parameters

bool $value Show bubble size

Returns: $this

Definition at line 450 of file Layout.php.

    {
        $this->showBubbleSize = $value;
 
        return $this;
    }

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xlsx\Chart\setChartAttributes().

Here is the caller graph for this function:

◆ setShowCatName()

PhpOffice\PhpSpreadsheet\Chart\Layout::setShowCatName ( $value )

Set show cat name Specifies that the category name should be shown in data labels.

Parameters

bool $value Show cat name

Returns: $this

Definition at line 375 of file Layout.php.

    {
        $this->showCatName = $value;
 
        return $this;
    }

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xlsx\Chart\setChartAttributes().

Here is the caller graph for this function:

◆ setShowLeaderLines()

PhpOffice\PhpSpreadsheet\Chart\Layout::setShowLeaderLines ( $value )

Set show leader lines Specifies that leader lines should be shown in data labels.

Parameters

bool $value Show leader lines

Returns: $this

Definition at line 475 of file Layout.php.

    {
        $this->showLeaderLines = $value;
 
        return $this;
    }

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xlsx\Chart\setChartAttributes().

Here is the caller graph for this function:

◆ setShowLegendKey()

PhpOffice\PhpSpreadsheet\Chart\Layout::setShowLegendKey ( $value )

Set show legend key Specifies that legend keys should be shown in data labels.

Parameters

bool $value Show legend key

Returns: $this

Definition at line 325 of file Layout.php.

    {
        $this->showLegendKey = $value;
 
        return $this;
    }

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xlsx\Chart\setChartAttributes().

Here is the caller graph for this function:

◆ setShowPercent()

PhpOffice\PhpSpreadsheet\Chart\Layout::setShowPercent ( $value )

Set show percentage Specifies that the percentage should be shown in data labels.

Parameters

bool $value Show percentage

Returns: $this

Definition at line 425 of file Layout.php.

    {
        $this->showPercent = $value;
 
        return $this;
    }

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xlsx\Chart\setChartAttributes().

Here is the caller graph for this function:

◆ setShowSerName()

PhpOffice\PhpSpreadsheet\Chart\Layout::setShowSerName ( $value )

Set show ser name Specifies that the series name should be shown in data labels.

Parameters

bool $value Show series name

Returns: $this

Definition at line 400 of file Layout.php.

    {
        $this->showSerName = $value;
 
        return $this;
    }

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xlsx\Chart\setChartAttributes().

Here is the caller graph for this function:

◆ setShowVal()

PhpOffice\PhpSpreadsheet\Chart\Layout::setShowVal ( $value )

Set show val Specifies that the value should be shown in data labels.

Parameters

bool $value Show val

Returns: $this

Definition at line 350 of file Layout.php.

    {
        $this->showVal = $value;
 
        return $this;
    }

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xlsx\Chart\setChartAttributes().

Here is the caller graph for this function:

◆ setWidth()

PhpOffice\PhpSpreadsheet\Chart\Layout::setWidth ( $value )

Set Width.

Parameters

float $value

Returns: $this

Definition at line 276 of file Layout.php.

    {
        $this->width = $value;
 
        return $this;
    }

◆ setXMode()

PhpOffice\PhpSpreadsheet\Chart\Layout::setXMode ( $value )

Set X-Mode.

Parameters

string $value

Returns: $this

Definition at line 180 of file Layout.php.

    {
        $this->xMode = (string) $value;
 
        return $this;
    }

◆ setXPosition()

PhpOffice\PhpSpreadsheet\Chart\Layout::setXPosition ( $value )

Set X-Position.

Parameters

float $value

Returns: $this

Definition at line 228 of file Layout.php.

    {
        $this->xPos = (float) $value;
 
        return $this;
    }

◆ setYMode()

PhpOffice\PhpSpreadsheet\Chart\Layout::setYMode ( $value )

Set Y-Mode.

Parameters

string $value

Returns: $this

Definition at line 204 of file Layout.php.

    {
        $this->yMode = (string) $value;
 
        return $this;
    }

◆ setYPosition()

PhpOffice\PhpSpreadsheet\Chart\Layout::setYPosition ( $value )

Set Y-Position.

Parameters

float $value

Returns: $this

Definition at line 252 of file Layout.php.

    {
        $this->yPos = (float) $value;
 
        return $this;
    }

Field Documentation

◆ $height

PhpOffice\PhpSpreadsheet\Chart\Layout::$height

private

Definition at line 54 of file Layout.php.

Referenced by PhpOffice\PhpSpreadsheet\Chart\Layout\getHeight().

◆ $layoutTarget

PhpOffice\PhpSpreadsheet\Chart\Layout::$layoutTarget

private

Definition at line 12 of file Layout.php.

Referenced by PhpOffice\PhpSpreadsheet\Chart\Layout\getLayoutTarget().

◆ $showBubbleSize

PhpOffice\PhpSpreadsheet\Chart\Layout::$showBubbleSize

private

Definition at line 101 of file Layout.php.

Referenced by PhpOffice\PhpSpreadsheet\Chart\Layout\getShowBubbleSize().

◆ $showCatName

PhpOffice\PhpSpreadsheet\Chart\Layout::$showCatName

private

Definition at line 78 of file Layout.php.

Referenced by PhpOffice\PhpSpreadsheet\Chart\Layout\getShowCatName().

◆ $showLeaderLines

PhpOffice\PhpSpreadsheet\Chart\Layout::$showLeaderLines

private

Definition at line 109 of file Layout.php.

Referenced by PhpOffice\PhpSpreadsheet\Chart\Layout\getShowLeaderLines().

◆ $showLegendKey

PhpOffice\PhpSpreadsheet\Chart\Layout::$showLegendKey

private

Definition at line 62 of file Layout.php.

Referenced by PhpOffice\PhpSpreadsheet\Chart\Layout\getShowLegendKey().

◆ $showPercent

PhpOffice\PhpSpreadsheet\Chart\Layout::$showPercent

private

Definition at line 94 of file Layout.php.

Referenced by PhpOffice\PhpSpreadsheet\Chart\Layout\getShowPercent().

◆ $showSerName

PhpOffice\PhpSpreadsheet\Chart\Layout::$showSerName

private

Definition at line 86 of file Layout.php.

Referenced by PhpOffice\PhpSpreadsheet\Chart\Layout\getShowSerName().

◆ $showVal

PhpOffice\PhpSpreadsheet\Chart\Layout::$showVal

private

Definition at line 70 of file Layout.php.

Referenced by PhpOffice\PhpSpreadsheet\Chart\Layout\getShowVal().

◆ $width

PhpOffice\PhpSpreadsheet\Chart\Layout::$width

private

Definition at line 47 of file Layout.php.

Referenced by PhpOffice\PhpSpreadsheet\Chart\Layout\getWidth().

◆ $xMode

PhpOffice\PhpSpreadsheet\Chart\Layout::$xMode

private

Definition at line 19 of file Layout.php.

Referenced by PhpOffice\PhpSpreadsheet\Chart\Layout\getXMode().

◆ $xPos

PhpOffice\PhpSpreadsheet\Chart\Layout::$xPos

private

Definition at line 33 of file Layout.php.

Referenced by PhpOffice\PhpSpreadsheet\Chart\Layout\getXPosition().

◆ $yMode

PhpOffice\PhpSpreadsheet\Chart\Layout::$yMode

private

Definition at line 26 of file Layout.php.

Referenced by PhpOffice\PhpSpreadsheet\Chart\Layout\getYMode().

◆ $yPos

PhpOffice\PhpSpreadsheet\Chart\Layout::$yPos

private

Definition at line 40 of file Layout.php.

Referenced by PhpOffice\PhpSpreadsheet\Chart\Layout\getYPosition().

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

libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Chart/Layout.php

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getHeight()

◆ getLayoutTarget()

◆ getShowBubbleSize()

◆ getShowCatName()

◆ getShowLeaderLines()

◆ getShowLegendKey()

◆ getShowPercent()

◆ getShowSerName()

◆ getShowVal()

◆ getWidth()

◆ getXMode()

◆ getXPosition()

◆ getYMode()

◆ getYPosition()

◆ setHeight()

◆ setLayoutTarget()

◆ setShowBubbleSize()

◆ setShowCatName()

◆ setShowLeaderLines()

◆ setShowLegendKey()

◆ setShowPercent()

◆ setShowSerName()

◆ setShowVal()

◆ setWidth()

◆ setXMode()

◆ setXPosition()

◆ setYMode()

◆ setYPosition()

Field Documentation

◆ $height

◆ $layoutTarget

◆ $showBubbleSize

◆ $showCatName

◆ $showLeaderLines

◆ $showLegendKey

◆ $showPercent

◆ $showSerName

◆ $showVal

◆ $width

◆ $xMode

◆ $xPos

◆ $yMode

◆ $yPos