2
pygooglechart - A complete Python wrapper for the Google Chart API
4
http://pygooglechart.slowchop.com/
6
Copyright 2007-2008 Gerald Kaszuba
8
This program is free software: you can redistribute it and/or modify
9
it under the terms of the GNU General Public License as published by
10
the Free Software Foundation, either version 3 of the License, or
11
(at your option) any later version.
13
This program is distributed in the hope that it will be useful,
14
but WITHOUT ANY WARRANTY; without even the implied warranty of
15
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16
GNU General Public License for more details.
18
You should have received a copy of the GNU General Public License
19
along with this program. If not, see <http://www.gnu.org/licenses/>.
30
# Helper variables and functions
31
# -----------------------------------------------------------------------------
34
__author__ = 'Gerald Kaszuba'
36
reo_colour = re.compile('^([A-Fa-f0-9]{2,2}){3,4}$')
38
def _check_colour(colour):
39
if not reo_colour.match(colour):
40
raise InvalidParametersException('Colours need to be in ' \
41
'RRGGBB or RRGGBBAA format. One of your colours has %s' % \
45
# -----------------------------------------------------------------------------
48
class PyGoogleChartException(Exception):
52
class DataOutOfRangeException(PyGoogleChartException):
56
class UnknownDataTypeException(PyGoogleChartException):
60
class NoDataGivenException(PyGoogleChartException):
64
class InvalidParametersException(PyGoogleChartException):
68
class BadContentTypeException(PyGoogleChartException):
72
class AbstractClassException(PyGoogleChartException):
76
class UnknownChartType(PyGoogleChartException):
81
# -----------------------------------------------------------------------------
86
def __init__(self, data):
87
if type(self) == Data:
88
raise AbstractClassException('This is an abstract class')
92
def float_scale_value(cls, value, range):
95
max_value = cls.max_value()
96
scaled = (value-lower) * (float(max_value) / (upper - lower))
100
def clip_value(cls, value):
101
return max(0, min(value, cls.max_value()))
104
def int_scale_value(cls, value, range):
105
return int(round(cls.float_scale_value(value, range)))
108
def scale_value(cls, value, range):
109
scaled = cls.int_scale_value(value, range)
110
clipped = cls.clip_value(scaled)
114
class SimpleData(Data):
116
enc_map = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'
119
max_value = self.max_value()
121
for data in self.data:
126
elif value >= 0 and value <= max_value:
127
sub_data.append(SimpleData.enc_map[value])
129
raise DataOutOfRangeException('cannot encode value: %d'
131
encoded_data.append(''.join(sub_data))
132
return 'chd=s:' + ','.join(encoded_data)
139
class TextData(Data):
142
max_value = self.max_value()
144
for data in self.data:
149
elif value >= 0 and value <= max_value:
150
sub_data.append("%.1f" % float(value))
152
raise DataOutOfRangeException()
153
encoded_data.append(','.join(sub_data))
154
return 'chd=t:' + '|'.join(encoded_data)
161
def scale_value(cls, value, range):
162
# use float values instead of integers because we don't need an encode
164
scaled = cls.float_scale_value(value, range)
165
clipped = cls.clip_value(scaled)
169
class ExtendedData(Data):
172
'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-.'
175
max_value = self.max_value()
177
enc_size = len(ExtendedData.enc_map)
178
for data in self.data:
182
sub_data.append('__')
183
elif value >= 0 and value <= max_value:
184
first, second = divmod(int(value), enc_size)
185
sub_data.append('%s%s' % (
186
ExtendedData.enc_map[first],
187
ExtendedData.enc_map[second]))
189
raise DataOutOfRangeException( \
190
'Item #%i "%s" is out of range' % (data.index(value), \
192
encoded_data.append(''.join(sub_data))
193
return 'chd=e:' + ','.join(encoded_data)
201
# -----------------------------------------------------------------------------
210
TYPES = (BOTTOM, TOP, LEFT, RIGHT)
212
def __init__(self, axis_index, axis_type, **kw):
213
assert(axis_type in Axis.TYPES)
214
self.has_style = False
215
self.axis_index = axis_index
216
self.axis_type = axis_type
217
self.positions = None
219
def set_index(self, axis_index):
220
self.axis_index = axis_index
222
def set_positions(self, positions):
223
self.positions = positions
225
def set_style(self, colour, font_size=None, alignment=None):
226
_check_colour(colour)
228
self.font_size = font_size
229
self.alignment = alignment
230
self.has_style = True
232
def style_to_url(self):
234
bits.append(str(self.axis_index))
235
bits.append(self.colour)
236
if self.font_size is not None:
237
bits.append(str(self.font_size))
238
if self.alignment is not None:
239
bits.append(str(self.alignment))
240
return ','.join(bits)
242
def positions_to_url(self):
244
bits.append(str(self.axis_index))
245
bits += [str(a) for a in self.positions]
246
return ','.join(bits)
249
class LabelAxis(Axis):
251
def __init__(self, axis_index, axis_type, values, **kwargs):
252
Axis.__init__(self, axis_index, axis_type, **kwargs)
253
self.values = [str(a) for a in values]
256
return '%i:|%s' % (self.axis_index, '|'.join(self.values))
259
class RangeAxis(Axis):
261
def __init__(self, axis_index, axis_type, low, high, **kwargs):
262
Axis.__init__(self, axis_index, axis_type, **kwargs)
267
return '%i,%s,%s' % (self.axis_index, self.low, self.high)
270
# -----------------------------------------------------------------------------
274
"""Abstract class for all chart types.
276
width are height specify the dimensions of the image. title sets the title
277
of the chart. legend requires a list that corresponds to datasets.
280
BASE_URL = 'http://chart.apis.google.com/chart?'
284
VALID_SOLID_FILL_TYPES = (BACKGROUND, CHART, ALPHA)
286
LINEAR_GRADIENT = 'lg'
287
LINEAR_STRIPES = 'ls'
289
def __init__(self, width, height, title=None, legend=None, colours=None,
290
auto_scale=True, x_range=None, y_range=None):
291
if type(self) == Chart:
292
raise AbstractClassException('This is an abstract class')
293
assert(isinstance(width, int))
294
assert(isinstance(height, int))
298
self.set_title(title)
299
self.set_legend(legend)
300
self.set_colours(colours)
303
self.auto_scale = auto_scale # Whether to automatically scale data
304
self.x_range = x_range # (min, max) x-axis range for scaling
305
self.y_range = y_range # (min, max) y-axis range for scaling
306
self.scaled_data_class = None
307
self.scaled_x_range = None
308
self.scaled_y_range = None
311
Chart.BACKGROUND: None,
316
Chart.BACKGROUND: None,
322
self.line_styles = {}
326
# -------------------------------------------------------------------------
328
def get_url(self, data_class=None):
329
url_bits = self.get_url_bits(data_class=data_class)
330
return self.BASE_URL + '&'.join(url_bits)
332
def get_url_bits(self, data_class=None):
335
url_bits.append(self.type_to_url())
336
url_bits.append('chs=%ix%i' % (self.width, self.height))
337
url_bits.append(self.data_to_url(data_class=data_class))
340
url_bits.append('chtt=%s' % self.title)
342
url_bits.append('chdl=%s' % '|'.join(self.legend))
344
url_bits.append('chco=%s' % ','.join(self.colours))
345
ret = self.fill_to_url()
348
ret = self.axis_to_url()
352
url_bits.append(self.markers_to_url())
355
for index in xrange(max(self.line_styles) + 1):
356
if index in self.line_styles:
357
values = self.line_styles[index]
360
style.append(','.join(values))
361
url_bits.append('chls=%s' % '|'.join(style))
363
url_bits.append('chg=%s' % self.grid)
367
# -------------------------------------------------------------------------
369
def download(self, file_name):
370
opener = urllib2.urlopen(self.get_url())
372
if opener.headers['content-type'] != 'image/png':
373
raise BadContentTypeException('Server responded with a ' \
374
'content-type of %s' % opener.headers['content-type'])
376
open(file_name, 'wb').write(urllib.urlopen(self.get_url()).read())
379
# -------------------------------------------------------------------------
381
def set_title(self, title):
383
self.title = urllib.quote(title)
387
def set_legend(self, legend):
388
"""legend needs to be a list, tuple or None"""
389
assert(isinstance(legend, list) or isinstance(legend, tuple) or
392
self.legend = [urllib.quote(a) for a in legend]
397
# -------------------------------------------------------------------------
399
def set_colours(self, colours):
400
# colours needs to be a list, tuple or None
401
assert(isinstance(colours, list) or isinstance(colours, tuple) or
403
# make sure the colours are in the right format
407
self.colours = colours
409
# Background/Chart colours
410
# -------------------------------------------------------------------------
412
def fill_solid(self, area, colour):
413
assert(area in Chart.VALID_SOLID_FILL_TYPES)
414
_check_colour(colour)
415
self.fill_area[area] = colour
416
self.fill_types[area] = Chart.SOLID
418
def _check_fill_linear(self, angle, *args):
419
assert(isinstance(args, list) or isinstance(args, tuple))
420
assert(angle >= 0 and angle <= 90)
421
assert(len(args) % 2 == 0)
422
args = list(args) # args is probably a tuple and we need to mutate
423
for a in xrange(len(args) / 2):
425
offset = args[a * 2 + 1]
427
assert(offset >= 0 and offset <= 1)
428
args[a * 2 + 1] = str(args[a * 2 + 1])
431
def fill_linear_gradient(self, area, angle, *args):
432
assert(area in Chart.VALID_SOLID_FILL_TYPES)
433
args = self._check_fill_linear(angle, *args)
434
self.fill_types[area] = Chart.LINEAR_GRADIENT
435
self.fill_area[area] = ','.join([str(angle)] + args)
437
def fill_linear_stripes(self, area, angle, *args):
438
assert(area in Chart.VALID_SOLID_FILL_TYPES)
439
args = self._check_fill_linear(angle, *args)
440
self.fill_types[area] = Chart.LINEAR_STRIPES
441
self.fill_area[area] = ','.join([str(angle)] + args)
443
def fill_to_url(self):
445
for area in (Chart.BACKGROUND, Chart.CHART, Chart.ALPHA):
446
if self.fill_types[area]:
447
areas.append('%s,%s,%s' % (area, self.fill_types[area], \
448
self.fill_area[area]))
450
return 'chf=' + '|'.join(areas)
453
# -------------------------------------------------------------------------
455
def data_class_detection(self, data):
456
"""Determines the appropriate data encoding type to give satisfactory
457
resolution (http://code.google.com/apis/chart/#chart_data).
459
assert(isinstance(data, list) or isinstance(data, tuple))
460
if not isinstance(self, (LineChart, BarChart, ScatterChart)):
461
# From the link above:
462
# Simple encoding is suitable for all other types of chart
463
# regardless of size.
465
elif self.height < 100:
466
# The link above indicates that line and bar charts less
467
# than 300px in size can be suitably represented with the
468
# simple encoding. I've found that this isn't sufficient,
469
# e.g. examples/line-xy-circle.png. Let's try 100px.
474
def data_x_range(self):
475
"""Return a 2-tuple giving the minimum and maximum x-axis
479
lower = min([min(s) for type, s in self.annotated_data()
481
upper = max([max(s) for type, s in self.annotated_data()
483
return (lower, upper)
485
return None # no x-axis datasets
487
def data_y_range(self):
488
"""Return a 2-tuple giving the minimum and maximum y-axis
492
lower = min([min(s) for type, s in self.annotated_data()
494
upper = max([max(s) + 1 for type, s in self.annotated_data()
496
return (lower, upper)
498
return None # no y-axis datasets
500
def scaled_data(self, data_class, x_range=None, y_range=None):
501
"""Scale `self.data` as appropriate for the given data encoding
502
(data_class) and return it.
504
An optional `y_range` -- a 2-tuple (lower, upper) -- can be
505
given to specify the y-axis bounds. If not given, the range is
506
inferred from the data: (0, <max-value>) presuming no negative
507
values, or (<min-value>, <max-value>) if there are negative
508
values. `self.scaled_y_range` is set to the actual lower and
511
Ditto for `x_range`. Note that some chart types don't have x-axis
514
self.scaled_data_class = data_class
516
# Determine the x-axis range for scaling.
518
x_range = self.data_x_range()
519
if x_range and x_range[0] > 0:
520
x_range = (0, x_range[1])
521
self.scaled_x_range = x_range
523
# Determine the y-axis range for scaling.
525
y_range = self.data_y_range()
526
if y_range and y_range[0] > 0:
527
y_range = (0, y_range[1])
528
self.scaled_y_range = y_range
531
for type, dataset in self.annotated_data():
533
scale_range = x_range
535
scale_range = y_range
536
elif type == 'marker-size':
537
scale_range = (0, max(dataset))
538
scaled_data.append([data_class.scale_value(v, scale_range)
542
def add_data(self, data):
543
self.data.append(data)
544
return len(self.data) - 1 # return the "index" of the data set
546
def data_to_url(self, data_class=None):
548
data_class = self.data_class_detection(self.data)
549
if not issubclass(data_class, Data):
550
raise UnknownDataTypeException()
553
data = self.scaled_data(data_class, self.x_range, self.y_range)
556
return repr(data_class(data))
558
def annotated_data(self):
559
for dataset in self.data:
563
# -------------------------------------------------------------------------
565
def set_axis_labels(self, axis_type, values):
566
assert(axis_type in Axis.TYPES)
567
values = [urllib.quote(a) for a in values]
568
axis_index = len(self.axis)
569
axis = LabelAxis(axis_index, axis_type, values)
570
self.axis.append(axis)
573
def set_axis_range(self, axis_type, low, high):
574
assert(axis_type in Axis.TYPES)
575
axis_index = len(self.axis)
576
axis = RangeAxis(axis_index, axis_type, low, high)
577
self.axis.append(axis)
580
def set_axis_positions(self, axis_index, positions):
582
self.axis[axis_index].set_positions(positions)
584
raise InvalidParametersException('Axis index %i has not been ' \
587
def set_axis_style(self, axis_index, colour, font_size=None, \
590
self.axis[axis_index].set_style(colour, font_size, alignment)
592
raise InvalidParametersException('Axis index %i has not been ' \
595
def axis_to_url(self):
602
for axis in self.axis:
603
available_axis.append(axis.axis_type)
604
if isinstance(axis, RangeAxis):
605
range_axis.append(repr(axis))
606
if isinstance(axis, LabelAxis):
607
label_axis.append(repr(axis))
609
positions.append(axis.positions_to_url())
611
styles.append(axis.style_to_url())
612
if not available_axis:
615
url_bits.append('chxt=%s' % ','.join(available_axis))
617
url_bits.append('chxl=%s' % '|'.join(label_axis))
619
url_bits.append('chxr=%s' % '|'.join(range_axis))
621
url_bits.append('chxp=%s' % '|'.join(positions))
623
url_bits.append('chxs=%s' % '|'.join(styles))
624
return '&'.join(url_bits)
626
# Markers, Ranges and Fill area (chm)
627
# -------------------------------------------------------------------------
629
def markers_to_url(self):
630
return 'chm=%s' % '|'.join([','.join(a) for a in self.markers])
632
def add_marker(self, index, point, marker_type, colour, size, priority=0):
633
self.markers.append((marker_type, colour, str(index), str(point), \
634
str(size), str(priority)))
636
def add_horizontal_range(self, colour, start, stop):
637
self.markers.append(('r', colour, '1', str(start), str(stop)))
639
def add_vertical_range(self, colour, start, stop):
640
self.markers.append(('R', colour, '1', str(start), str(stop)))
642
def add_fill_range(self, colour, index_start, index_end):
643
self.markers.append(('b', colour, str(index_start), str(index_end), \
646
def add_fill_simple(self, colour):
647
self.markers.append(('B', colour, '1', '1', '1'))
650
# -------------------------------------------------------------------------
652
def set_line_style(self, index, thickness=1, line_segment=None, \
655
value.append(str(thickness))
657
value.append(str(line_segment))
658
value.append(str(blank_segment))
659
self.line_styles[index] = value
662
# -------------------------------------------------------------------------
664
def set_grid(self, x_step, y_step, line_segment=1, \
666
self.grid = '%s,%s,%s,%s' % (x_step, y_step, line_segment, \
670
class ScatterChart(Chart):
672
def type_to_url(self):
675
def annotated_data(self):
676
yield ('x', self.data[0])
677
yield ('y', self.data[1])
678
if len(self.data) > 2:
679
# The optional third dataset is relative sizing for point
681
yield ('marker-size', self.data[2])
684
class LineChart(Chart):
686
def __init__(self, *args, **kwargs):
687
if type(self) == LineChart:
688
raise AbstractClassException('This is an abstract class')
689
Chart.__init__(self, *args, **kwargs)
692
class SimpleLineChart(LineChart):
694
def type_to_url(self):
697
def annotated_data(self):
698
# All datasets are y-axis data.
699
for dataset in self.data:
703
class SparkLineChart(SimpleLineChart):
705
def type_to_url(self):
709
class XYLineChart(LineChart):
711
def type_to_url(self):
714
def annotated_data(self):
715
# Datasets alternate between x-axis, y-axis.
716
for i, dataset in enumerate(self.data):
723
class BarChart(Chart):
725
def __init__(self, *args, **kwargs):
726
if type(self) == BarChart:
727
raise AbstractClassException('This is an abstract class')
728
Chart.__init__(self, *args, **kwargs)
729
self.bar_width = None
732
def set_bar_width(self, bar_width):
733
self.bar_width = bar_width
735
def set_zero_line(self, index, zero_line):
736
self.zero_lines[index] = zero_line
738
def get_url_bits(self, data_class=None, skip_chbh=False):
739
url_bits = Chart.get_url_bits(self, data_class=data_class)
740
if not skip_chbh and self.bar_width is not None:
741
url_bits.append('chbh=%i' % self.bar_width)
744
for index in xrange(max(self.zero_lines) + 1):
745
if index in self.zero_lines:
746
zero_line.append(str(self.zero_lines[index]))
748
zero_line.append('0')
749
url_bits.append('chp=%s' % ','.join(zero_line))
753
class StackedHorizontalBarChart(BarChart):
755
def type_to_url(self):
759
class StackedVerticalBarChart(BarChart):
761
def type_to_url(self):
764
def annotated_data(self):
765
for dataset in self.data:
769
class GroupedBarChart(BarChart):
771
def __init__(self, *args, **kwargs):
772
if type(self) == GroupedBarChart:
773
raise AbstractClassException('This is an abstract class')
774
BarChart.__init__(self, *args, **kwargs)
775
self.bar_spacing = None
776
self.group_spacing = None
778
def set_bar_spacing(self, spacing):
779
"""Set spacing between bars in a group."""
780
self.bar_spacing = spacing
782
def set_group_spacing(self, spacing):
783
"""Set spacing between groups of bars."""
784
self.group_spacing = spacing
786
def get_url_bits(self, data_class=None):
787
# Skip 'BarChart.get_url_bits' and call Chart directly so the parent
788
# doesn't add "chbh" before we do.
789
url_bits = BarChart.get_url_bits(self, data_class=data_class,
791
if self.group_spacing is not None:
792
if self.bar_spacing is None:
793
raise InvalidParametersException('Bar spacing is required ' \
794
'to be set when setting group spacing')
795
if self.bar_width is None:
796
raise InvalidParametersException('Bar width is required to ' \
797
'be set when setting bar spacing')
798
url_bits.append('chbh=%i,%i,%i'
799
% (self.bar_width, self.bar_spacing, self.group_spacing))
800
elif self.bar_spacing is not None:
801
if self.bar_width is None:
802
raise InvalidParametersException('Bar width is required to ' \
803
'be set when setting bar spacing')
804
url_bits.append('chbh=%i,%i' % (self.bar_width, self.bar_spacing))
806
url_bits.append('chbh=%i' % self.bar_width)
810
class GroupedHorizontalBarChart(GroupedBarChart):
812
def type_to_url(self):
816
class GroupedVerticalBarChart(GroupedBarChart):
818
def type_to_url(self):
821
def annotated_data(self):
822
for dataset in self.data:
826
class PieChart(Chart):
828
def __init__(self, *args, **kwargs):
829
if type(self) == PieChart:
830
raise AbstractClassException('This is an abstract class')
831
Chart.__init__(self, *args, **kwargs)
834
def set_pie_labels(self, labels):
835
self.pie_labels = [urllib.quote(a) for a in labels]
837
def get_url_bits(self, data_class=None):
838
url_bits = Chart.get_url_bits(self, data_class=data_class)
840
url_bits.append('chl=%s' % '|'.join(self.pie_labels))
843
def annotated_data(self):
844
# Datasets are all y-axis data. However, there should only be
845
# one dataset for pie charts.
846
for dataset in self.data:
850
class PieChart2D(PieChart):
852
def type_to_url(self):
856
class PieChart3D(PieChart):
858
def type_to_url(self):
862
class VennChart(Chart):
864
def type_to_url(self):
867
def annotated_data(self):
868
for dataset in self.data:
872
class RadarChart(Chart):
874
def type_to_url(self):
878
class SplineRadarChart(RadarChart):
880
def type_to_url(self):
884
class MapChart(Chart):
886
def __init__(self, *args, **kwargs):
887
Chart.__init__(self, *args, **kwargs)
888
self.geo_area = 'world'
891
def type_to_url(self):
894
def set_codes(self, codes):
897
def get_url_bits(self, data_class=None):
898
url_bits = Chart.get_url_bits(self, data_class=data_class)
899
url_bits.append('chtm=%s' % self.geo_area)
901
url_bits.append('chld=%s' % ''.join(self.codes))
905
class GoogleOMeterChart(PieChart):
906
"""Inheriting from PieChart because of similar labeling"""
908
def type_to_url(self):
912
class ChartGrammar(object):
914
def __init__(self, grammar):
915
self.grammar = grammar
916
self.chart = self.create_chart_instance()
919
def get_possible_chart_types():
921
for cls_name in globals():
922
if not cls_name.endswith('Chart'):
924
cls = globals()[cls_name]
925
# Check if it is an abstract class
928
except AbstractClassException:
931
possible_charts.append(cls_name[:-5])
932
return possible_charts
934
def create_chart_instance(self):
935
assert('w' in grammar) # width is required
936
assert('h' in grammar) # height is required
937
assert('type' in grammar) # type is required
938
types = ChartGrammar.get_possible_chart_types()
939
if grammar['type'] not in types:
940
raise UnknownChartType('%s is an unknown chart type. Possible '
941
'chart types are %s' % (grammar['type'], ','.join(types)))
2
PyGoogleChart - A complete Python wrapper for the Google Chart API
4
http://pygooglechart.slowchop.com/
6
Copyright 2007 Gerald Kaszuba
8
This program is free software: you can redistribute it and/or modify
9
it under the terms of the GNU General Public License as published by
10
the Free Software Foundation, either version 3 of the License, or
11
(at your option) any later version.
13
This program is distributed in the hope that it will be useful,
14
but WITHOUT ANY WARRANTY; without even the implied warranty of
15
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16
GNU General Public License for more details.
18
You should have received a copy of the GNU General Public License
19
along with this program. If not, see <http://www.gnu.org/licenses/>.
30
# Helper variables and functions
31
# -----------------------------------------------------------------------------
33
reo_colour = re.compile('^([A-Fa-f0-9]{2,2}){3,4}$')
36
def _check_colour(colour):
37
if not reo_colour.match(colour):
38
raise InvalidParametersException('Colours need to be in ' \
39
'RRGGBB or RRGGBBAA format. One of your colours has %s' % \
43
# -----------------------------------------------------------------------------
46
class PyGoogleChartException(Exception):
50
class DataOutOfRangeException(PyGoogleChartException):
54
class UnknownDataTypeException(PyGoogleChartException):
58
class NoDataGivenException(PyGoogleChartException):
62
class InvalidParametersException(PyGoogleChartException):
66
class BadContentTypeException(PyGoogleChartException):
71
# -----------------------------------------------------------------------------
76
def __init__(self, data):
77
assert(type(self) != Data) # This is an abstract class
81
class SimpleData(Data):
82
enc_map = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'
86
for data in self.data:
91
elif value >= 0 and value <= SimpleData.max_value:
92
sub_data.append(SimpleData.enc_map[value])
94
raise DataOutOfRangeException()
95
encoded_data.append(''.join(sub_data))
96
return 'chd=s:' + ','.join(encoded_data)
103
class TextData(Data):
107
for data in self.data:
112
elif value >= 0 and value <= TextData.max_value:
113
sub_data.append(str(float(value)))
115
raise DataOutOfRangeException()
116
encoded_data.append(','.join(sub_data))
117
return 'chd=t:' + '|'.join(encoded_data)
124
class ExtendedData(Data):
126
'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-.'
130
enc_size = len(ExtendedData.enc_map)
131
for data in self.data:
135
sub_data.append('__')
136
elif value >= 0 and value <= ExtendedData.max_value:
137
first, second = divmod(int(value), enc_size)
138
sub_data.append('%s%s' % (
139
ExtendedData.enc_map[first],
140
ExtendedData.enc_map[second]))
142
raise DataOutOfRangeException( \
143
'Item #%i "%s" is out of range' % (data.index(value), \
145
encoded_data.append(''.join(sub_data))
146
return 'chd=e:' + ','.join(encoded_data)
153
# -----------------------------------------------------------------------------
161
TYPES = (BOTTOM, TOP, LEFT, RIGHT)
163
def __init__(self, axis, **kw):
164
assert(axis in Axis.TYPES)
165
self.has_style = False
167
self.positions = None
169
def set_index(self, index):
172
def set_positions(self, positions):
173
self.positions = positions
175
def set_style(self, colour, font_size=None, alignment=None):
176
_check_colour(colour)
178
self.font_size = font_size
179
self.alignment = alignment
180
self.has_style = True
182
def style_to_url(self):
184
bits.append(str(self.index))
185
bits.append(self.colour)
186
if self.font_size is not None:
187
bits.append(str(self.font_size))
188
if self.alignment is not None:
189
bits.append(str(self.alignment))
190
return ','.join(bits)
192
def positions_to_url(self):
194
bits.append(str(self.index))
195
bits += [str(a) for a in self.positions]
196
return ','.join(bits)
199
class LabelAxis(Axis):
201
def __init__(self, axis, values, **kwargs):
202
Axis.__init__(self, axis, **kwargs)
203
self.values = [str(a) for a in values]
206
return '%i:|%s' % (self.index, '|'.join(self.values))
209
class RangeAxis(Axis):
211
def __init__(self, axis, low, high, **kwargs):
212
Axis.__init__(self, axis, **kwargs)
217
return '%i,%s,%s' % (self.index, self.low, self.high)
220
# -----------------------------------------------------------------------------
224
"""Abstract class for all chart types.
226
width are height specify the dimensions of the image. title sets the title
227
of the chart. legend requires a list that corresponds to datasets.
230
BASE_URL = 'http://chart.apis.google.com/chart?'
234
LINEAR_GRADIENT = 'lg'
235
LINEAR_STRIPES = 'ls'
237
def __init__(self, width, height, title=None, legend=None, colours=None):
238
assert(type(self) != Chart) # This is an abstract class
239
assert(isinstance(width, int))
240
assert(isinstance(height, int))
244
self.set_title(title)
245
self.set_legend(legend)
246
self.set_colours(colours)
248
Chart.BACKGROUND: None,
252
Chart.BACKGROUND: None,
264
# -------------------------------------------------------------------------
267
url_bits = self.get_url_bits()
268
return self.BASE_URL + '&'.join(url_bits)
270
def get_url_bits(self):
273
url_bits.append(self.type_to_url())
274
url_bits.append('chs=%ix%i' % (self.width, self.height))
275
url_bits.append(self.data_to_url())
278
url_bits.append('chtt=%s' % self.title)
280
url_bits.append('chdl=%s' % '|'.join(self.legend))
282
url_bits.append('chco=%s' % ','.join(self.colours))
283
ret = self.fill_to_url()
286
ret = self.axis_to_url()
290
url_bits.append(self.markers_to_url())
294
# -------------------------------------------------------------------------
296
def download(self, file_name):
297
opener = urllib2.urlopen(self.get_url())
299
if opener.headers['content-type'] != 'image/png':
300
raise BadContentTypeException('Server responded with a ' \
301
'content-type of %s' % opener.headers['content-type'])
303
open(file_name, 'wb').write(urllib.urlopen(self.get_url()).read())
306
# -------------------------------------------------------------------------
308
def set_title(self, title):
310
self.title = urllib.quote(title)
314
def set_legend(self, legend):
315
# legend needs to be a list, tuple or None
316
assert(isinstance(legend, list) or isinstance(legend, tuple) or
319
self.legend = [urllib.quote(a) for a in legend]
324
# -------------------------------------------------------------------------
326
def set_colours(self, colours):
327
# colours needs to be a list, tuple or None
328
assert(isinstance(colours, list) or isinstance(colours, tuple) or
330
# make sure the colours are in the right format
334
self.colours = colours
336
# Background/Chart colours
337
# -------------------------------------------------------------------------
339
def fill_solid(self, area, colour):
340
assert(area in (Chart.BACKGROUND, Chart.CHART))
341
_check_colour(colour)
342
self.fill_area[area] = colour
343
self.fill_types[area] = Chart.SOLID
345
def _check_fill_linear(self, angle, *args):
346
assert(isinstance(args, list) or isinstance(args, tuple))
347
assert(angle >= 0 and angle <= 90)
348
assert(len(args) % 2 == 0)
349
args = list(args) # args is probably a tuple and we need to mutate
350
for a in xrange(len(args) / 2):
352
offset = args[a * 2 + 1]
354
assert(offset >= 0 and offset <= 1)
355
args[a * 2 + 1] = str(args[a * 2 + 1])
358
def fill_linear_gradient(self, area, angle, *args):
359
assert(area in (Chart.BACKGROUND, Chart.CHART))
360
args = self._check_fill_linear(angle, *args)
361
self.fill_types[area] = Chart.LINEAR_GRADIENT
362
self.fill_area[area] = ','.join([str(angle)] + args)
364
def fill_linear_stripes(self, area, angle, *args):
365
assert(area in (Chart.BACKGROUND, Chart.CHART))
366
args = self._check_fill_linear(angle, *args)
367
self.fill_types[area] = Chart.LINEAR_STRIPES
368
self.fill_area[area] = ','.join([str(angle)] + args)
370
def fill_to_url(self):
372
for area in (Chart.BACKGROUND, Chart.CHART):
373
if self.fill_types[area]:
374
areas.append('%s,%s,%s' % (area, self.fill_types[area], \
375
self.fill_area[area]))
377
return 'chf=' + '|'.join(areas)
380
# -------------------------------------------------------------------------
382
def data_class_detection(self, data):
384
Detects and returns the data type required based on the range of the
385
data given. The data given must be lists of numbers within a list.
387
assert(isinstance(data, list) or isinstance(data, tuple))
390
assert(isinstance(a, list) or isinstance(a, tuple))
391
if max_value is None or max(a) > max_value:
393
for data_class in (SimpleData, TextData, ExtendedData):
394
if max_value <= data_class.max_value():
396
raise DataOutOfRangeException()
398
def add_data(self, data):
399
self.data.append(data)
400
return len(self.data) - 1 # return the "index" of the data set
402
def data_to_url(self, data_class=None):
404
data_class = self.data_class_detection(self.data)
405
if not issubclass(data_class, Data):
406
raise UnknownDataTypeException()
407
return repr(data_class(self.data))
410
# -------------------------------------------------------------------------
412
def set_axis_labels(self, axis, values):
413
assert(axis in Axis.TYPES)
414
self.axis[axis] = LabelAxis(axis, values)
416
def set_axis_range(self, axis, low, high):
417
assert(axis in Axis.TYPES)
418
self.axis[axis] = RangeAxis(axis, low, high)
420
def set_axis_positions(self, axis, positions):
421
assert(axis in Axis.TYPES)
422
if not self.axis[axis]:
423
raise InvalidParametersException('Please create an axis first')
424
self.axis[axis].set_positions(positions)
426
def set_axis_style(self, axis, colour, font_size=None, alignment=None):
427
assert(axis in Axis.TYPES)
428
if not self.axis[axis]:
429
raise InvalidParametersException('Please create an axis first')
430
self.axis[axis].set_style(colour, font_size, alignment)
432
def axis_to_url(self):
439
for position, axis in self.axis.items():
443
axis.set_index(index)
444
available_axis.append(position)
445
if isinstance(axis, RangeAxis):
446
range_axis.append(repr(axis))
447
if isinstance(axis, LabelAxis):
448
label_axis.append(repr(axis))
450
positions.append(axis.positions_to_url())
452
styles.append(axis.style_to_url())
453
if not available_axis:
456
url_bits.append('chxt=%s' % ','.join(available_axis))
458
url_bits.append('chxl=%s' % '|'.join(label_axis))
460
url_bits.append('chxr=%s' % '|'.join(range_axis))
462
url_bits.append('chxp=%s' % '|'.join(positions))
464
url_bits.append('chxs=%s' % '|'.join(styles))
465
return '&'.join(url_bits)
467
# Markers, Ranges and Fill area (chm)
468
# -------------------------------------------------------------------------
470
def markers_to_url(self):
471
return 'chm=%s' % '|'.join([','.join(a) for a in self.markers])
473
def add_marker(self, index, point, marker_type, colour, size):
474
self.markers.append((marker_type, colour, str(index), str(point), \
477
def add_horizontal_range(self, colour, start, stop):
478
self.markers.append(('r', colour, '1', str(start), str(stop)))
480
def add_vertical_range(self, colour, start, stop):
481
self.markers.append(('R', colour, '1', str(start), str(stop)))
483
def add_fill_range(self, colour, index_start, index_end):
484
self.markers.append(('b', colour, str(index_start), str(index_end), \
487
def add_fill_simple(self, colour):
488
self.markers.append(('B', colour, '1', '1', '1'))
491
class ScatterChart(Chart):
493
def __init__(self, *args, **kwargs):
494
Chart.__init__(self, *args, **kwargs)
496
def type_to_url(self):
500
class LineChart(Chart):
502
def __init__(self, *args, **kwargs):
503
assert(type(self) != LineChart) # This is an abstract class
504
Chart.__init__(self, *args, **kwargs)
505
self.line_styles = {}
508
def set_line_style(self, index, thickness=1, line_segment=None, \
511
value.append(str(thickness))
513
value.append(str(line_segment))
514
value.append(str(blank_segment))
515
self.line_styles[index] = value
517
def set_grid(self, x_step, y_step, line_segment=1, \
519
self.grid = '%s,%s,%s,%s' % (x_step, y_step, line_segment, \
522
def get_url_bits(self):
523
url_bits = Chart.get_url_bits(self)
526
# for index, values in self.line_style.items():
527
for index in xrange(max(self.line_styles) + 1):
528
if index in self.line_styles:
529
values = self.line_styles[index]
532
style.append(','.join(values))
533
url_bits.append('chls=%s' % '|'.join(style))
535
url_bits.append('chg=%s' % self.grid)
539
class SimpleLineChart(LineChart):
541
def type_to_url(self):
545
class XYLineChart(LineChart):
547
def type_to_url(self):
551
class BarChart(Chart):
553
def __init__(self, *args, **kwargs):
554
assert(type(self) != BarChart) # This is an abstract class
555
Chart.__init__(self, *args, **kwargs)
556
self.bar_width = None
558
def set_bar_width(self, bar_width):
559
self.bar_width = bar_width
561
def get_url_bits(self):
562
url_bits = Chart.get_url_bits(self)
563
url_bits.append('chbh=%i' % self.bar_width)
567
class StackedHorizontalBarChart(BarChart):
569
def type_to_url(self):
573
class StackedVerticalBarChart(BarChart):
575
def type_to_url(self):
579
class GroupedBarChart(BarChart):
581
def __init__(self, *args, **kwargs):
582
assert(type(self) != GroupedBarChart) # This is an abstract class
583
BarChart.__init__(self, *args, **kwargs)
584
self.bar_spacing = None
586
def set_bar_spacing(self, spacing):
587
self.bar_spacing = spacing
589
def get_url_bits(self):
590
# Skip 'BarChart.get_url_bits' and call Chart directly so the parent
591
# doesn't add "chbh" before we do.
592
url_bits = Chart.get_url_bits(self)
593
if self.bar_spacing is not None:
594
if self.bar_width is None:
595
raise InvalidParametersException('Bar width is required to ' \
596
'be set when setting spacing')
597
url_bits.append('chbh=%i,%i' % (self.bar_width, self.bar_spacing))
599
url_bits.append('chbh=%i' % self.bar_width)
603
class GroupedHorizontalBarChart(GroupedBarChart):
605
def type_to_url(self):
609
class GroupedVerticalBarChart(GroupedBarChart):
611
def type_to_url(self):
615
class PieChart(Chart):
617
def __init__(self, *args, **kwargs):
618
assert(type(self) != PieChart) # This is an abstract class
619
Chart.__init__(self, *args, **kwargs)
622
def set_pie_labels(self, labels):
623
self.pie_labels = labels
625
def get_url_bits(self):
626
url_bits = Chart.get_url_bits(self)
628
url_bits.append('chl=%s' % '|'.join(self.pie_labels))
632
class PieChart2D(PieChart):
634
def type_to_url(self):
638
class PieChart3D(PieChart):
640
def type_to_url(self):
644
class VennChart(Chart):
646
def type_to_url(self):
651
chart = GroupedVerticalBarChart(320, 200)
652
chart = PieChart2D(320, 200)
653
chart = ScatterChart(320, 200)
654
chart = SimpleLineChart(320, 200)
655
sine_data = [math.sin(float(a) / 10) * 2000 + 2000 for a in xrange(100)]
656
random_data = [a * random.random() * 30 for a in xrange(40)]
657
random_data2 = [random.random() * 4000 for a in xrange(10)]
658
# chart.set_bar_width(50)
659
# chart.set_bar_spacing(0)
660
chart.add_data(sine_data)
661
chart.add_data(random_data)
662
chart.add_data(random_data2)
663
# chart.set_line_style(1, thickness=2)
664
# chart.set_line_style(2, line_segment=10, blank_segment=5)
665
# chart.set_title('heloooo')
666
# chart.set_legend(('sine wave', 'random * x'))
667
# chart.set_colours(('ee2000', 'DDDDAA', 'fF03f2'))
668
# chart.fill_solid(Chart.BACKGROUND, '123456')
669
# chart.fill_linear_gradient(Chart.CHART, 20, '004070', 1, '300040', 0,
671
# chart.fill_linear_stripes(Chart.CHART, 20, '204070', .2, '300040', .2,
673
chart.set_axis_range(Axis.LEFT, 0, 10)
674
chart.set_axis_range(Axis.RIGHT, 5, 30)
675
chart.set_axis_labels(Axis.BOTTOM, [1, 25, 95])
676
chart.set_axis_positions(Axis.BOTTOM, [1, 25, 95])
677
chart.set_axis_style(Axis.BOTTOM, 'FFFFFF', 15)
679
# chart.set_pie_labels(('apples', 'oranges', 'bananas'))
681
# chart.set_grid(10, 10)
683
# for a in xrange(0, 100, 10):
684
# chart.add_marker(1, a, 'a', 'AACA20', 10)
686
chart.add_horizontal_range('00A020', .2, .5)
687
chart.add_vertical_range('00c030', .2, .4)
689
chart.add_fill_simple('303030A0')
691
chart.download('test.png')
693
url = chart.get_url()
696
data = urllib.urlopen(chart.get_url()).read()
697
open('meh.png', 'wb').write(data)
698
os.system('start meh.png')
701
if __name__ == '__main__':