1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
|
<?php
/**
* File containing the ezcGraphChartElementBackground 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//
* @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
*/
/**
* Chart element representing the background.
*
* 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. You can find more about the
* general formatting options for chart elements in the base class
* ezcGraphChartElement.
*
* Additionally to common background and border for chart elements it can draw
* an image on the chart background, and optionally repeat it. The position
* will be used to define the start of the repetition.
*
* The repetition effects are modelled similar to the background settings in
* CSS. The example shows some common settings:
*
* <code>
* $chart = new ezcGraphPieChart();
* $chart->data['example'] = new ezcGraphArrayDataSet( array(
* 'Foo' => 23,
* 'Bar' => 42,
* ) );
*
* $chart->background->image = 'background.png';
*
* // Image would be repeated horizontal at the top of the background
* $chart->background->repeat = ezcGraph::HORIZONTAL;
* $chart->background->postion = ezcGraph::TOP;
*
* // Image would be placed once in the center
* $chart->background->repeat = ezcGraph::NO_REPEAT; // default;
* $chart->background->position = ezcGraph::CENTER | ezcGraph::MIDDLE;
*
* // Image would be repeated all over the chart, the position is irrelevant
* $chart->background->repeat = ezcGraph::HORIZONTAL | ezcGraph::VERTICAL;
*
* $graph->render( 400, 250, 'legend.svg' );
* </code>
*
* @property string $image
* Filename of the file to use for background
* @property int $repeat
* Defines how the background image gets repeated
*
* @version //autogentag//
* @package Graph
* @mainclass
*/
class ezcGraphChartElementBackground extends ezcGraphChartElement
{
/**
* Constructor
*
* @param array $options Default option array
* @return void
* @ignore
*/
public function __construct( array $options = array() )
{
$this->properties['image'] = false;
$this->properties['repeat'] = ezcGraph::NO_REPEAT;
parent::__construct( $options );
}
/**
* __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 'image':
// Check for existance of file
if ( !is_file( $propertyValue ) || !is_readable( $propertyValue ) )
{
throw new ezcBaseFileNotFoundException( $propertyValue );
}
// Check for beeing an image file
$data = getImageSize( $propertyValue );
if ( $data === false )
{
throw new ezcGraphInvalidImageFileException( $propertyValue );
}
// SWF files are useless..
if ( $data[2] === 4 )
{
throw new ezcGraphInvalidImageFileException( 'We cant use SWF files like <' . $propertyValue . '>.' );
}
$this->properties['image'] = $propertyValue;
break;
case 'repeat':
if ( ( $propertyValue >= 0 ) && ( $propertyValue <= 3 ) )
{
$this->properties['repeat'] = (int) $propertyValue;
}
else
{
throw new ezcBaseValueException( $propertyName, $propertyValue, '0 <= int <= 3' );
}
break;
case 'position':
// Overwrite parent position setter, to be able to use
// combination of positions like
// ezcGraph::TOP | ezcGraph::CENTER
if ( is_int( $propertyValue ) )
{
$this->properties['position'] = $propertyValue;
}
else
{
throw new ezcBaseValueException( $propertyName, $propertyValue, 'integer' );
}
break;
case 'color':
// Use color as an alias to set background color for background
$this->__set( 'background', $propertyValue );
break;
default:
return parent::__set( $propertyName, $propertyValue );
}
}
/**
* __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 'color':
// Use color as an alias to set background color for background
return $this->properties['background'];
default:
return parent::__get( $propertyName );
}
}
/**
* Set colors and border for this element
*
* Method is overwritten because we do not ant to apply the global padding
* and margin here.
*
* @param ezcGraphPalette $palette Palette
* @return void
*/
public function setFromPalette( ezcGraphPalette $palette )
{
$this->border = $palette->chartBorderColor;
$this->borderWidth = $palette->chartBorderWidth;
$this->background = $palette->chartBackground;
$this->padding = 0;
$this->margin = 0;
}
/**
* Render the background
*
* @param ezcGraphRenderer $renderer Renderer
* @param ezcGraphBoundings $boundings Boundings
* @return ezcGraphBoundings Remaining boundings
*/
public function render( ezcGraphRenderer $renderer, ezcGraphBoundings $boundings )
{
$boundings = $renderer->drawBox(
$boundings,
$this->background,
$this->border,
$this->borderWidth,
$this->margin,
$this->padding
);
if ( $this->image === false )
{
return $boundings;
}
$renderer->drawBackgroundImage(
$boundings,
$this->image,
$this->position,
$this->repeat
);
return $boundings;
}
}
?>
|
