source: sourcecode/application/libraries/PHPExcel/Chart/DataSeries.php @ 1

<?php
/**
 * PHPExcel
 *
 * Copyright (c) 2006 - 2014 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
 *
 * @category    PHPExcel
 * @package             PHPExcel_Chart
 * @copyright   Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)
 * @license             http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt   LGPL
 * @version     1.8.0, 2014-03-02
 */


/**
 * PHPExcel_Chart_DataSeries
 *
 * @category    PHPExcel
 * @package             PHPExcel_Chart
 * @copyright   Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)
 */
class PHPExcel_Chart_DataSeries
{

        const TYPE_BARCHART                     = 'barChart';
        const TYPE_BARCHART_3D          = 'bar3DChart';
        const TYPE_LINECHART            = 'lineChart';
        const TYPE_LINECHART_3D         = 'line3DChart';
        const TYPE_AREACHART            = 'areaChart';
        const TYPE_AREACHART_3D         = 'area3DChart';
        const TYPE_PIECHART                     = 'pieChart';
        const TYPE_PIECHART_3D          = 'pie3DChart';
        const TYPE_DOUGHTNUTCHART       = 'doughnutChart';
        const TYPE_DONUTCHART           = self::TYPE_DOUGHTNUTCHART;    //      Synonym
        const TYPE_SCATTERCHART         = 'scatterChart';
        const TYPE_SURFACECHART         = 'surfaceChart';
        const TYPE_SURFACECHART_3D      = 'surface3DChart';
        const TYPE_RADARCHART           = 'radarChart';
        const TYPE_BUBBLECHART          = 'bubbleChart';
        const TYPE_STOCKCHART           = 'stockChart';
        const TYPE_CANDLECHART          = self::TYPE_STOCKCHART;           //   Synonym

        const GROUPING_CLUSTERED                        = 'clustered';
        const GROUPING_STACKED                          = 'stacked';
        const GROUPING_PERCENT_STACKED          = 'percentStacked';
        const GROUPING_STANDARD                         = 'standard';

        const DIRECTION_BAR                     = 'bar';
        const DIRECTION_HORIZONTAL      = self::DIRECTION_BAR;
        const DIRECTION_COL                     = 'col';
        const DIRECTION_COLUMN          = self::DIRECTION_COL;
        const DIRECTION_VERTICAL        = self::DIRECTION_COL;

        const STYLE_LINEMARKER          = 'lineMarker';
        const STYLE_SMOOTHMARKER        = 'smoothMarker';
        const STYLE_MARKER                      = 'marker';
        const STYLE_FILLED                      = 'filled';


        /**
         * Series Plot Type
         *
         * @var string
         */
        private $_plotType = null;

        /**
         * Plot Grouping Type
         *
         * @var boolean
         */
        private $_plotGrouping = null;

        /**
         * Plot Direction
         *
         * @var boolean
         */
        private $_plotDirection = null;

        /**
         * Plot Style
         *
         * @var string
         */
        private $_plotStyle = null;

        /**
         * Order of plots in Series
         *
         * @var array of integer
         */
        private $_plotOrder = array();

        /**
         * Plot Label
         *
         * @var array of PHPExcel_Chart_DataSeriesValues
         */
        private $_plotLabel = array();

        /**
         * Plot Category
         *
         * @var array of PHPExcel_Chart_DataSeriesValues
         */
        private $_plotCategory = array();

        /**
         * Smooth Line
         *
         * @var string
         */
        private $_smoothLine = null;

        /**
         * Plot Values
         *
         * @var array of PHPExcel_Chart_DataSeriesValues
         */
        private $_plotValues = array();

        /**
         * Create a new PHPExcel_Chart_DataSeries
         */
        public function __construct($plotType = null, $plotGrouping = null, $plotOrder = array(), $plotLabel = array(), $plotCategory = array(), $plotValues = array(), $smoothLine = null, $plotStyle = null)
        {
                $this->_plotType = $plotType;
                $this->_plotGrouping = $plotGrouping;
                $this->_plotOrder = $plotOrder;
                $keys = array_keys($plotValues);
                $this->_plotValues = $plotValues;
                if ((count($plotLabel) == 0) || (is_null($plotLabel[$keys[0]]))) {
                        $plotLabel[$keys[0]] = new PHPExcel_Chart_DataSeriesValues();
                }

                $this->_plotLabel = $plotLabel;
                if ((count($plotCategory) == 0) || (is_null($plotCategory[$keys[0]]))) {
                        $plotCategory[$keys[0]] = new PHPExcel_Chart_DataSeriesValues();
                }
                $this->_plotCategory = $plotCategory;
                $this->_smoothLine = $smoothLine;
                $this->_plotStyle = $plotStyle;
        }

        /**
         * Get Plot Type
         *
         * @return string
         */
        public function getPlotType() {
                return $this->_plotType;
        }

        /**
         * Set Plot Type
         *
         * @param string $plotType
     * @return PHPExcel_Chart_DataSeries
         */
        public function setPlotType($plotType = '') {
                $this->_plotType = $plotType;
        return $this;
        }

        /**
         * Get Plot Grouping Type
         *
         * @return string
         */
        public function getPlotGrouping() {
                return $this->_plotGrouping;
        }

        /**
         * Set Plot Grouping Type
         *
         * @param string $groupingType
     * @return PHPExcel_Chart_DataSeries
         */
        public function setPlotGrouping($groupingType = null) {
                $this->_plotGrouping = $groupingType;
        return $this;
        }

        /**
         * Get Plot Direction
         *
         * @return string
         */
        public function getPlotDirection() {
                return $this->_plotDirection;
        }

        /**
         * Set Plot Direction
         *
         * @param string $plotDirection
     * @return PHPExcel_Chart_DataSeries
         */
        public function setPlotDirection($plotDirection = null) {
                $this->_plotDirection = $plotDirection;
        return $this;
        }

        /**
         * Get Plot Order
         *
         * @return string
         */
        public function getPlotOrder() {
                return $this->_plotOrder;
        }

        /**
         * Get Plot Labels
         *
         * @return array of PHPExcel_Chart_DataSeriesValues
         */
        public function getPlotLabels() {
                return $this->_plotLabel;
        }

        /**
         * Get Plot Label by Index
         *
         * @return PHPExcel_Chart_DataSeriesValues
         */
        public function getPlotLabelByIndex($index) {
                $keys = array_keys($this->_plotLabel);
                if (in_array($index,$keys)) {
                        return $this->_plotLabel[$index];
                } elseif(isset($keys[$index])) {
                        return $this->_plotLabel[$keys[$index]];
                }
                return false;
        }

        /**
         * Get Plot Categories
         *
         * @return array of PHPExcel_Chart_DataSeriesValues
         */
        public function getPlotCategories() {
                return $this->_plotCategory;
        }

        /**
         * Get Plot Category by Index
         *
         * @return PHPExcel_Chart_DataSeriesValues
         */
        public function getPlotCategoryByIndex($index) {
                $keys = array_keys($this->_plotCategory);
                if (in_array($index,$keys)) {
                        return $this->_plotCategory[$index];
                } elseif(isset($keys[$index])) {
                        return $this->_plotCategory[$keys[$index]];
                }
                return false;
        }

        /**
         * Get Plot Style
         *
         * @return string
         */
        public function getPlotStyle() {
                return $this->_plotStyle;
        }

        /**
         * Set Plot Style
         *
         * @param string $plotStyle
     * @return PHPExcel_Chart_DataSeries
         */
        public function setPlotStyle($plotStyle = null) {
                $this->_plotStyle = $plotStyle;
        return $this;
        }

        /**
         * Get Plot Values
         *
         * @return array of PHPExcel_Chart_DataSeriesValues
         */
        public function getPlotValues() {
                return $this->_plotValues;
        }

        /**
         * Get Plot Values by Index
         *
         * @return PHPExcel_Chart_DataSeriesValues
         */
        public function getPlotValuesByIndex($index) {
                $keys = array_keys($this->_plotValues);
                if (in_array($index,$keys)) {
                        return $this->_plotValues[$index];
                } elseif(isset($keys[$index])) {
                        return $this->_plotValues[$keys[$index]];
                }
                return false;
        }

        /**
         * Get Number of Plot Series
         *
         * @return integer
         */
        public function getPlotSeriesCount() {
                return count($this->_plotValues);
        }

        /**
         * Get Smooth Line
         *
         * @return boolean
         */
        public function getSmoothLine() {
                return $this->_smoothLine;
        }

        /**
         * Set Smooth Line
         *
         * @param boolean $smoothLine
     * @return PHPExcel_Chart_DataSeries
         */
        public function setSmoothLine($smoothLine = TRUE) {
                $this->_smoothLine = $smoothLine;
        return $this;
        }

        public function refresh(PHPExcel_Worksheet $worksheet) {
            foreach($this->_plotValues as $plotValues) {
                        if ($plotValues !== NULL)
                                $plotValues->refresh($worksheet, TRUE);
                }
                foreach($this->_plotLabel as $plotValues) {
                        if ($plotValues !== NULL)
                                $plotValues->refresh($worksheet, TRUE);
                }
                foreach($this->_plotCategory as $plotValues) {
                        if ($plotValues !== NULL)
                                $plotValues->refresh($worksheet, FALSE);
                }
        }

}