line markers for line graphs
[imager-graph.git] / Graph.pm
CommitLineData
35574351 1package Imager::Graph;
54ada35d 2require 5.005;
35574351
TC
3
4=head1 NAME
5
6Imager::Graph - Perl extension for producing Graphs using the Imager library.
7
8=head1 SYNOPSIS
9
2eac77fc 10 use Imager::Graph::Sub_class;
11 my $chart = Imager::Graph::Sub_class->new;
81453d28 12 my $img = $chart->draw(data=> \@data, ...)
35574351
TC
13 or die $chart->error;
14
15=head1 DESCRIPTION
16
17Imager::Graph provides style information to its base classes. It
18defines the colors, text display information and fills based on both
19built-in styles and modifications supplied by the user to the draw()
20method.
21
35574351
TC
22=over
23
24=cut
25
26use strict;
27use vars qw($VERSION);
28use Imager qw(:handy);
bb0de914 29use Imager::Fountain;
35574351 30
68a6c9c6 31$VERSION = '0.06';
35574351 32
35574351
TC
33# the maximum recursion depth in determining a color, fill or number
34use constant MAX_DEPTH => 10;
35
36my $NUM_RE = '(?:[+-]?(?:\d+(?:\.\d*)?|\.\d+)(?:[eE][+-]\d+?)?)';
37
38=item new
39
40This is a simple constructor. No parameters required.
41
42=cut
43
44sub new {
45 bless {}, $_[0];
46}
47
2eac77fc 48=item set_graph_size($size)
dfd889da 49
50Sets the size of the graph (in pixels) within the image. The size of the image defaults to 1.5 * $graph_size.
51
52=cut
53
2eac77fc 54sub set_graph_size {
55 $_[0]->{'custom_style'}->{'size'} = $_[1];
dfd889da 56}
57
2eac77fc 58=item set_image_width($width)
dfd889da 59
60Sets the width of the image in pixels.
61
62=cut
63
2eac77fc 64sub set_image_width {
65 $_[0]->{'custom_style'}->{'width'} = $_[1];
dfd889da 66}
67
2eac77fc 68=item set_image_height($height)
dfd889da 69
70Sets the height of the image in pixels.
71
72=cut
73
2eac77fc 74sub set_image_height {
75 $_[0]->{'custom_style'}->{'height'} = $_[1];
dfd889da 76}
77
2eac77fc 78=item add_data_series([8, 6, 7, 5, 3, 0, 9], 'Series Name');
dfd889da 79
80Adds a data series to the graph. For L<Imager::Graph::Pie>, only one data series can be added.
81
82=cut
83
2eac77fc 84sub add_data_series {
dfd889da 85 my $self = shift;
86 my $data_ref = shift;
87 my $series_name = shift;
88
89 my $graph_data = $self->{'graph_data'} || [];
90
91 push @$graph_data, { data => $data_ref, series_name => $series_name };
92
93 $self->{'graph_data'} = $graph_data;
94 return;
95}
96
2eac77fc 97sub _get_data_series {
a17e870a
TC
98 my ($self, $opts) = @_;
99
100 # return the data supplied to draw() if any.
101 if ($opts->{data}) {
102 # one or multiple series?
103 my $data = $opts->{data};
104 if (@$data && ref $data->[0] && ref $data->[0] =~ /ARRAY/) {
105 return $data;
106 }
107 else {
108 return [ { data => $data } ];
109 }
110 }
111
112 return $self->{'graph_data'};
dfd889da 113}
114
2eac77fc 115=item set_labels(['label1', 'label2' ... ])
dfd889da 116
117Labels the specific data points. For line/bar graphs, this is the x-axis. For pie graphs, it is the label for the wedges.
118
119=cut
120
2eac77fc 121sub set_labels {
dfd889da 122 $_[0]->{'labels'} = $_[1];
123}
124
2eac77fc 125sub _get_labels {
a17e870a
TC
126 my ($self, $opts) = @_;
127
128 $opts->{labels}
129 and return $opts->{labels};
130
dfd889da 131 return $_[0]->{'labels'}
132}
133
2eac77fc 134=item set_title($title)
dfd889da 135
136Sets the title of the graph. Requires setting a font.
137
138=cut
139
2eac77fc 140sub set_title {
141 $_[0]->{'custom_style'}->{'title'}->{'text'} = $_[1];
dfd889da 142}
143
2eac77fc 144=item set_font($font)
dfd889da 145
146Sets the font to use for text. Takes an L<Imager::Font> object.
147
148=cut
149
2eac77fc 150sub set_font {
151 $_[0]->{'custom_style'}->{'font'} = $_[1];
dfd889da 152}
153
2eac77fc 154=item set_style($style_name)
dfd889da 155
156Sets the style to be used for the graph. Imager::Graph comes with several pre-defined styles: fount_lin (default), fount_rad, mono, primary_red, and primary.
157
158=cut
159
2eac77fc 160sub set_style {
dfd889da 161 $_[0]->{'style'} = $_[1];
162}
163
2eac77fc 164sub _get_style {
a17e870a
TC
165 my ($self, $opts) = @_;
166
167 $opts->{style}
168 and return $opts->{style};
169
170 return $self->{'style'};
dfd889da 171}
172
35574351
TC
173=item error
174
175Returns an error message. Only value if the draw() method returns false.
176
177=cut
178
179sub error {
180 $_[0]->{_errstr};
181}
182
183=item draw
184
185Creates a new image, draws the chart onto that image and returns it.
186
2eac77fc 187Optionally, instead of using the api methods to configure your chart,
188you can supply a C<data> parameter in the format
35574351
TC
189required by that particular graph, and if your graph will use any
190text, a C<font> parameter
191
192You can also supply many different parameters which control the way
193the graph looks. These are supplied as keyword, value pairs, where
194the value can be a hashref containing sub values.
195
196The C<style> parameter will selects a basic color set, and possibly
197sets other related parameters. See L</"STYLES">.
198
2eac77fc 199 my $font = Imager::Font->new(file => 'Im_ugly.ttf');
81453d28 200 my $img = $chart->draw(
201 data => \@data,
202 font => $font,
203 title => {
204 text => "Hello, World!",
205 size => 36,
206 color => 'FF0000'
207 }
208 );
35574351
TC
209
210When referring to a single sub-value this documentation will refer to
211'title.color' rather than 'the color element of title'.
212
213Returns the graph image on success, or false on failure.
214
215=back
216
217=head1 STYLES
218
219The currently defined styles are:
220
221=over
222
7b94e723
TC
223=item primary
224
225a light grey background with no outlines. Uses primary colors for the
226data fills.
227
35574351
TC
228=item primary_red
229
230a light red background with no outlines. Uses primary colors for the
7b94e723 231data fills.
35574351
TC
232
233Graphs drawn using this style should save well as a gif, even though
234some graphs may perform a slight blur.
235
7b94e723 236This was the default style, but the red was too loud.
35574351
TC
237
238=item mono
239
240designed for monochrome output, such as most laser printers, this uses
241hatched fills for the data, and no colors. The returned image is a
242one channel image (which can be overridden with the C<channels>
243parameter.)
244
245You can also override the colors used by all components for background
246or drawing by supplying C<fg> and/or C<bg> parameters. ie. if you
247supply C<<fg=>'FF0000', channels=>3>> then the hash fills and anything
248else will be drawn in red. Another use might be to set a transparent
249background, by supplying C<<bg=>'00000000', channels=>4>>.
250
251This style outlines the legend if present and outlines the hashed fills.
252
35574351
TC
253=item fount_lin
254
255designed as a "pretty" style this uses linear fountain fills for the
256background and data fills, and adds a drop shadow.
257
258You can override the value used for text and outlines by setting the
259C<fg> parameter.
260
81453d28 261This is the default style.
262
35574351
TC
263=item fount_rad
264
265also designed as a "pretty" style this uses radial fountain fills for
266the data and a linear blue to green fill for the background.
267
268=back
269
2eac77fc 270=head1 Style API
271
272To set or override styles, you can use the following methods:
273
274=over 4
275
276=item set_image_background
277
278=cut
279
280sub set_image_background {
281 $_[0]->{'custom_style'}->{'back'} = $_[1];
282}
283
284=item set_channels
285
286=cut
287
288sub set_channels {
289 $_[0]->{'custom_style'}->{'channels'} = $_[1];
290}
291
292=item set_line_color
293
294=cut
295
296sub set_line_color {
297 $_[0]->{'custom_style'}->{'line'} = $_[1];
298}
299
300=item set_title_font_size
301
302=cut
303
304sub set_title_font_size {
305 $_[0]->{'custom_style'}->{'title'}->{'size'} = $_[1];
306}
307
308=item set_title_font_color
309
310=cut
311
312sub set_title_font_color {
313 $_[0]->{'custom_style'}->{'title'}->{'color'} = $_[1];
314}
315
316=item set_title_horizontal_align
317
318=cut
319
320sub set_title_horizontal_align {
321 $_[0]->{'custom_style'}->{'title'}->{'halign'} = $_[1];
322}
323
324=item set_title_vertical_align
325
326=cut
327
328sub set_title_vertical_align {
329 $_[0]->{'custom_style'}->{'title'}->{'valign'} = $_[1];
330}
331
332=item set_text_font_color
333
334=cut
335
336sub set_text_font_color {
337 $_[0]->{'custom_style'}->{'text'}->{'color'} = $_[1];
338}
339
340=item set_text_font_size
341
342=cut
343
344sub set_text_font_size {
345 $_[0]->{'custom_style'}->{'text'}->{'size'} = $_[1];
346}
347
348=item set_graph_background_color
349
350=cut
351
352sub set_graph_background_color {
353 $_[0]->{'custom_style'}->{'bg'} = $_[1];
354}
355
356=item set_graph_foreground_color
357
358=cut
359
360sub set_graph_foreground_color {
361 $_[0]->{'custom_style'}->{'fg'} = $_[1];
362}
363
364=item set_legend_font_color
365
366=cut
367
368sub set_legend_font_color {
369 $_[0]->{'custom_style'}->{'legend'}->{'color'} = $_[1];
370}
371
372=item set_legend_font
373
374=cut
375
376sub set_legend_font {
377 $_[0]->{'custom_style'}->{'legend'}->{'font'} = $_[1];
378}
379
380=item set_legend_font_size
381
382=cut
383
384sub set_legend_font_size {
385 $_[0]->{'custom_style'}->{'legend'}->{'size'} = $_[1];
386}
387
388=item set_legend_patch_size
389
390=cut
391
392sub set_legend_patch_size {
393 $_[0]->{'custom_style'}->{'legend'}->{'patchsize'} = $_[1];
394}
395
396=item set_legend_patch_gap
397
398=cut
399
400sub set_legend_patch_gap {
401 $_[0]->{'custom_style'}->{'legend'}->{'patchgap'} = $_[1];
402}
403
404=item set_legend_horizontal_align
405
406=cut
407
408sub set_legend_horizontal_align {
409 $_[0]->{'custom_style'}->{'legend'}->{'halign'} = $_[1];
410}
411
412=item set_legend_vertical_align
413
414=cut
415
416sub set_legend_vertical_align {
417 $_[0]->{'custom_style'}->{'legend'}->{'valign'} = $_[1];
418}
419
420=item set_legend_padding
421
422=cut
423
424sub set_legend_padding {
425 $_[0]->{'custom_style'}->{'legend'}->{'padding'} = $_[1];
426}
427
428=item set_legend_outside_padding
429
430=cut
431
432sub set_legend_outside_padding {
433 $_[0]->{'custom_style'}->{'legend'}->{'outsidepadding'} = $_[1];
434}
435
436=item set_legend_fill
437
438=cut
439
440sub set_legend_fill {
441 $_[0]->{'custom_style'}->{'legend'}->{'fill'} = $_[1];
442}
443
444=item set_legend_border
445
446=cut
447
448sub set_legend_border {
449 $_[0]->{'custom_style'}->{'legend'}->{'border'} = $_[1];
450}
451
452=item set_legend_orientation
453
454=cut
455
456sub set_legend_orientation {
457 $_[0]->{'custom_style'}->{'legend'}->{'orientation'} = $_[1];
458}
459
460=item set_callout_font_color
461
462=cut
463
464sub set_callout_font_color {
465 $_[0]->{'custom_style'}->{'callout'}->{'color'} = $_[1];
466}
467
468=item set_callout_font
469
470=cut
471
472sub set_callout_font {
473 $_[0]->{'custom_style'}->{'callout'}->{'font'} = $_[1];
474}
475
476=item set_callout_font_size
477
478=cut
479
480sub set_callout_font_size {
481 $_[0]->{'custom_style'}->{'callout'}->{'size'} = $_[1];
482}
483
484=item set_callout_line_color
485
486=cut
487
488sub set_callout_line_color {
489 $_[0]->{'custom_style'}->{'callout'}->{'line'} = $_[1];
490}
491
492=item set_callout_leader_inside_length
493
494=cut
495
496sub set_callout_leader_inside_length {
497 $_[0]->{'custom_style'}->{'callout'}->{'inside'} = $_[1];
498}
499
500=item set_callout_leader_outside_length
501
502=cut
503
504sub set_callout_leader_outside_length {
505 $_[0]->{'custom_style'}->{'callout'}->{'outside'} = $_[1];
506}
507
508=item set_callout_leader_length
509
510=cut
511
512sub set_callout_leader_length {
513 $_[0]->{'custom_style'}->{'callout'}->{'leadlen'} = $_[1];
514}
515
516=item set_callout_gap
517
518=cut
519
520sub set_callout_gap {
521 $_[0]->{'custom_style'}->{'callout'}->{'gap'} = $_[1];
522}
523
524=item set_label_font_color
525
526=cut
527
528sub set_label_font_color {
529 $_[0]->{'custom_style'}->{'label'}->{'color'} = $_[1];
530}
531
532=item set_label_font
533
534=cut
535
536sub set_label_font {
537 $_[0]->{'custom_style'}->{'label'}->{'font'} = $_[1];
538}
539
540=item set_label_font_size
541
542=cut
543
544sub set_label_font_size {
545 $_[0]->{'custom_style'}->{'label'}->{'size'} = $_[1];
546}
547
548=item set_drop_shadow_fill_color
549
550=cut
551
552sub set_drop_shadow_fill_color {
553 $_[0]->{'custom_style'}->{'dropshadow'}->{'fill'} = $_[1];
554}
555
556=item set_drop_shadow_offset
557
558=cut
559
560sub set_drop_shadow_offset {
561 $_[0]->{'custom_style'}->{'dropshadow'}->{'off'} = $_[1];
562}
563
564=item set_drop_shadowXOffset
565
566=cut
567
568sub set_drop_shadowXOffset {
569 $_[0]->{'custom_style'}->{'dropshadow'}->{'offx'} = $_[1];
570}
571
572=item set_drop_shadowYOffset
573
574=cut
575
576sub set_drop_shadowYOffset {
577 $_[0]->{'custom_style'}->{'dropshadow'}->{'offy'} = $_[1];
578}
579
580=item set_drop_shadow_filter
581
582=cut
583
584sub set_drop_shadow_filter {
585 $_[0]->{'custom_style'}->{'dropshadow'}->{'filter'} = $_[1];
586}
587
588=item set_outline_color
589
590=cut
591
592sub set_outline_color {
593 $_[0]->{'custom_style'}->{'outline'}->{'line'} = $_[1];
594}
595
596=item set_data_area_fills
597
598=cut
599
600sub set_data_area_fills {
601 $_[0]->{'custom_style'}->{'fills'} = $_[1];
602}
603
604=item set_data_line_colors
605
606=cut
607
608sub set_data_line_colors {
609 $_[0]->{'custom_style'}->{'colors'} = $_[1];
610}
611
612=back
613
35574351
TC
614=head1 FEATURES
615
616Each graph type has a number of features. These are used to add
617various items that are displayed in the graph area. Some common
2eac77fc 618methods are:
619
620=over
621
622=item show_legend()
623
624adds a box containing boxes filled with the data filess, with
625the labels provided to the draw method. The legend will only be
626displayed if both the legend feature is enabled and labels are
627supplied.
628
629=cut
630
631sub show_legend {
632 $_[0]->{'custom_style'}->{'features'}->{'legend'} = 1;
633}
634
635=item show_outline()
636
637draws a border around the data areas.
638
639=cut
640
641sub show_outline {
642 $_[0]->{'custom_style'}->{'features'}->{'outline'} = 1;
643}
644
645=item show_labels()
646
647labels each data fill, usually by including text inside the data fill.
648If the text does not fit in the fill, they could be displayed in some
649other form, eg. as callouts in a pie graph. There usually isn't much
650point in including both labels and a legend.
651
652=cut
653
654sub show_labels {
655 $_[0]->{'custom_style'}->{'features'}->{'labels'} = 1;
656}
657
658=item show_drop_shadow()
659
660a simple drop shadow is shown behind some of the graph elements.
661
662=cut
663
664sub show_drop_shadow {
665 $_[0]->{'custom_style'}->{'features'}->{'dropshadow'} = 1;
666}
667
668=item reset_features()
669
670Unsets all of the features
671
672=cut
673
674sub reset_features {
675 $_[0]->{'custom_style'}->{'features'} = {};
676 $_[0]->{'custom_style'}->{'features'}->{'reset'} = 1;
677}
678
679=back
680
681Additionally, features can be set by passing them into the draw() method:
35574351
TC
682
683=over
684
685=item legend
686
687adds a box containing boxes filled with the data filess, with
688the labels provided to the draw method. The legend will only be
689displayed if both the legend feature is enabled and labels are
690supplied.
691
692=item labels
693
694labels each data fill, usually by including text inside the data fill.
695If the text does not fit in the fill, they could be displayed in some
696other form, eg. as callouts in a pie graph. There usually isn't much
697point in including both labels and a legend.
698
699=item dropshadow
700
701a simple drop shadow is shown behind some of the graph elements.
702
703=back
704
705Each graph also has features specific to that graph.
706
707=head1 COMMON PARAMETERS
708
709When referring to a single sub-value this documentation will refer to
710'title.color' rather than 'the color element of title'.
711
712Normally, except for the font parameter, these are controlled by
713styles, but these are the style parameters I'd mostly likely expect
714you want to use:
715
716=over
717
718=item font
719
720the Imager font object used to draw text on the chart.
721
722=item back
723
724the background fill for the graph. Default depends on the style.
725
726=item size
727
728the base size of the graph image. Default: 256
729
730=item width
731
732the width of the graph image. Default: 1.5 * size (384)
733
734=item height
735
736the height of the graph image. Default: size (256)
737
738=item channels
739
740the number of channels in the image. Default: 3 (the 'mono' style
741sets this to 1).
742
743=item line
744
745the color used for drawing lines, such as outlines or callouts.
746Default depends on the current style. Set to undef to remove the
747outline from a style.
748
749=item title
750
751the text used for a graph title. Default: no title. Note: this is
752the same as the title=>{ text => ... } field.
753
754=over
755
756=item halign
757
758horizontal alignment of the title in the graph, one of 'left',
759'center' or 'right'. Default: center
760
761=item valign
762
763vertical alignment of the title, one of 'top', 'center' or 'right'.
764Default: top. It's probably a bad idea to set this to 'center' unless
765you have a very short title.
766
767=back
768
769=item text
770
771This contains basic defaults used in drawing text.
772
773=over
774
775=item color
776
777the default color used for all text, defaults to the fg color.
778
779=item size
780
781the base size used for text, also used to scale many graph elements.
782Default: 14.
783
784=back
785
786=back
787
788=head1 BEYOND STYLES
789
790In most cases you will want to use just the styles, but you may want
791to exert more control over the way your chart looks. This section
792describes the options you can use to control the way your chart looks.
793
794Hopefully you don't need to read this.
795
796=over
797
798=item back
799
800The background of the graph.
801
802=item bg
803
804=item fg
805
806Used to define basic background and foreground colors for the graph.
807The bg color may be used for the background of the graph, and is used
808as a default for the background of hatcheed fills. The fg is used as
809the default for line and text colors.
810
811=item font
812
813The default font used by the graph. Normally you should supply this
814if your graph as any text.
815
816=item line
817
818The default line color.
819
820=item text
821
822defaults for drawing text. Other textual graph elements will inherit
823or modify these values.
824
825=over
826
827=item color
828
829default text color, defaults to the I<fg> color.
830
831=item size
832
833default text size. Default: 14. This is used to scale many graph
834elements, including padding and leader sizes. Other text elements
835will either use or scale this value.
836
837=item font
838
839default font object. Inherited from I<font>, which should have been
840supplied by the caller.
841
842=back
843
844=item title
845
846If you supply a scalar value for this element, it will be stored in
847the I<text> field.
848
849Defines the text, font and layout information for the title.
850
851=over
852
853=item color
854
855The color of the title, inherited from I<text.color>.
856
857=item font
858
859The font object used for the title, inherited from I<text.font>.
860
861=item size
862
863size of the title text. Default: double I<text.size>
864
865=item halign
866
867=item valign
868
869The horizontal and vertical alignment of the title.
870
871=back
872
873=item legend
874
875defines attributes of the graph legend, if present.
876
877=over
878
879=item color
880
881=item font
882
883=item size
884
885text attributes for the labels used in the legend.
886
887=item patchsize
888
889the width and height of the color patch in the legend. Defaults to
89090% of the legend text size.
891
892=item patchgap
893
894the minimum gap between patches in pixels. Defaults to 30% of the
895patchsize.
896
897=item patchborder
898
899the color of the border drawn around each patch. Inherited from I<line>.
900
901=item halign
902
903=item valign
904
905the horizontal and vertical alignment of the legend within the graph.
906Defaults to 'right' and 'top'.
907
908=item padding
909
910the gap between the legend patches and text and the outside of it's
911box, or to the legend border, if any.
912
913=item outsidepadding
914
915the gap between the border and the outside of the legend's box. This
916is only used if the I<legend.border> attribute is defined.
917
918=item fill
919
920the background fill for the legend. Default: none
921
922=item border
923
924the border color of the legend. Default: none (no border is drawn
925around the legend.)
926
33a928b7
TC
927=item orientation
928
929The orientation of the legend. If this is C<vertical> the the patches
930and labels are stacked on top of each other. If this is C<horizontal>
931the patchs and labels are word wrapped across the image. Default:
932vertical.
933
35574351
TC
934=back
935
33a928b7
TC
936For example to create a horizontal legend with borderless patches,
937darker than the background, you might do:
938
939 my $im = $chart->draw
940 (...,
941 legend =>
942 {
943 patchborder => undef,
944 orientation => 'horizontal',
945 fill => { solid => Imager::Color->new(0, 0, 0, 32), }
946 },
947 ...);
948
35574351
TC
949=item callout
950
951defines attributes for graph callouts, if any are present. eg. if the
952pie graph cannot fit the label into the pie graph segement it will
953present it as a callout.
954
955=over
956
957=item color
958
959=item font
960
961=item size
962
963the text attributes of the callout label. Inherited from I<text>.
964
965=item line
966
967the color of the callout lines. Inherited from I<line>
968
969=item inside
970
971=item outside
972
973the length of the leader on the inside and the outside of the fill,
974usually at some angle. Both default to the size of the callout text.
975
976=item leadlen
977
978the length of the horizontal portion of the leader. Default:
979I<callout.size>.
980
981=item gap
982
983the gap between the callout leader and the callout text. Defaults to
98430% of the text callout size.
985
986=back
987
988=item label
989
990defines attributes for labels drawn into the data areas of a graph.
991
992=over
993
994=item color
995
996=item font
997
998=item size
999
1000The text attributes of the labels. Inherited from I<text>.
1001
1002=back
1003
1004=item dropshadow
1005
1006the attributes of the graph's drop shadow
1007
1008=over
1009
1010=item fill
1011
1012the fill used for the drop shadow. Default: '404040' (dark gray)
1013
1014=item off
1015
1016the offset of the drop shadow. A convenience value inherited by offx
1017and offy. Default: 40% of I<text.size>.
1018
1019=item offx
1020
1021=item offy
1022
1023the horizontal and vertical offsets of the drop shadow. Both
1024inherited from I<dropshadow.off>.
1025
1026=item filter
1027
1028the filter description passed to Imager's filter method to blur the
1029drop shadow. Default: an 11 element convolution filter.
1030
1031=back
1032
1033=item outline
1034
1035describes the lines drawn around filled data areas, such as the
1036segments of a pie chart.
1037
1038=over
1039
1040=item line
1041
1042the line color of the outlines, inherited from I<line>.
1043
1044=back
1045
1046=item fills
1047
1048a reference to an array containing fills for each data item.
1049
1050You can mix fill types, ie. using a simple color for the first item, a
1051hatched fill for the second and a fountain fill for the next.
1052
1053=back
1054
1055=head1 HOW VALUES WORK
1056
1057Internally rather than specifying literal color, fill, or font objects
1058or literal sizes for each element, Imager::Graph uses a number of
1059special values to inherit or modify values taken from other graph
1060element names.
1061
1062=head2 Specifying colors
1063
1064You can specify colors by either supplying an Imager::Color object, by
1065supplying lookup of another color, or by supplying a single value that
1066Imager::Color::new can use as an initializer. The most obvious is
1067just a 6 or 8 digit hex value representing the red, green, blue and
1068optionally alpha channels of the image.
1069
1070You can lookup another color by using the lookup() "function", for
1071example if you give a color as "lookup(fg)" then Imager::Graph will
1072look for the fg element in the current style (or as overridden by
1073you.) This is used internally by Imager::Graph to set up the
1074relationships between the colors of various elements, for example the
1075default style information contains:
1076
1077 text=>{
d7fd5863 1078 color=>'lookup(fg)',
35574351
TC
1079 ...
1080 },
1081 legend =>{
d7fd5863 1082 color=>'lookup(text.color)',
35574351
TC
1083 ...
1084 },
1085
1086So by setting the I<fg> color, you also set the default text color,
1087since each text element uses lookup(text.color) as its value.
1088
1089=head2 Specifying fills
1090
1091Fills can be used for the graph background color, the background color
1092for the legend block and for the fills used for each data element.
1093
1094You can specify a fill as a L<color value|Specifying colors> or as a
33a928b7 1095general fill, see L<Imager::Fill> for details.
35574351
TC
1096
1097You don't need (or usually want) to call Imager::Fill::new yourself,
1098since the various fill functions will call it for you, and
1099Imager::Graph provides some hooks to make them more useful.
1100
1101=over
1102
1103=item *
1104
1105with hatched fills, if you don't supply a 'fg' or 'bg' parameter,
1106Imager::Graph will supply the current graph fg and bg colors.
1107
1108=item *
1109
1110with fountain fill, you can supply the xa_ratio, ya_ratio, xb_ratio
1111and yb_ratio parameters, and they will be scaled in the fill area to
1112define the fountain fills xa, ya, xb and yb parameters.
1113
1114=back
1115
1116As with colors, you can use lookup(name) or lookup(name1.name2) to
1117have one element to inherit the fill of another.
1118
33a928b7
TC
1119Imager::Graph defaults the fill combine value to C<'normal'>. This
1120doesn't apply to simple color fills.
1121
35574351
TC
1122=head2 Specifying numbers
1123
1124You can specify various numbers, usually representing the size of
1125something, commonly text, but sometimes the length of a line or the
1126size of a gap.
1127
1128You can use the same lookup mechanism as with colors and fills, but
1129you can also scale values. For example, 'scale(0.5,text.size)' will
1130return half the size of the normal text size.
1131
1132As with colors, this is used internally to scale graph elements based
1133on the base text size. If you change the base text size then other
1134graph elements will scale as well.
1135
1136=head2 Specifying other elements
1137
1138Other elements, such as fonts, or parameters for a filter, can also
1139use the lookup(name) mechanism.
1140
1141=head1 INTERNAL METHODS
1142
1143Only useful if you need to fix bugs, add features or create a new
1144graph class.
1145
1146=over
1147
1148=cut
1149
1150my %style_defs =
1151 (
1152 back=> 'lookup(bg)',
1153 line=> 'lookup(fg)',
1154 text=>{
d7fd5863 1155 color => 'lookup(fg)',
35574351 1156 font => 'lookup(font)',
d7fd5863
TC
1157 size => 14,
1158 },
35574351 1159 title=>{
d7fd5863 1160 color => 'lookup(text.color)',
35574351 1161 font => 'lookup(text.font)',
d7fd5863
TC
1162 halign => 'center',
1163 valign => 'top',
1164 size => 'scale(text.size,2.0)',
1165 },
35574351 1166 legend =>{
d7fd5863 1167 color => 'lookup(text.color)',
35574351 1168 font => 'lookup(text.font)',
d7fd5863
TC
1169 size => 'lookup(text.size)',
1170 patchsize => 'scale(legend.size,0.9)',
1171 patchgap => 'scale(legend.patchsize,0.3)',
1172 patchborder => 'lookup(line)',
1173 halign => 'right',
1174 valign => 'top',
1175 padding => 'scale(legend.size,0.3)',
1176 outsidepadding => 'scale(legend.padding,0.4)',
1177 },
35574351 1178 callout => {
d7fd5863 1179 color => 'lookup(text.color)',
35574351 1180 font => 'lookup(text.font)',
d7fd5863
TC
1181 size => 'lookup(text.size)',
1182 line => 'lookup(line)',
1183 inside => 'lookup(callout.size)',
1184 outside => 'lookup(callout.size)',
1185 leadlen => 'scale(0.8,callout.size)',
1186 gap => 'scale(callout.size,0.3)',
1187 },
35574351
TC
1188 label => {
1189 font => 'lookup(text.font)',
d7fd5863
TC
1190 size => 'lookup(text.size)',
1191 color => 'lookup(text.color)',
35574351
TC
1192 hpad => 'lookup(label.pad)',
1193 vpad => 'lookup(label.pad)',
1194 pad => 'scale(label.size,0.2)',
1195 pcformat => sub { sprintf "%s (%.0f%%)", $_[0], $_[1] },
1196 pconlyformat => sub { sprintf "%.1f%%", $_[0] },
d7fd5863 1197 },
35574351 1198 dropshadow => {
320f5a49 1199 fill => { solid => Imager::Color->new(0, 0, 0, 96) },
35574351
TC
1200 off => 'scale(0.4,text.size)',
1201 offx => 'lookup(dropshadow.off)',
1202 offy => 'lookup(dropshadow.off)',
1203 filter => { type=>'conv',
1204 # this needs a fairly heavy blur
1205 coef=>[0.1, 0.2, 0.4, 0.6, 0.7, 0.9, 1.2,
1206 0.9, 0.7, 0.6, 0.4, 0.2, 0.1 ] },
1207 },
1208 outline => {
1209 line =>'lookup(line)',
1210 },
1211 size=>256,
1212 width=>'scale(1.5,size)',
1213 height=>'lookup(size)',
1214 );
1215
1216=item _error($message)
1217
1218Sets the error field of the object and returns an empty list or undef,
1219depending on context. Should be used for error handling, since it may
1220provide some user hooks at some point.
1221
f68db40f
TC
1222The intended usage is:
1223
1224 some action
1225 or return $self->_error("error description");
1226
1227You should almost always return the result of _error() or return
1228immediately afterwards.
1229
35574351
TC
1230=cut
1231
1232sub _error {
1233 my ($self, $error) = @_;
1234
1235 $self->{_errstr} = $error;
1236
1237 return;
1238}
1239
1240
1241=item _style_defs()
1242
1243Returns the style defaults, such as the relationships between line
1244color and text color.
1245
1246Intended to be over-ridden by base classes to provide graph specific
1247defaults.
1248
1249=cut
1250
1251sub _style_defs {
1252 \%style_defs;
1253}
1254
81453d28 1255# Let's make the default something that looks really good, so folks will be interested enough to customize the style.
1256my $def_style = 'fount_lin';
35574351
TC
1257
1258my %styles =
1259 (
7b94e723
TC
1260 primary =>
1261 {
1262 fills=>
1263 [
1264 qw(FF0000 00FF00 0000FF C0C000 00C0C0 FF00FF)
1265 ],
1266 fg=>'000000',
2eac77fc 1267 negative_bg=>'EEEEEE',
7b94e723
TC
1268 bg=>'E0E0E0',
1269 legend=>
1270 {
1271 #patchborder=>'000000'
1272 },
1273 },
35574351
TC
1274 primary_red =>
1275 {
1276 fills=>
1277 [
1278 qw(FF0000 00FF00 0000FF C0C000 00C0C0 FF00FF)
1279 ],
1280 fg=>'000000',
2eac77fc 1281 negative_bg=>'EEEEEE',
35574351
TC
1282 bg=>'C08080',
1283 legend=>
1284 {
1285 patchborder=>'000000'
1286 },
1287 },
1288 mono =>
1289 {
1290 fills=>
1291 [
1292 { hatch=>'slash2' },
1293 { hatch=>'slosh2' },
1294 { hatch=>'vline2' },
1295 { hatch=>'hline2' },
1296 { hatch=>'cross2' },
1297 { hatch=>'grid2' },
1298 { hatch=>'stipple3' },
1299 { hatch=>'stipple2' },
1300 ],
1301 channels=>1,
1302 bg=>'FFFFFF',
1303 fg=>'000000',
2eac77fc 1304 negative_bg=>'EEEEEE',
35574351
TC
1305 features=>{ outline=>1 },
1306 pie =>{
1307 blur=>undef,
1308 },
1309 },
bb0de914 1310 fount_lin =>
35574351
TC
1311 {
1312 fills=>
1313 [
1314 { fountain=>'linear',
1315 xa_ratio=>0.13, ya_ratio=>0.13, xb_ratio=>0.87, yb_ratio=>0.87,
35574351 1316 segments => Imager::Fountain->simple(positions=>[0, 1],
d7fd5863 1317 colors=>[ NC('FFC0C0'), NC('FF0000') ]),
35574351
TC
1318 },
1319 { fountain=>'linear',
1320 xa_ratio=>0, ya_ratio=>0, xb_ratio=>1.0, yb_ratio=>1.0,
1321 segments => Imager::Fountain->simple(positions=>[0, 1],
d7fd5863 1322 colors=>[ NC('C0FFC0'), NC('00FF00') ]),
35574351
TC
1323 },
1324 { fountain=>'linear',
1325 xa_ratio=>0, ya_ratio=>0, xb_ratio=>1.0, yb_ratio=>1.0,
1326 segments => Imager::Fountain->simple(positions=>[0, 1],
d7fd5863 1327 colors=>[ NC('C0C0FF'), NC('0000FF') ]),
35574351
TC
1328 },
1329 { fountain=>'linear',
1330 xa_ratio=>0, ya_ratio=>0, xb_ratio=>1.0, yb_ratio=>1.0,
1331 segments => Imager::Fountain->simple(positions=>[0, 1],
d7fd5863 1332 colors=>[ NC('FFFFC0'), NC('FFFF00') ]),
35574351
TC
1333 },
1334 { fountain=>'linear',
1335 xa_ratio=>0, ya_ratio=>0, xb_ratio=>1.0, yb_ratio=>1.0,
1336 segments => Imager::Fountain->simple(positions=>[0, 1],
d7fd5863 1337 colors=>[ NC('C0FFFF'), NC('00FFFF') ]),
35574351
TC
1338 },
1339 { fountain=>'linear',
1340 xa_ratio=>0, ya_ratio=>0, xb_ratio=>1.0, yb_ratio=>1.0,
1341 segments => Imager::Fountain->simple(positions=>[0, 1],
d7fd5863 1342 colors=>[ NC('FFC0FF'), NC('FF00FF') ]),
35574351
TC
1343 },
1344 ],
dfd889da 1345 colors => [
1346 qw(FF0000 00FF00 0000FF C0C000 00C0C0 FF00FF)
1347 ],
8e140388
TC
1348 line_markers =>[
1349 { shape => 'circle', radius => 4 },
1350 { shape => 'square', radius => 4 },
1351 { shape => 'diamond', radius => 4 },
1352 { shape => 'triangle', radius => 4 },
1353 { shape => 'x', radius => 4 },
1354 { shape => 'plus', radius => 4 },
1355 ],
35574351
TC
1356 back=>{ fountain=>'linear',
1357 xa_ratio=>0, ya_ratio=>0,
1358 xb_ratio=>1.0, yb_ratio=>1.0,
1359 segments=>Imager::Fountain->simple
1360 ( positions=>[0, 1],
1361 colors=>[ NC('6060FF'), NC('60FF60') ]) },
1362 fg=>'000000',
2eac77fc 1363 negative_bg=>'EEEEEE',
35574351
TC
1364 bg=>'FFFFFF',
1365 features=>{ dropshadow=>1 },
bb0de914
TC
1366 },
1367 fount_rad =>
1368 {
35574351
TC
1369 fills=>
1370 [
1371 { fountain=>'radial',
1372 xa_ratio=>0.5, ya_ratio=>0.5, xb_ratio=>1.0, yb_ratio=>0.5,
1373 segments => Imager::Fountain->simple(positions=>[0, 1],
d7fd5863 1374 colors=>[ NC('FF8080'), NC('FF0000') ]),
35574351
TC
1375 },
1376 { fountain=>'radial',
1377 xa_ratio=>0.5, ya_ratio=>0.5, xb_ratio=>1.0, yb_ratio=>0.5,
1378 segments => Imager::Fountain->simple(positions=>[0, 1],
d7fd5863 1379 colors=>[ NC('80FF80'), NC('00FF00') ]),
35574351
TC
1380 },
1381 { fountain=>'radial',
1382 xa_ratio=>0.5, ya_ratio=>0.5, xb_ratio=>1.0, yb_ratio=>0.5,
1383 segments => Imager::Fountain->simple(positions=>[0, 1],
d7fd5863 1384 colors=>[ NC('808080FF'), NC('0000FF') ]),
35574351
TC
1385 },
1386 { fountain=>'radial',
1387 xa_ratio=>0.5, ya_ratio=>0.5, xb_ratio=>1.0, yb_ratio=>0.5,
1388 segments => Imager::Fountain->simple(positions=>[0, 1],
d7fd5863 1389 colors=>[ NC('FFFF80'), NC('FFFF00') ]),
35574351
TC
1390 },
1391 { fountain=>'radial',
1392 xa_ratio=>0.5, ya_ratio=>0.5, xb_ratio=>1.0, yb_ratio=>0.5,
1393 segments => Imager::Fountain->simple(positions=>[0, 1],
d7fd5863 1394 colors=>[ NC('80FFFF'), NC('00FFFF') ]),
35574351
TC
1395 },
1396 { fountain=>'radial',
1397 xa_ratio=>0.5, ya_ratio=>0.5, xb_ratio=>1.0, yb_ratio=>0.5,
1398 segments => Imager::Fountain->simple(positions=>[0, 1],
d7fd5863 1399 colors=>[ NC('FF80FF'), NC('FF00FF') ]),
35574351
TC
1400 },
1401 ],
dfd889da 1402 colors => [
1403 qw(FF0000 00FF00 0000FF C0C000 00C0C0 FF00FF)
1404 ],
35574351
TC
1405 back=>{ fountain=>'linear',
1406 xa_ratio=>0, ya_ratio=>0,
1407 xb_ratio=>1.0, yb_ratio=>1.0,
1408 segments=>Imager::Fountain->simple
1409 ( positions=>[0, 1],
1410 colors=>[ NC('6060FF'), NC('60FF60') ]) },
1411 fg=>'000000',
2eac77fc 1412 negative_bg=>'EEEEEE',
35574351 1413 bg=>'FFFFFF',
bb0de914
TC
1414 }
1415 );
35574351 1416
2eac77fc 1417$styles{'ocean'} = {
1418 fills => [
1419 {
1420 fountain =>'linear',
1421 xa_ratio => 0, ya_ratio=>0, xb_ratio=>1.0, yb_ratio=>1.0,
1422 segments => Imager::Fountain->simple(
1423 positions=>[0, 1],
1424 colors=>[ NC('FFFFFF'), NC('E6E2AF') ]),
1425 },
1426 {
1427 fountain =>'linear',
1428 xa_ratio => 0, ya_ratio=>0, xb_ratio=>1.0, yb_ratio=>1.0,
1429 segments => Imager::Fountain->simple(
1430 positions=>[0, 1],
1431 colors=>[ NC('FFFFFF'), NC('A7A37E') ]),
1432 },
1433 {
1434 fountain =>'linear',
1435 xa_ratio => 0, ya_ratio=>0, xb_ratio=>1.0, yb_ratio=>1.0,
1436 segments => Imager::Fountain->simple(
1437 positions=>[0, 1],
1438 colors=>[ NC('FFFFFF'), NC('80B4A2') ]),
1439 },
1440 {
1441 fountain =>'linear',
1442 xa_ratio => 0, ya_ratio=>0, xb_ratio=>1.0, yb_ratio=>1.0,
1443 segments => Imager::Fountain->simple(
1444 positions=>[0, 1],
1445 colors=>[ NC('FFFFFF'), NC('046380') ]),
1446 },
1447 {
1448 fountain =>'linear',
1449 xa_ratio => 0, ya_ratio=>0, xb_ratio=>1.0, yb_ratio=>1.0,
1450 segments => Imager::Fountain->simple(
1451 positions=>[0, 1],
1452 colors=>[ NC('FFFFFF'), NC('877EA7') ]),
1453 },
1454 {
1455 fountain =>'linear',
1456 xa_ratio => 0, ya_ratio=>0, xb_ratio=>1.0, yb_ratio=>1.0,
1457 segments => Imager::Fountain->simple(
1458 positions=>[0, 1],
1459 colors=>[ NC('FFFFFF'), NC('67A35E') ]),
1460 },
1461 {
1462 fountain =>'linear',
1463 xa_ratio => 0, ya_ratio=>0, xb_ratio=>1.0, yb_ratio=>1.0,
1464 segments => Imager::Fountain->simple(
1465 positions=>[0, 1],
1466 colors=>[ NC('FFFFFF'), NC('B4726F') ]),
1467 },
1468 ],
1469 colors => [
1470 qw(E6E2AF A7A37E 80B4A2 046380 877EA7 67A35E B4726F)
1471 ],
1472 fg=>'000000',
1473 negative_bg=>'EEEEEE',
1474 bg=>'FFFFFF',
1475 features=>{ dropshadow=>1 },
1476
1477};
1478
35574351
TC
1479=item $self->_style_setup(\%opts)
1480
1481Uses the values from %opts to build a customized hash describing the
1482way the graph should be drawn.
1483
1484=cut
1485
1486sub _style_setup {
1487 my ($self, $opts) = @_;
1488 my $style_defs = $self->_style_defs;
1489 my $style;
dfd889da 1490
2eac77fc 1491 my $pre_def_style = $self->_get_style($opts);
1492 my $api_style = $self->{'custom_style'} || {};
dfd889da 1493 $style = $styles{$pre_def_style} if $pre_def_style;
1494
35574351
TC
1495 $style ||= $styles{$def_style};
1496
2eac77fc 1497 my @search_list = ( $style_defs, $style, $api_style, $opts);
35574351
TC
1498 my %work;
1499
1500 my @composite = $self->_composite();
1501 my %composite;
1502 @composite{@composite} = @composite;
1503
1504 for my $src (@search_list) {
1505 for my $key (keys %$src) {
1506 if ($composite{$key}) {
1507 $work{$key} = {} unless exists $work{$key};
1508 if (ref $src->{$key}) {
1509 # some keys have sub values, especially text
1510 @{$work{$key}}{keys %{$src->{$key}}} = values %{$src->{$key}};
1511 }
1512 else {
1513 # assume it's the text for a title or something
1514 $work{$key}{text} = $src->{$key};
1515 }
1516 }
1517 else {
a17e870a
TC
1518 $work{$key} = $src->{$key}
1519 if defined $src->{$key}; # $opts with pmichauds new accessor handling
35574351
TC
1520 }
1521 }
1522 }
1523
1524 # features are handled specially
1525 $work{features} = {};
1526 for my $src (@search_list) {
1527 if ($src->{features}) {
1528 if (ref $src->{features}) {
1529 if (ref($src->{features}) =~ /ARRAY/) {
1530 # just set those features
1531 for my $feature (@{$src->{features}}) {
1532 $work{features}{$feature} = 1;
1533 }
1534 }
1535 elsif (ref($src->{features}) =~ /HASH/) {
1536 if ($src->{features}{reset}) {
1537 $work{features} = {}; # only the ones the user specifies
1538 }
1539 @{$work{features}}{keys %{$src->{features}}} =
1540 values(%{$src->{features}});
1541 }
1542 }
1543 else {
1544 # just set that single feature
1545 $work{features}{$src->{features}} = 1;
1546 }
1547 }
1548 }
1549 #use Data::Dumper;
1550 #print Dumper(\%work);
1551
1552 $self->{_style} = \%work;
1553}
1554
1555=item $self->_get_thing($name)
1556
1557Retrieve some general 'thing'.
1558
1559Supports the 'lookup(foo)' mechanism.
1560
f68db40f
TC
1561Returns an empty list on failure.
1562
35574351
TC
1563=cut
1564
1565sub _get_thing {
1566 my ($self, $name, @depth) = @_;
1567
1568 push(@depth, $name);
1569 my $what;
1570 if ($name =~ /^(\w+)\.(\w+)$/) {
1571 $what = $self->{_style}{$1}{$2};
1572 }
1573 else {
1574 $what = $self->{_style}{$name};
1575 }
1576 defined $what or
1577 return;
1578 if (ref $what) {
1579 return $what;
1580 }
1581 elsif ($what =~ /^lookup\((\w+(?:\.\w+)?)\)$/) {
1582 @depth < MAX_DEPTH
1583 or return $self->_error("too many levels of recursion in lookup(@depth)");
1584 return $self->_get_thing($1, @depth);
1585 }
1586 else {
1587 return $what;
1588 }
1589}
1590
1591=item $self->_get_number($name)
1592
1593Retrieves a number from the style. The value in the style can be the
1594number, or one of two functions:
1595
1596=over
1597
1598=item lookup(newname)
1599
1600Recursively looks up I<newname> in the style.
1601
1602=item scale(value1,value2)
1603
33a928b7 1604Each value can be a number or a name. Names are recursively looked up
35574351
TC
1605in the style and the product is returned.
1606
1607=back
1608
1609=cut
bb0de914 1610
35574351
TC
1611sub _get_number {
1612 my ($self, $name, @depth) = @_;
1613
1614 push(@depth, $name);
1615 my $what;
1616 if ($name =~ /^(\w+)\.(\w+)$/) {
1617 $what = $self->{_style}{$1}{$2};
1618 }
1619 else {
1620 $what = $self->{_style}{$name};
1621 }
1622 defined $what or
1623 return $self->_error("$name is undef (@depth)");
1624
1625 if (ref $what) {
1626 if ($what =~ /CODE/) {
1627 $what = $what->($self, $name);
1628 }
1629 }
1630 else {
1631 if ($what =~ /^lookup\(([\w.]+)\)$/) {
1632 @depth < MAX_DEPTH
d7fd5863 1633 or return $self->_error("too many levels of recursion in lookup (@depth)");
35574351
TC
1634 return $self->_get_number($1, @depth);
1635 }
1636 elsif ($what =~ /^scale\(
d7fd5863 1637 ((?:[a-z][\w.]*)|$NUM_RE)
35574351 1638 ,
d7fd5863 1639 ((?:[a-z][\w.]*)|$NUM_RE)\)$/x) {
35574351
TC
1640 my ($left, $right) = ($1, $2);
1641 unless ($left =~ /^$NUM_RE$/) {
d7fd5863
TC
1642 @depth < MAX_DEPTH
1643 or return $self->_error("too many levels of recursion in scale (@depth)");
1644 $left = $self->_get_number($left, @depth);
35574351
TC
1645 }
1646 unless ($right =~ /^$NUM_RE$/) {
d7fd5863
TC
1647 @depth < MAX_DEPTH
1648 or return $self->_error("too many levels of recursion in scale (@depth)");
1649 $right = $self->_get_number($right, @depth);
35574351
TC
1650 }
1651 return $left * $right;
1652 }
1653 else {
1654 return $what+0;
1655 }
1656 }
1657}
1658
379c5b02
TC
1659=item $self->_get_integer($name)
1660
1661Retrieves an integer from the style. This is a simple wrapper around
1662_get_number() that rounds the result to an integer.
1663
f68db40f
TC
1664Returns an empty list on failure.
1665
379c5b02
TC
1666=cut
1667
1668sub _get_integer {
1669 my ($self, $name, @depth) = @_;
1670
1671 my $number = $self->_get_number($name, @depth)
1672 or return;
1673
1674 return sprintf("%.0f", $number);
1675}
1676
35574351
TC
1677=item _get_color($name)
1678
1679Returns a color object of the given name from the style hash.
1680
1681Uses Imager::Color->new to translate normal scalars into color objects.
1682
1683Allows the lookup(name) mechanism.
1684
f68db40f
TC
1685Returns an empty list on failure.
1686
35574351
TC
1687=cut
1688
1689sub _get_color {
1690 my ($self, $name, @depth) = @_;
1691
1692 push(@depth, $name);
1693 my $what;
1694 if ($name =~ /^(\w+)\.(\w+)$/) {
1695 $what = $self->{_style}{$1}{$2};
1696 }
1697 else {
1698 $what = $self->{_style}{$name};
1699 }
1700
1701 defined($what)
1702 or return $self->_error("$name was undefined (@depth)");
1703
1704 unless (ref $what) {
1705 if ($what =~ /^lookup\((\w+(?:\.\w+)?)\)$/) {
1706 @depth < MAX_DEPTH or
d7fd5863 1707 return $self->_error("too many levels of recursion in lookup (@depth)");
35574351
TC
1708
1709 return $self->_get_color($1, @depth);
1710 }
1711 $what = Imager::Color->new($what);
1712 }
1713
1714 $what;
1715}
1716
1717=item _translate_fill($what, $box)
1718
1719Given the value of a fill, either attempts to convert it into a fill
1720list (one of C<<color=>$color_value, filled=>1>> or C<<fill=>{ fill
1721parameters }>>), or to lookup another fill that is referred to with
1722the 'lookup(name)' mechanism.
1723
1724This function does the fg and bg initialization for hatched fills, and
1725translation of *_ratio for fountain fills (using the $box parameter).
1726
f68db40f
TC
1727Returns an empty list on failure.
1728
35574351
TC
1729=cut
1730
1731sub _translate_fill {
1732 my ($self, $what, $box, @depth) = @_;
1733
1734 if (ref $what) {
1735 if (UNIVERSAL::isa($what, "Imager::Color")) {
1736 return ( color=>Imager::Color->new($what), filled=>1 );
1737 }
1738 else {
1739 # a general fill
33a928b7
TC
1740 # default to normal combine mode
1741 my %work = ( combine => 'normal', %$what );
35574351 1742 if ($what->{hatch}) {
d7fd5863
TC
1743 if (!$work{fg}) {
1744 $work{fg} = $self->_get_color('fg')
1745 or return;
1746 }
1747 if (!$work{bg}) {
1748 $work{bg} = $self->_get_color('bg')
1749 or return;
1750 }
1751 return ( fill=>\%work );
35574351
TC
1752 }
1753 elsif ($what->{fountain}) {
d7fd5863
TC
1754 for my $key (qw(xa ya xb yb)) {
1755 if (exists $work{"${key}_ratio"}) {
1756 if ($key =~ /^x/) {
1757 $work{$key} = $box->[0] + $work{"${key}_ratio"}
1758 * ($box->[2] - $box->[0]);
1759 }
1760 else {
1761 $work{$key} = $box->[1] + $work{"${key}_ratio"}
1762 * ($box->[3] - $box->[1]);
1763 }
1764 }
1765 }
1766 return ( fill=>\%work );
35574351
TC
1767 }
1768 else {
d7fd5863 1769 return ( fill=> \%work );
35574351
TC
1770 }
1771 }
1772 }
1773 else {
1774 if ($what =~ /^lookup\((\w+(?:\.\w+)?)\)$/) {
1775 return $self->_get_fill($1, $box, @depth);
1776 }
1777 else {
1778 # assumed to be an Imager::Color single value
1779 return ( color=>Imager::Color->new($what), filled=>1 );
1780 }
1781 }
1782}
1783
1784=item _data_fill($index, $box)
1785
1786Retrieves the fill parameters for a data area fill.
1787
1788=cut
1789
1790sub _data_fill {
1791 my ($self, $index, $box) = @_;
1792
1793 my $fills = $self->{_style}{fills};
1794 return $self->_translate_fill($fills->[$index % @$fills], $box,
1795 "data.$index");
1796}
1797
dfd889da 1798sub _data_color {
1799 my ($self, $index) = @_;
1800
1801 my $colors = $self->{'_style'}{'colors'} || [];
1802 my $fills = $self->{'_style'}{'fills'} || [];
1803
1804 # Try to just use a fill, so non-fountain styles don't need
1805 # to have a duplicated set of fills and colors
1806 my $fill = $fills->[$index % @$fills];
1807 if (!ref $fill) {
1808 return $fill;
1809 }
1810
1811 if (@$colors) {
1812 return $colors->[$index % @$colors] || '000000';
1813 }
1814 return '000000';
1815}
1816
35574351
TC
1817=item _get_fill($index, $box)
1818
1819Retrieves fill parameters for a named fill.
1820
1821=cut
1822
1823sub _get_fill {
1824 my ($self, $name, $box, @depth) = @_;
1825
1826 push(@depth, $name);
1827 my $what;
1828 if ($name =~ /^(\w+)\.(\w+)$/) {
1829 $what = $self->{_style}{$1}{$2};
1830 }
1831 else {
1832 $what = $self->{_style}{$name};
1833 }
1834
1835 defined($what)
1836 or return $self->_error("no fill $name found");
1837
1838 return $self->_translate_fill($what, $box, @depth);
1839}
1840
1841=item _make_img()
1842
1843Builds the image object for the graph and fills it with the background
1844fill.
1845
1846=cut
1847
1848sub _make_img {
1849 my ($self) = @_;
35574351 1850
81453d28 1851 my $width = $self->_get_number('width') || 256;
1852 my $height = $self->_get_number('height') || 256;
35574351
TC
1853 my $channels = $self->{_style}{channels};
1854
1855 $channels ||= 3;
1856
1857 my $img = Imager->new(xsize=>$width, ysize=>$height, channels=>$channels);
1858
1859 $img->box($self->_get_fill('back', [ 0, 0, $width-1, $height-1]));
1860
1861 $img;
1862}
1863
2eac77fc 1864sub _get_image {
1865 my $self = shift;
1866
1867 if (!$self->{'_image'}) {
1868 $self->{'_image'} = $self->_make_img();
1869 }
1870 return $self->{'_image'};
1871}
1872
f68db40f
TC
1873=item _text_style($name)
1874
1875Returns parameters suitable for calls to Imager::Font's bounding_box()
1876and draw() methods intended for use in defining text styles.
1877
1878Returns an empty list on failure.
1879
1880=cut
1881
35574351
TC
1882sub _text_style {
1883 my ($self, $name) = @_;
1884
1885 my %work;
1886
1887 if ($self->{_style}{$name}) {
1888 %work = %{$self->{_style}{$name}};
1889 }
1890 else {
1891 %work = %{$self->{_style}{text}};
1892 }
1893 $work{font}
5d622bb8 1894 or return $self->_error("$name has no font parameter");
35574351
TC
1895
1896 $work{font} = $self->_get_thing("$name.font")
5d622bb8 1897 or return $self->_error("No $name.font defined, either set $name.font or font to a font");
35574351
TC
1898 UNIVERSAL::isa($work{font}, "Imager::Font")
1899 or return $self->_error("$name.font is not a font");
1900 if ($work{color} && !ref $work{color}) {
1901 $work{color} = $self->_get_color("$name.color")
1902 or return;
1903 }
1904 $work{size} = $self->_get_number("$name.size");
1905 $work{sizew} = $self->_get_number("$name.sizew")
1906 if $work{sizew};
1907
1908 %work;
1909}
1910
f68db40f
TC
1911=item _text_bbox($text, $name)
1912
1913Returns a bounding box for the specified $text as styled by $name.
1914
1915Returns an empty list on failure.
1916
1917=cut
1918
35574351
TC
1919sub _text_bbox {
1920 my ($self, $text, $name) = @_;
1921
5d622bb8
TC
1922 my %text_info = $self->_text_style($name)
1923 or return;
35574351
TC
1924
1925 my @bbox = $text_info{font}->bounding_box(%text_info, string=>$text,
d7fd5863 1926 canon=>1);
35574351
TC
1927
1928 return @bbox[0..3];
1929}
1930
1931sub _align_box {
1932 my ($self, $box, $chart_box, $name) = @_;
1933
1934 my $halign = $self->{_style}{$name}{halign}
1935 or $self->_error("no halign for $name");
1936 my $valign = $self->{_style}{$name}{valign};
1937
1938 if ($halign eq 'right') {
1939 $box->[0] += $chart_box->[2] - $box->[2];
1940 }
1941 elsif ($halign eq 'left') {
1942 $box->[0] = $chart_box->[0];
1943 }
1944 elsif ($halign eq 'center' || $halign eq 'centre') {
1945 $box->[0] = ($chart_box->[0] + $chart_box->[2] - $box->[2])/2;
1946 }
1947 else {
1948 return $self->_error("invalid halign $halign for $name");
1949 }
1950
1951 if ($valign eq 'top') {
1952 $box->[1] = $chart_box->[1];
1953 }
1954 elsif ($valign eq 'bottom') {
1955 $box->[1] = $chart_box->[3] - $box->[3];
1956 }
1957 elsif ($valign eq 'center' || $valign eq 'centre') {
1958 $box->[1] = ($chart_box->[1] + $chart_box->[3] - $box->[3])/2;
1959 }
1960 else {
1961 return $self->_error("invalid valign $valign for $name");
1962 }
1963 $box->[2] += $box->[0];
1964 $box->[3] += $box->[1];
1965}
1966
1967sub _remove_box {
1968 my ($self, $chart_box, $object_box) = @_;
1969
1970 my $areax;
1971 my $areay;
1972 if ($object_box->[0] - $chart_box->[0]
1973 < $chart_box->[2] - $object_box->[2]) {
1974 $areax = ($object_box->[2] - $chart_box->[0])
1975 * ($chart_box->[3] - $chart_box->[1]);
1976 }
1977 else {
1978 $areax = ($chart_box->[2] - $object_box->[0])
1979 * ($chart_box->[3] - $chart_box->[1]);
1980 }
1981
1982 if ($object_box->[1] - $chart_box->[1]
1983 < $chart_box->[3] - $object_box->[3]) {
1984 $areay = ($object_box->[3] - $chart_box->[1])
1985 * ($chart_box->[2] - $chart_box->[0]);
1986 }
1987 else {
1988 $areay = ($chart_box->[3] - $object_box->[1])
1989 * ($chart_box->[2] - $chart_box->[0]);
1990 }
1991
1992 if ($areay < $areax) {
1993 if ($object_box->[1] - $chart_box->[1]
d7fd5863 1994 < $chart_box->[3] - $object_box->[3]) {
35574351
TC
1995 $chart_box->[1] = $object_box->[3];
1996 }
1997 else {
1998 $chart_box->[3] = $object_box->[1];
1999 }
2000 }
2001 else {
2002 if ($object_box->[0] - $chart_box->[0]
d7fd5863 2003 < $chart_box->[2] - $object_box->[2]) {
35574351
TC
2004 $chart_box->[0] = $object_box->[2];
2005 }
2006 else {
2007 $chart_box->[2] = $object_box->[0];
2008 }
2009 }
2010}
2011
2012sub _draw_legend {
2013 my ($self, $img, $labels, $chart_box) = @_;
2014
33a928b7
TC
2015 my $orient = $self->_get_thing('legend.orientation');
2016 defined $orient or $orient = 'vertical';
2017
2018 if ($orient eq 'vertical') {
2019 return $self->_draw_legend_vertical($img, $labels, $chart_box);
2020 }
2021 elsif ($orient eq 'horizontal') {
2022 return $self->_draw_legend_horizontal($img, $labels, $chart_box);
2023 }
2024 else {
2025 return $self->_error("Unknown legend.orientation $orient");
2026 }
2027}
2028
2029sub _draw_legend_horizontal {
2030 my ($self, $img, $labels, $chart_box) = @_;
2031
2032 defined(my $padding = $self->_get_integer('legend.padding'))
2033 or return;
2034 my $patchsize = $self->_get_integer('legend.patchsize')
2035 or return;
2036 defined(my $gap = $self->_get_integer('legend.patchgap'))
2037 or return;
2038
2039 my $minrowsize = $patchsize + $gap;
2040 my ($width, $height) = (0,0);
2041 my $row_height = $minrowsize;
2042 my $pos = 0;
2043 my @sizes;
2044 my @offsets;
2045 for my $label (@$labels) {
5d622bb8
TC
2046 my @text_box = $self->_text_bbox($label, 'legend')
2047 or return;
33a928b7
TC
2048 push(@sizes, \@text_box);
2049 my $entry_width = $patchsize + $gap + $text_box[2];
2050 if ($pos == 0) {
2051 # never re-wrap the first entry
2052 push @offsets, [ 0, $height ];
2053 }
2054 else {
2055 if ($pos + $gap + $entry_width > $chart_box->[2]) {
d7fd5863
TC
2056 $pos = 0;
2057 $height += $row_height;
33a928b7
TC
2058 }
2059 push @offsets, [ $pos, $height ];
2060 }
2061 my $entry_right = $pos + $entry_width;
2062 $pos += $gap + $entry_width;
2063 $entry_right > $width and $width = $entry_right;
2064 if ($text_box[3] > $row_height) {
2065 $row_height = $text_box[3];
2066 }
2067 }
2068 $height += $row_height;
2069 my @box = ( 0, 0, $width + $padding * 2, $height + $padding * 2 );
2070 my $outsidepadding = 0;
2071 if ($self->{_style}{legend}{border}) {
2072 defined($outsidepadding = $self->_get_integer('legend.outsidepadding'))
2073 or return;
2074 $box[2] += 2 * $outsidepadding;
2075 $box[3] += 2 * $outsidepadding;
2076 }
2077 $self->_align_box(\@box, $chart_box, 'legend')
2078 or return;
2079 if ($self->{_style}{legend}{fill}) {
2080 $img->box(xmin=>$box[0]+$outsidepadding,
2081 ymin=>$box[1]+$outsidepadding,
2082 xmax=>$box[2]-$outsidepadding,
2083 ymax=>$box[3]-$outsidepadding,
d7fd5863 2084 $self->_get_fill('legend.fill', \@box));
33a928b7
TC
2085 }
2086 $box[0] += $outsidepadding;
2087 $box[1] += $outsidepadding;
2088 $box[2] -= $outsidepadding;
2089 $box[3] -= $outsidepadding;
2090 my %text_info = $self->_text_style('legend')
2091 or return;
2092 my $patchborder;
2093 if ($self->{_style}{legend}{patchborder}) {
2094 $patchborder = $self->_get_color('legend.patchborder')
2095 or return;
2096 }
2097
2098 my $dataindex = 0;
2099 for my $label (@$labels) {
2100 my ($left, $top) = @{$offsets[$dataindex]};
2101 $left += $box[0] + $padding;
2102 $top += $box[1] + $padding;
2103 my $textpos = $left + $patchsize + $gap;
2104 my @patchbox = ( $left, $top,
2105 $left + $patchsize, $top + $patchsize );
2106 my @fill = $self->_data_fill($dataindex, \@patchbox)
2107 or return;
2108 $img->box(xmin=>$left, ymin=>$top, xmax=>$left + $patchsize,
d7fd5863 2109 ymax=>$top + $patchsize, @fill);
33a928b7
TC
2110 if ($self->{_style}{legend}{patchborder}) {
2111 $img->box(xmin=>$left, ymin=>$top, xmax=>$left + $patchsize,
d7fd5863
TC
2112 ymax=>$top + $patchsize,
2113 color=>$patchborder);
33a928b7
TC
2114 }
2115 $img->string(%text_info, x=>$textpos, 'y'=>$top + $patchsize,
2116 text=>$label);
2117
2118 ++$dataindex;
2119 }
2120 if ($self->{_style}{legend}{border}) {
2121 my $border_color = $self->_get_color('legend.border')
2122 or return;
2123 $img->box(xmin=>$box[0], ymin=>$box[1], xmax=>$box[2], ymax=>$box[3],
d7fd5863 2124 color=>$border_color);
33a928b7
TC
2125 }
2126 $self->_remove_box($chart_box, \@box);
2127 1;
2128}
2129
2130sub _draw_legend_vertical {
2131 my ($self, $img, $labels, $chart_box) = @_;
2132
379c5b02 2133 defined(my $padding = $self->_get_integer('legend.padding'))
35574351 2134 or return;
379c5b02 2135 my $patchsize = $self->_get_integer('legend.patchsize')
35574351 2136 or return;
379c5b02 2137 defined(my $gap = $self->_get_integer('legend.patchgap'))
35574351
TC
2138 or return;
2139 my $minrowsize = $patchsize + $gap;
2140 my ($width, $height) = (0,0);
2141 my @sizes;
2142 for my $label (@$labels) {
5d622bb8
TC
2143 my @box = $self->_text_bbox($label, 'legend')
2144 or return;
35574351
TC
2145 push(@sizes, \@box);
2146 $width = $box[2] if $box[2] > $width;
2147 if ($minrowsize > $box[3]) {
2148 $height += $minrowsize;
2149 }
2150 else {
2151 $height += $box[3];
2152 }
2153 }
2154 my @box = (0, 0,
d7fd5863
TC
2155 $width + $patchsize + $padding * 2 + $gap,
2156 $height + $padding * 2 - $gap);
35574351
TC
2157 my $outsidepadding = 0;
2158 if ($self->{_style}{legend}{border}) {
33a928b7 2159 defined($outsidepadding = $self->_get_integer('legend.outsidepadding'))
35574351
TC
2160 or return;
2161 $box[2] += 2 * $outsidepadding;
2162 $box[3] += 2 * $outsidepadding;
2163 }
2164 $self->_align_box(\@box, $chart_box, 'legend')
2165 or return;
2166 if ($self->{_style}{legend}{fill}) {
2167 $img->box(xmin=>$box[0]+$outsidepadding,
2168 ymin=>$box[1]+$outsidepadding,
2169 xmax=>$box[2]-$outsidepadding,
2170 ymax=>$box[3]-$outsidepadding,
d7fd5863 2171 $self->_get_fill('legend.fill', \@box));
35574351
TC
2172 }
2173 $box[0] += $outsidepadding;
2174 $box[1] += $outsidepadding;
2175 $box[2] -= $outsidepadding;
2176 $box[3] -= $outsidepadding;
2177 my $ypos = $box[1] + $padding;
2178 my $patchpos = $box[0]+$padding;
2179 my $textpos = $patchpos + $patchsize + $gap;
2180 my %text_info = $self->_text_style('legend')
2181 or return;
2182 my $patchborder;
2183 if ($self->{_style}{legend}{patchborder}) {
2184 $patchborder = $self->_get_color('legend.patchborder')
2185 or return;
2186 }
2187 my $dataindex = 0;
2188 for my $label (@$labels) {
2189 my @patchbox = ( $patchpos - $patchsize/2, $ypos - $patchsize/2,
2190 $patchpos + $patchsize * 3 / 2, $ypos + $patchsize*3/2 );
2eac77fc 2191
2192 my @fill;
2193 if ($self->_draw_flat_legend()) {
2194 @fill = (color => $self->_data_color($dataindex), filled => 1);
2195 }
2196 else {
2197 @fill = $self->_data_fill($dataindex, \@patchbox)
2198 or return;
2199 }
35574351 2200 $img->box(xmin=>$patchpos, ymin=>$ypos, xmax=>$patchpos + $patchsize,
d7fd5863 2201 ymax=>$ypos + $patchsize, @fill);
35574351
TC
2202 if ($self->{_style}{legend}{patchborder}) {
2203 $img->box(xmin=>$patchpos, ymin=>$ypos, xmax=>$patchpos + $patchsize,
d7fd5863
TC
2204 ymax=>$ypos + $patchsize,
2205 color=>$patchborder);
35574351
TC
2206 }
2207 $img->string(%text_info, x=>$textpos, 'y'=>$ypos + $patchsize,
2208 text=>$label);
2209
2210 my $step = $patchsize + $gap;
2211 if ($minrowsize < $sizes[$dataindex][3]) {
2212 $ypos += $sizes[$dataindex][3];
2213 }
2214 else {
2215 $ypos += $minrowsize;
2216 }
2217 ++$dataindex;
2218 }
2219 if ($self->{_style}{legend}{border}) {
2220 my $border_color = $self->_get_color('legend.border')
2221 or return;
2222 $img->box(xmin=>$box[0], ymin=>$box[1], xmax=>$box[2], ymax=>$box[3],
d7fd5863 2223 color=>$border_color);
35574351
TC
2224 }
2225 $self->_remove_box($chart_box, \@box);
2226 1;
2227}
2228
2229sub _draw_title {
2230 my ($self, $img, $chart_box) = @_;
2231
2232 my $title = $self->{_style}{title}{text};
5d622bb8
TC
2233 my @box = $self->_text_bbox($title, 'title')
2234 or return;
35574351
TC
2235 my $yoff = $box[1];
2236 @box[0,1] = (0,0);
2237 $self->_align_box(\@box, $chart_box, 'title');
5d622bb8
TC
2238 my %text_info = $self->_text_style('title')
2239 or return;
35574351
TC
2240 $img->string(%text_info, x=>$box[0], 'y'=>$box[3] + $yoff, text=>$title);
2241 $self->_remove_box($chart_box, \@box);
2242 1;
2243}
2244
2245sub _small_extent {
2246 my ($self, $box) = @_;
2247
2248 if ($box->[2] - $box->[0] > $box->[3] - $box->[1]) {
2249 return $box->[3] - $box->[1];
2250 }
2251 else {
2252 return $box->[2] - $box->[0];
2253 }
2254}
2255
2eac77fc 2256sub _draw_flat_legend {
2257 return 0;
2258}
2259
35574351
TC
2260=item _composite()
2261
2262Returns a list of style fields that are stored as composites, and
2263should be merged instead of just being replaced.
2264
2265=cut
2266
2267sub _composite {
2268 qw(title legend text label dropshadow outline callout);
2269}
2270
2271sub _filter_region {
2272 my ($self, $img, $left, $top, $right, $bottom, $filter) = @_;
2273
2274 unless (ref $filter) {
2275 my $name = $filter;
2276 $filter = $self->_get_thing($name)
2277 or return;
2278 $filter->{type}
2279 or return $self->_error("no type for filter $name");
2280 }
2281
2282 $left > 0 or $left = 0;
2283 $top > 0 or $top = 0;
2284
2285 # newer versions of Imager let you work on just part of an image
2286 if ($img->can('masked') && !$self->{_style}{features}{_debugblur}) {
2287 my $masked = $img->masked(left=>$left, top=>$top,
2288 right=>$right, bottom=>$bottom);
2289 $masked->filter(%$filter);
2290 }
2291 else {
2292 # for older versions of Imager
2293 my $subset = $img->crop(left=>$left, top=>$top,
2294 right=>$right, bottom=>$bottom);
2295 $subset->filter(%$filter);
2296 $img->paste(left=>$left, top=>$top, img=>$subset);
2297 }
2298}
2299
23001;
2301__END__
2302
2303=back
2304
2305=head1 SEE ALSO
2306
2307Imager::Graph::Pie(3), Imager(3), perl(1).
2308
2309=head1 AUTHOR
2310
2311Tony Cook <tony@develop-help.com>
2312
54ada35d
TC
2313=head1 LICENSE
2314
2315Imager::Graph is licensed under the same terms as perl itself.
2316
35574351
TC
2317=head1 BLAME
2318
2319Addi for producing a cool imaging module. :)
2320
2321=cut