| <?php |
| /** |
| * File containing the abstract ezcGraphChartElement class |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| * @package Graph |
| * @version //autogentag// |
| * @copyright Copyright (C) 2005-2010 eZ Systems AS. All rights reserved. |
| * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0 |
| */ |
| |
| /** |
| * Base class for chart elements |
| * |
| * The base class for chart elements. Chart elements can be understood as |
| * widgets or layout container inside the chart. The actual transformation to |
| * images happens inside the renderers. They represent all elements inside the |
| * chart and contain mostly general formatting options, while the renderer |
| * itself might define additional formatting options for some chart elments. |
| * |
| * Important chart elements for example are: |
| * |
| * - Chart title (ezcGraphChartElementText) |
| * - Chart legend (ezcGraphChartElementLegend) |
| * - The axis (ezcGraphChartElementNumericAxis, |
| * ezcGraphChartElementLogarithmicalAxis, ezcGraphChartElementLabeledAxis, |
| * ezcGraphChartElementDateAxis) |
| * - ... |
| * |
| * The position of chart elements is defined in the $position property. The |
| * effect this has on the visual representation depends on the actual type of |
| * the chart element. |
| * |
| * Each chart element may be configured with options similar to CSS, used with |
| * HTML to define the general style of the repsective element: |
| * |
| * - $padding & $margin defne the distance of the border from inner elements / |
| * other chart elements. |
| * - $borderWidth & $border define the style of the border used around the |
| * chart element |
| * - $background defines the background color of the chart element. As always |
| * this may be a (semi-) transparent color. |
| * |
| * A typical example with some layout for the chart title element could look |
| * like: |
| * |
| * <code> |
| * $graph = new ezcGraphPieChart(); |
| * $graph->data['example'] = new ezcGraphArrayDataSet( array( |
| * 'Foo' => 23, |
| * 'Bar' => 42, |
| * ) ); |
| * |
| * // Set a title and format the title element |
| * $graph->title = 'Example formatted pie chart'; |
| * $graph->title->margin = 2; |
| * $graph->title->background = '#FFFFFF80'; |
| * $graph->title->border = '#FFFFFF'; |
| * $graph->title->borderWidth = 1; |
| * $graph->title->margin = 1; |
| * $graph->title->padding = 1; |
| * |
| * // Format the legend element |
| * $graph->legend->margin = 2; |
| * $graph->legend->background = '#FFFFFF80'; |
| * $graph->legend->border = '#FFFFFF'; |
| * $graph->legend->borderWidth = 1; |
| * $graph->legend->margin = 1; |
| * $graph->legend->padding = 1; |
| * |
| * $graph->background->background = '#888a85'; |
| * |
| * $graph->render( 400, 250, 'element.svg' ); |
| * </code> |
| * |
| * @property string $title |
| * Title of chart element. |
| * @property ezcGraphColor $background |
| * Background color of chart element. |
| * @property ezcGraphColor $border |
| * Border color of chart element. |
| * @property int $padding |
| * Distance between border and content of element. |
| * @property int $margin |
| * Distance between outer boundings and border of an element. |
| * @property int $borderWidth |
| * Border width. |
| * @property int $position |
| * Integer defining the elements position in the chart. |
| * @property int $maxTitleHeight |
| * Maximum size of the title. |
| * @property float $portraitTitleSize |
| * Percentage of boundings which are used for the title with |
| * position left, right or center. |
| * @property float $landscapeTitleSize |
| * Percentage of boundings which are used for the title with |
| * position top or bottom. |
| * @property ezcGraphFontOptions $font |
| * Font used for this element. |
| * @property-read bool $fontCloned |
| * Indicates if font configuration was already cloned for this |
| * specific element. |
| * @property-read ezcGraphBoundings $boundings |
| * Boundings of this elements. |
| * |
| * @version //autogentag// |
| * @package Graph |
| */ |
| abstract class ezcGraphChartElement extends ezcBaseOptions |
| { |
| |
| /** |
| * Constructor |
| * |
| * @param array $options Default option array |
| * @return void |
| * @ignore |
| */ |
| public function __construct( array $options = array() ) |
| { |
| $this->properties['title'] = false; |
| $this->properties['background'] = false; |
| $this->properties['boundings'] = new ezcGraphBoundings(); |
| $this->properties['border'] = false; |
| $this->properties['borderWidth'] = 0; |
| $this->properties['padding'] = 0; |
| $this->properties['margin'] = 0; |
| $this->properties['position'] = ezcGraph::LEFT; |
| $this->properties['maxTitleHeight'] = 16; |
| $this->properties['portraitTitleSize'] = .15; |
| $this->properties['landscapeTitleSize'] = .2; |
| $this->properties['font'] = new ezcGraphFontOptions(); |
| $this->properties['fontCloned'] = false; |
| |
| parent::__construct( $options ); |
| } |
| |
| /** |
| * Set colors and border fro this element |
| * |
| * @param ezcGraphPalette $palette Palette |
| * @return void |
| */ |
| public function setFromPalette( ezcGraphPalette $palette ) |
| { |
| $this->properties['border'] = $palette->elementBorderColor; |
| $this->properties['borderWidth'] = $palette->elementBorderWidth; |
| $this->properties['background'] = $palette->elementBackground; |
| $this->properties['padding'] = $palette->padding; |
| $this->properties['margin'] = $palette->margin; |
| } |
| |
| /** |
| * __set |
| * |
| * @param mixed $propertyName |
| * @param mixed $propertyValue |
| * @throws ezcBaseValueException |
| * If a submitted parameter was out of range or type. |
| * @throws ezcBasePropertyNotFoundException |
| * If a the value for the property options is not an instance of |
| * @return void |
| * @ignore |
| */ |
| public function __set( $propertyName, $propertyValue ) |
| { |
| switch ( $propertyName ) |
| { |
| case 'title': |
| $this->properties['title'] = (string) $propertyValue; |
| break; |
| case 'background': |
| $this->properties['background'] = ezcGraphColor::create( $propertyValue ); |
| break; |
| case 'border': |
| $this->properties['border'] = ezcGraphColor::create( $propertyValue ); |
| break; |
| case 'padding': |
| if ( !is_numeric( $propertyValue ) || |
| ( $propertyValue < 0 ) ) |
| { |
| throw new ezcBaseValueException( $propertyName, $propertyValue, 'int >= 0' ); |
| } |
| |
| $this->properties['padding'] = (int) $propertyValue; |
| break; |
| case 'margin': |
| if ( !is_numeric( $propertyValue ) || |
| ( $propertyValue < 0 ) ) |
| { |
| throw new ezcBaseValueException( $propertyName, $propertyValue, 'int >= 0' ); |
| } |
| |
| $this->properties['margin'] = (int) $propertyValue; |
| break; |
| case 'borderWidth': |
| if ( !is_numeric( $propertyValue ) || |
| ( $propertyValue < 0 ) ) |
| { |
| throw new ezcBaseValueException( $propertyName, $propertyValue, 'int >= 0' ); |
| } |
| |
| $this->properties['borderWidth'] = (int) $propertyValue; |
| break; |
| case 'font': |
| if ( $propertyValue instanceof ezcGraphFontOptions ) |
| { |
| $this->properties['font'] = $propertyValue; |
| } |
| elseif ( is_string( $propertyValue ) ) |
| { |
| if ( !$this->fontCloned ) |
| { |
| $this->properties['font'] = clone $this->font; |
| $this->properties['fontCloned'] = true; |
| } |
| |
| $this->properties['font']->path = $propertyValue; |
| } |
| else |
| { |
| throw new ezcBaseValueException( $propertyName, $propertyValue, 'ezcGraphFontOptions' ); |
| } |
| break; |
| case 'position': |
| $positions = array( |
| ezcGraph::TOP, |
| ezcGraph::BOTTOM, |
| ezcGraph::LEFT, |
| ezcGraph::RIGHT, |
| ); |
| |
| if ( in_array( $propertyValue, $positions, true ) ) |
| { |
| $this->properties['position'] = $propertyValue; |
| } |
| else |
| { |
| throw new ezcBaseValueException( 'position', $propertyValue, 'integer' ); |
| } |
| break; |
| case 'maxTitleHeight': |
| if ( !is_numeric( $propertyValue ) || |
| ( $propertyValue < 0 ) ) |
| { |
| throw new ezcBaseValueException( $propertyName, $propertyValue, 'int >= 0' ); |
| } |
| |
| $this->properties['maxTitleHeight'] = (int) $propertyValue; |
| break; |
| case 'portraitTitleSize': |
| if ( !is_numeric( $propertyValue ) || |
| ( $propertyValue < 0 ) || |
| ( $propertyValue > 1 ) ) |
| { |
| throw new ezcBaseValueException( $propertyName, $propertyValue, '0 <= float <= 1' ); |
| } |
| |
| $this->properties['portraitTitleSize'] = (float) $propertyValue; |
| break; |
| case 'landscapeTitleSize': |
| if ( !is_numeric( $propertyValue ) || |
| ( $propertyValue < 0 ) || |
| ( $propertyValue > 1 ) ) |
| { |
| throw new ezcBaseValueException( $propertyName, $propertyValue, '0 <= float <= 1' ); |
| } |
| |
| $this->properties['landscapeTitleSize'] = (float) $propertyValue; |
| break; |
| default: |
| throw new ezcBasePropertyNotFoundException( $propertyName ); |
| break; |
| } |
| } |
| |
| /** |
| * __get |
| * |
| * @param mixed $propertyName |
| * @throws ezcBasePropertyNotFoundException |
| * If a the value for the property options is not an instance of |
| * @return mixed |
| * @ignore |
| */ |
| public function __get( $propertyName ) |
| { |
| switch ( $propertyName ) |
| { |
| case 'font': |
| // Clone font configuration when requested for this element |
| if ( !$this->fontCloned ) |
| { |
| $this->properties['font'] = clone $this->properties['font']; |
| $this->properties['fontCloned'] = true; |
| } |
| return $this->properties['font']; |
| default: |
| return parent::__get( $propertyName ); |
| } |
| } |
| |
| /** |
| * Renders this chart element |
| * |
| * This method receives and returns a part of the canvas where it can be |
| * rendered on. |
| * |
| * @param ezcGraphRenderer $renderer |
| * @param ezcGraphBoundings $boundings |
| * @return ezcGraphBoundings Part of canvas, which is still free to draw on |
| */ |
| abstract public function render( ezcGraphRenderer $renderer, ezcGraphBoundings $boundings ); |
| |
| /** |
| * Returns calculated boundings based on available percentual space of |
| * given bounding box specified in the elements options and direction of |
| * the box. |
| * |
| * @param ezcGraphBoundings $boundings |
| * @param int $direction |
| * @return ezcGraphBoundings |
| */ |
| protected function getTitleSize( ezcGraphBoundings $boundings, $direction = ezcGraph::HORIZONTAL ) |
| { |
| if ( $direction === ezcGraph::HORIZONTAL ) |
| { |
| return min( |
| $this->maxTitleHeight, |
| ( $boundings->y1 - $boundings->y0 ) * $this->landscapeTitleSize |
| ); |
| } |
| else |
| { |
| return min( |
| $this->maxTitleHeight, |
| ( $boundings->y1 - $boundings->y0 ) * $this->portraitTitleSize |
| ); |
| } |
| } |
| } |
| |
| ?> |
