Legend.php

Go to the documentation of this file.

<?php
class PHPExcel_Chart_Legend
{
        const xlLegendPositionBottom    = -4107;        //      Below the chart.
        const xlLegendPositionCorner    = 2;            //      In the upper right-hand corner of the chart border.
        const xlLegendPositionCustom    = -4161;        //      A custom position.
        const xlLegendPositionLeft              = -4131;        //      Left of the chart.
        const xlLegendPositionRight             = -4152;        //      Right of the chart.
        const xlLegendPositionTop               = -4160;        //      Above the chart.

        const POSITION_RIGHT    = 'r';
        const POSITION_LEFT             = 'l';
        const POSITION_BOTTOM   = 'b';
        const POSITION_TOP              = 't';
        const POSITION_TOPRIGHT = 'tr';

        private static $_positionXLref = array( self::xlLegendPositionBottom    => self::POSITION_BOTTOM,
                                                                                        self::xlLegendPositionCorner    => self::POSITION_TOPRIGHT,
                                                                                        self::xlLegendPositionCustom    => '??',
                                                                                        self::xlLegendPositionLeft              => self::POSITION_LEFT,
                                                                                        self::xlLegendPositionRight             => self::POSITION_RIGHT,
                                                                                        self::xlLegendPositionTop               => self::POSITION_TOP
                                                                                  );

        private $_position = self::POSITION_RIGHT;

        private $_overlay = TRUE;

        private $_layout = NULL;


        public function __construct($position = self::POSITION_RIGHT, PHPExcel_Chart_Layout $layout = NULL, $overlay = FALSE)
        {
                $this->setPosition($position);
                $this->_layout = $layout;
                $this->setOverlay($overlay);
        }

        public function getPosition() {
                return $this->_position;
        }

        public function setPosition($position = self::POSITION_RIGHT) {
                if (!in_array($position,self::$_positionXLref)) {
                        return false;
                }

                $this->_position = $position;
                return true;
        }

        public function getPositionXL() {
                return array_search($this->_position,self::$_positionXLref);
        }

        public function setPositionXL($positionXL = self::xlLegendPositionRight) {
                if (!array_key_exists($positionXL,self::$_positionXLref)) {
                        return false;
                }

                $this->_position = self::$_positionXLref[$positionXL];
                return true;
        }

        public function getOverlay() {
                return $this->_overlay;
        }

        public function setOverlay($overlay = FALSE) {
                if (!is_bool($overlay)) {
                        return false;
                }

                $this->_overlay = $overlay;
                return true;
        }

        public function getLayout() {
                return $this->_layout;
        }

}