You are here

Home » API reference » Loft Data Grids 7.2 » Chart.php

class PHPExcel_Chart in Loft Data Grids 7.2

Same name and namespace in other branches
  1. 6.2 vendor/phpoffice/phpexcel/Classes/PHPExcel/Chart.php \PHPExcel_Chart

PHPExcel_Chart

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

Hierarchy

Expanded class hierarchy of PHPExcel_Chart

File

vendor/phpoffice/phpexcel/Classes/PHPExcel/Chart.php, line 36

View source 
class PHPExcel_Chart {

  /**
   * Chart Name
   *
   * @var string
   */
  private $_name = '';

  /**
   * Worksheet
   *
   * @var PHPExcel_Worksheet
   */
  private $_worksheet = null;

  /**
   * Chart Title
   *
   * @var PHPExcel_Chart_Title
   */
  private $_title = null;

  /**
   * Chart Legend
   *
   * @var PHPExcel_Chart_Legend
   */
  private $_legend = null;

  /**
   * X-Axis Label
   *
   * @var PHPExcel_Chart_Title
   */
  private $_xAxisLabel = null;

  /**
   * Y-Axis Label
   *
   * @var PHPExcel_Chart_Title
   */
  private $_yAxisLabel = null;

  /**
   * Chart Plot Area
   *
   * @var PHPExcel_Chart_PlotArea
   */
  private $_plotArea = null;

  /**
   * Plot Visible Only
   *
   * @var boolean
   */
  private $_plotVisibleOnly = true;

  /**
   * Display Blanks as
   *
   * @var string
   */
  private $_displayBlanksAs = '0';

  /**
   * Chart Asix Y as
   *
   * @var PHPExcel_Chart_Axis
   */
  private $_yAxis = null;

  /**
   * Chart Asix X as
   *
   * @var PHPExcel_Chart_Axis
   */
  private $_xAxis = null;

  /**
   * Chart Major Gridlines as
   *
   * @var PHPExcel_Chart_GridLines
   */
  private $_majorGridlines = null;

  /**
   * Chart Minor Gridlines as
   *
   * @var PHPExcel_Chart_GridLines
   */
  private $_minorGridlines = null;

  /**
   * Top-Left Cell Position
   *
   * @var string
   */
  private $_topLeftCellRef = 'A1';

  /**
   * Top-Left X-Offset
   *
   * @var integer
   */
  private $_topLeftXOffset = 0;

  /**
   * Top-Left Y-Offset
   *
   * @var integer
   */
  private $_topLeftYOffset = 0;

  /**
   * Bottom-Right Cell Position
   *
   * @var string
   */
  private $_bottomRightCellRef = 'A1';

  /**
   * Bottom-Right X-Offset
   *
   * @var integer
   */
  private $_bottomRightXOffset = 10;

  /**
   * Bottom-Right Y-Offset
   *
   * @var integer
   */
  private $_bottomRightYOffset = 10;

  /**
   * Create a new PHPExcel_Chart
   */
  public function __construct($name, PHPExcel_Chart_Title $title = null, PHPExcel_Chart_Legend $legend = null, PHPExcel_Chart_PlotArea $plotArea = null, $plotVisibleOnly = true, $displayBlanksAs = '0', PHPExcel_Chart_Title $xAxisLabel = null, PHPExcel_Chart_Title $yAxisLabel = null, PHPExcel_Chart_Axis $xAxis = null, PHPExcel_Chart_Axis $yAxis = null, PHPExcel_Chart_GridLines $majorGridlines = null, PHPExcel_Chart_GridLines $minorGridlines = null) {
    $this->_name = $name;
    $this->_title = $title;
    $this->_legend = $legend;
    $this->_xAxisLabel = $xAxisLabel;
    $this->_yAxisLabel = $yAxisLabel;
    $this->_plotArea = $plotArea;
    $this->_plotVisibleOnly = $plotVisibleOnly;
    $this->_displayBlanksAs = $displayBlanksAs;
    $this->_xAxis = $xAxis;
    $this->_yAxis = $yAxis;
    $this->_majorGridlines = $majorGridlines;
    $this->_minorGridlines = $minorGridlines;
  }

  /**
   * Get Name
   *
   * @return string
   */
  public function getName() {
    return $this->_name;
  }

  /**
   * Get Worksheet
   *
   * @return PHPExcel_Worksheet
   */
  public function getWorksheet() {
    return $this->_worksheet;
  }

  /**
   * Set Worksheet
   *
   * @param	PHPExcel_Worksheet	$pValue
   * @throws	PHPExcel_Chart_Exception
   * @return PHPExcel_Chart
   */
  public function setWorksheet(PHPExcel_Worksheet $pValue = null) {
    $this->_worksheet = $pValue;
    return $this;
  }

  /**
   * Get Title
   *
   * @return PHPExcel_Chart_Title
   */
  public function getTitle() {
    return $this->_title;
  }

  /**
   * Set Title
   *
   * @param	PHPExcel_Chart_Title $title
   * @return	PHPExcel_Chart
   */
  public function setTitle(PHPExcel_Chart_Title $title) {
    $this->_title = $title;
    return $this;
  }

  /**
   * Get Legend
   *
   * @return PHPExcel_Chart_Legend
   */
  public function getLegend() {
    return $this->_legend;
  }

  /**
   * Set Legend
   *
   * @param	PHPExcel_Chart_Legend $legend
   * @return	PHPExcel_Chart
   */
  public function setLegend(PHPExcel_Chart_Legend $legend) {
    $this->_legend = $legend;
    return $this;
  }

  /**
   * Get X-Axis Label
   *
   * @return PHPExcel_Chart_Title
   */
  public function getXAxisLabel() {
    return $this->_xAxisLabel;
  }

  /**
   * Set X-Axis Label
   *
   * @param	PHPExcel_Chart_Title $label
   * @return	PHPExcel_Chart
   */
  public function setXAxisLabel(PHPExcel_Chart_Title $label) {
    $this->_xAxisLabel = $label;
    return $this;
  }

  /**
   * Get Y-Axis Label
   *
   * @return PHPExcel_Chart_Title
   */
  public function getYAxisLabel() {
    return $this->_yAxisLabel;
  }

  /**
   * Set Y-Axis Label
   *
   * @param	PHPExcel_Chart_Title $label
   * @return	PHPExcel_Chart
   */
  public function setYAxisLabel(PHPExcel_Chart_Title $label) {
    $this->_yAxisLabel = $label;
    return $this;
  }

  /**
   * Get Plot Area
   *
   * @return PHPExcel_Chart_PlotArea
   */
  public function getPlotArea() {
    return $this->_plotArea;
  }

  /**
   * Get Plot Visible Only
   *
   * @return boolean
   */
  public function getPlotVisibleOnly() {
    return $this->_plotVisibleOnly;
  }

  /**
   * Set Plot Visible Only
   *
   * @param boolean $plotVisibleOnly
   * @return PHPExcel_Chart
   */
  public function setPlotVisibleOnly($plotVisibleOnly = true) {
    $this->_plotVisibleOnly = $plotVisibleOnly;
    return $this;
  }

  /**
   * Get Display Blanks as
   *
   * @return string
   */
  public function getDisplayBlanksAs() {
    return $this->_displayBlanksAs;
  }

  /**
   * Set Display Blanks as
   *
   * @param string $displayBlanksAs
   * @return PHPExcel_Chart
   */
  public function setDisplayBlanksAs($displayBlanksAs = '0') {
    $this->_displayBlanksAs = $displayBlanksAs;
  }

  /**
   * Get yAxis
   *
   * @return PHPExcel_Chart_Axis
   */
  public function getChartAxisY() {
    if ($this->_yAxis !== NULL) {
      return $this->_yAxis;
    }
    return new PHPExcel_Chart_Axis();
  }

  /**
   * Get xAxis
   *
   * @return PHPExcel_Chart_Axis
   */
  public function getChartAxisX() {
    if ($this->_xAxis !== NULL) {
      return $this->_xAxis;
    }
    return new PHPExcel_Chart_Axis();
  }

  /**
   * Get Major Gridlines
   *
   * @return PHPExcel_Chart_GridLines
   */
  public function getMajorGridlines() {
    if ($this->_majorGridlines !== NULL) {
      return $this->_majorGridlines;
    }
    return new PHPExcel_Chart_GridLines();
  }

  /**
   * Get Minor Gridlines
   *
   * @return PHPExcel_Chart_GridLines
   */
  public function getMinorGridlines() {
    if ($this->_minorGridlines !== NULL) {
      return $this->_minorGridlines;
    }
    return new PHPExcel_Chart_GridLines();
  }

  /**
   * Set the Top Left position for the chart
   *
   * @param	string	$cell
   * @param	integer	$xOffset
   * @param	integer	$yOffset
   * @return PHPExcel_Chart
   */
  public function setTopLeftPosition($cell, $xOffset = null, $yOffset = null) {
    $this->_topLeftCellRef = $cell;
    if (!is_null($xOffset)) {
      $this
        ->setTopLeftXOffset($xOffset);
    }
    if (!is_null($yOffset)) {
      $this
        ->setTopLeftYOffset($yOffset);
    }
    return $this;
  }

  /**
   * Get the top left position of the chart
   *
   * @return array	an associative array containing the cell address, X-Offset and Y-Offset from the top left of that cell
   */
  public function getTopLeftPosition() {
    return array(
      'cell' => $this->_topLeftCellRef,
      'xOffset' => $this->_topLeftXOffset,
      'yOffset' => $this->_topLeftYOffset,
    );
  }

  /**
   * Get the cell address where the top left of the chart is fixed
   *
   * @return string
   */
  public function getTopLeftCell() {
    return $this->_topLeftCellRef;
  }

  /**
   * Set the Top Left cell position for the chart
   *
   * @param	string	$cell
   * @return PHPExcel_Chart
   */
  public function setTopLeftCell($cell) {
    $this->_topLeftCellRef = $cell;
    return $this;
  }

  /**
   * Set the offset position within the Top Left cell for the chart
   *
   * @param	integer	$xOffset
   * @param	integer	$yOffset
   * @return PHPExcel_Chart
   */
  public function setTopLeftOffset($xOffset = null, $yOffset = null) {
    if (!is_null($xOffset)) {
      $this
        ->setTopLeftXOffset($xOffset);
    }
    if (!is_null($yOffset)) {
      $this
        ->setTopLeftYOffset($yOffset);
    }
    return $this;
  }

  /**
   * Get the offset position within the Top Left cell for the chart
   *
   * @return integer[]
   */
  public function getTopLeftOffset() {
    return array(
      'X' => $this->_topLeftXOffset,
      'Y' => $this->_topLeftYOffset,
    );
  }
  public function setTopLeftXOffset($xOffset) {
    $this->_topLeftXOffset = $xOffset;
    return $this;
  }
  public function getTopLeftXOffset() {
    return $this->_topLeftXOffset;
  }
  public function setTopLeftYOffset($yOffset) {
    $this->_topLeftYOffset = $yOffset;
    return $this;
  }
  public function getTopLeftYOffset() {
    return $this->_topLeftYOffset;
  }

  /**
   * Set the Bottom Right position of the chart
   *
   * @param	string	$cell
   * @param	integer	$xOffset
   * @param	integer	$yOffset
   * @return PHPExcel_Chart
   */
  public function setBottomRightPosition($cell, $xOffset = null, $yOffset = null) {
    $this->_bottomRightCellRef = $cell;
    if (!is_null($xOffset)) {
      $this
        ->setBottomRightXOffset($xOffset);
    }
    if (!is_null($yOffset)) {
      $this
        ->setBottomRightYOffset($yOffset);
    }
    return $this;
  }

  /**
   * Get the bottom right position of the chart
   *
   * @return array	an associative array containing the cell address, X-Offset and Y-Offset from the top left of that cell
   */
  public function getBottomRightPosition() {
    return array(
      'cell' => $this->_bottomRightCellRef,
      'xOffset' => $this->_bottomRightXOffset,
      'yOffset' => $this->_bottomRightYOffset,
    );
  }
  public function setBottomRightCell($cell) {
    $this->_bottomRightCellRef = $cell;
    return $this;
  }

  /**
   * Get the cell address where the bottom right of the chart is fixed
   *
   * @return string
   */
  public function getBottomRightCell() {
    return $this->_bottomRightCellRef;
  }

  /**
   * Set the offset position within the Bottom Right cell for the chart
   *
   * @param	integer	$xOffset
   * @param	integer	$yOffset
   * @return PHPExcel_Chart
   */
  public function setBottomRightOffset($xOffset = null, $yOffset = null) {
    if (!is_null($xOffset)) {
      $this
        ->setBottomRightXOffset($xOffset);
    }
    if (!is_null($yOffset)) {
      $this
        ->setBottomRightYOffset($yOffset);
    }
    return $this;
  }

  /**
   * Get the offset position within the Bottom Right cell for the chart
   *
   * @return integer[]
   */
  public function getBottomRightOffset() {
    return array(
      'X' => $this->_bottomRightXOffset,
      'Y' => $this->_bottomRightYOffset,
    );
  }
  public function setBottomRightXOffset($xOffset) {
    $this->_bottomRightXOffset = $xOffset;
    return $this;
  }
  public function getBottomRightXOffset() {
    return $this->_bottomRightXOffset;
  }
  public function setBottomRightYOffset($yOffset) {
    $this->_bottomRightYOffset = $yOffset;
    return $this;
  }
  public function getBottomRightYOffset() {
    return $this->_bottomRightYOffset;
  }
  public function refresh() {
    if ($this->_worksheet !== NULL) {
      $this->_plotArea
        ->refresh($this->_worksheet);
    }
  }
  public function render($outputDestination = null) {
    $libraryName = PHPExcel_Settings::getChartRendererName();
    if (is_null($libraryName)) {
      return false;
    }

    //	Ensure that data series values are up-to-date before we render
    $this
      ->refresh();
    $libraryPath = PHPExcel_Settings::getChartRendererPath();
    $includePath = str_replace('\\', '/', get_include_path());
    $rendererPath = str_replace('\\', '/', $libraryPath);
    if (strpos($rendererPath, $includePath) === false) {
      set_include_path(get_include_path() . PATH_SEPARATOR . $libraryPath);
    }
    $rendererName = 'PHPExcel_Chart_Renderer_' . $libraryName;
    $renderer = new $rendererName($this);
    if ($outputDestination == 'php://output') {
      $outputDestination = null;
    }
    return $renderer
      ->render($outputDestination);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
PHPExcel_Chart::$_bottomRightCellRef private property * Bottom-Right Cell Position * *
PHPExcel_Chart::$_bottomRightXOffset private property * Bottom-Right X-Offset * *
PHPExcel_Chart::$_bottomRightYOffset private property * Bottom-Right Y-Offset * *
PHPExcel_Chart::$_displayBlanksAs private property * Display Blanks as * *
PHPExcel_Chart::$_legend private property * Chart Legend * *
PHPExcel_Chart::$_majorGridlines private property Chart Major Gridlines as
PHPExcel_Chart::$_minorGridlines private property Chart Minor Gridlines as
PHPExcel_Chart::$_name private property * Chart Name * *
PHPExcel_Chart::$_plotArea private property * Chart Plot Area * *
PHPExcel_Chart::$_plotVisibleOnly private property * Plot Visible Only * *
PHPExcel_Chart::$_title private property * Chart Title * *
PHPExcel_Chart::$_topLeftCellRef private property * Top-Left Cell Position * *
PHPExcel_Chart::$_topLeftXOffset private property * Top-Left X-Offset * *
PHPExcel_Chart::$_topLeftYOffset private property * Top-Left Y-Offset * *
PHPExcel_Chart::$_worksheet private property * Worksheet * *
PHPExcel_Chart::$_xAxis private property Chart Asix X as
PHPExcel_Chart::$_xAxisLabel private property * X-Axis Label * *
PHPExcel_Chart::$_yAxis private property Chart Asix Y as
PHPExcel_Chart::$_yAxisLabel private property * Y-Axis Label * *
PHPExcel_Chart::getBottomRightCell public function * Get the cell address where the bottom right of the chart is fixed * *
PHPExcel_Chart::getBottomRightOffset public function * Get the offset position within the Bottom Right cell for the chart * *
PHPExcel_Chart::getBottomRightPosition public function * Get the bottom right position of the chart * *
PHPExcel_Chart::getBottomRightXOffset public function
PHPExcel_Chart::getBottomRightYOffset public function
PHPExcel_Chart::getChartAxisX public function Get xAxis
PHPExcel_Chart::getChartAxisY public function Get yAxis
PHPExcel_Chart::getDisplayBlanksAs public function * Get Display Blanks as * *
PHPExcel_Chart::getLegend public function * Get Legend * *
PHPExcel_Chart::getMajorGridlines public function Get Major Gridlines
PHPExcel_Chart::getMinorGridlines public function Get Minor Gridlines
PHPExcel_Chart::getName public function * Get Name * *
PHPExcel_Chart::getPlotArea public function * Get Plot Area * *
PHPExcel_Chart::getPlotVisibleOnly public function * Get Plot Visible Only * *
PHPExcel_Chart::getTitle public function * Get Title * *
PHPExcel_Chart::getTopLeftCell public function * Get the cell address where the top left of the chart is fixed * *
PHPExcel_Chart::getTopLeftOffset public function * Get the offset position within the Top Left cell for the chart * *
PHPExcel_Chart::getTopLeftPosition public function * Get the top left position of the chart * *
PHPExcel_Chart::getTopLeftXOffset public function
PHPExcel_Chart::getTopLeftYOffset public function
PHPExcel_Chart::getWorksheet public function * Get Worksheet * *
PHPExcel_Chart::getXAxisLabel public function * Get X-Axis Label * *
PHPExcel_Chart::getYAxisLabel public function * Get Y-Axis Label * *
PHPExcel_Chart::refresh public function
PHPExcel_Chart::render public function
PHPExcel_Chart::setBottomRightCell public function
PHPExcel_Chart::setBottomRightOffset public function * Set the offset position within the Bottom Right cell for the chart * *
PHPExcel_Chart::setBottomRightPosition public function * Set the Bottom Right position of the chart * *
PHPExcel_Chart::setBottomRightXOffset public function
PHPExcel_Chart::setBottomRightYOffset public function
PHPExcel_Chart::setDisplayBlanksAs public function * Set Display Blanks as * *
PHPExcel_Chart::setLegend public function * Set Legend * *
PHPExcel_Chart::setPlotVisibleOnly public function * Set Plot Visible Only * *
PHPExcel_Chart::setTitle public function * Set Title * *
PHPExcel_Chart::setTopLeftCell public function * Set the Top Left cell position for the chart * *
PHPExcel_Chart::setTopLeftOffset public function * Set the offset position within the Top Left cell for the chart * *
PHPExcel_Chart::setTopLeftPosition public function * Set the Top Left position for the chart * *
PHPExcel_Chart::setTopLeftXOffset public function
PHPExcel_Chart::setTopLeftYOffset public function
PHPExcel_Chart::setWorksheet public function * Set Worksheet * *
PHPExcel_Chart::setXAxisLabel public function * Set X-Axis Label * *
PHPExcel_Chart::setYAxisLabel public function * Set Y-Axis Label * *
PHPExcel_Chart::__construct public function * Create a new PHPExcel_Chart