package SVG::TT::Graph::TimeSeries; use strict; use Carp; use Data::Dumper; use HTTP::Date; use DateTime; use POSIX; use SVG::TT::Graph; use base qw(SVG::TT::Graph); my $template; =head1 NAME SVG::TT::Graph::TimeSeries - Create presentation quality SVG line graphs of time series easily =head1 SYNOPSIS use SVG::TT::Graph::TimeSeries; my @data_cpu = ('2003-09-03 09:30:00',23,'2003-09-03 09:45:00',54,'2003-09-03 10:00:00',67,'2003-09-03 10:15:00',12); my @data_disk = ('2003-09-03 09:00:00',12,'2003-09-03 10:00:00',26,'2003-09-03 11:00:00',23); my $graph = SVG::TT::Graph::TimeSeries->new({ 'height' => '500', 'width' => '300', }); $graph->add_data({ 'data' => \@data_cpu, 'title' => 'CPU', }); $graph->add_data({ 'data' => \@data_disk, 'title' => 'Disk', }); print "Content-type: image/svg+xml\r\n\r\n"; print $graph->burn(); =head1 DESCRIPTION This object aims to allow you to easily create high quality SVG line graphs of time series. You can either use the default style sheet or supply your own. Either way there are many options which can be configured to give you control over how the graph is generated - with or without a key, data elements at each point, title, subtitle etc. All times must be given a format parseable by L. The L module is used for all date/time calculations. Note that the module is currently limited to the Unix-style epoch-based date range limited by 32 bit signed integers (around 1902 to 2038). =head1 METHODS =head2 new() use SVG::TT::Graph::TimeSeries; my $graph = SVG::TT::Graph::TimeSeries->new({ # Optional - defaults shown 'height' => 500, 'width' => 300, 'show_y_labels' => 1, 'scale_divisions' => '', 'min_scale_value' => 0, 'max_scale_value' => '', 'show_x_labels' => 1, 'timescale_divisions' => '', 'min_timescale_value' => '', 'max_timescale_value' => '', 'x_label_format' => '%Y-%m-%d %H:%M:%S', 'stagger_x_labels' => 0, 'rotate_x_labels' => 0, 'show_data_points' => 1, 'show_data_values' => 1, 'rollover_values' => 0, 'area_fill' => 0, 'show_x_title' => 0, 'x_title' => 'X Field names', 'show_y_title' => 0, 'y_title' => 'Y Scale', 'show_graph_title' => 0, 'graph_title' => 'Graph Title', 'show_graph_subtitle' => 0, 'graph_subtitle' => 'Graph Sub Title', 'key' => 0, 'key_position' => 'right', # Optional - defaults to using internal stylesheet 'style_sheet' => '/includes/graph.css', }); The constructor takes a hash reference with values defaulted to those shown above - with the exception of style_sheet which defaults to using the internal style sheet. =head2 add_data() my @data_cpu = ('2003-09-03 09:30:00',23,'2003-09-03 09:45:00',54,'2003-09-03 10:00:00',67,'2003-09-03 10:15:00',12); or my @data_cpu = (['2003-09-03 09:30:00',23],['2003-09-03 09:45:00',54],['2003-09-03 10:00:00',67],['2003-09-03 10:15:00',12]); $graph->add_data({ 'data' => \@data_cpu, 'title' => 'CPU', }); This method allows you to add data to the graph object. The data is expected to be a list of time, value pairs. It can be called several times to add more data sets in. =head2 clear_data() my $graph->clear_data(); This method removes all data from the object so that you can reuse it to create a new graph but with the same config options. =head2 burn() print $graph->burn(); This method processes the template with the data and config which has been set and returns the resulting SVG. This method will croak unless at least one data set has been added to the graph object. =head2 config methods my $value = $graph->method(); my $confirmed_new_value = $graph->method($value); The following is a list of the methods which are available to change the config of the graph object after it has been created. =over 4 =item height() Set the height of the graph box, this is the total height of the SVG box created - not the graph it self which auto scales to fix the space. =item width() Set the width of the graph box, this is the total width of the SVG box created - not the graph it self which auto scales to fix the space. =item style_sheet() Set the path to an external stylesheet, set to '' if you want to revert back to using the defaut internal version. To create an external stylesheet create a graph using the default internal version and copy the stylesheet section to an external file and edit from there. =item show_data_values() Show the value of each element of data on the graph. =item rollover_values() Shows data values and data points when the mouse is over the point. Used in combination with show_data_values and/or show_data_points. =item data_value_format() Format specifier to for data values (as per printf). =item show_data_points() Show a small circle on the graph where the line goes from one point to the next. =item max_time_span() Maximum timespan for a line between data points. If this span is exceeded, the points are not connected. This is useful for skipping missing data sections. The expected form is: ' [years | months | days | hours | minutes | seconds]' =item stacked() Accumulates each data set. (i.e. Each point increased by sum of all previous series at same time). Default is 0, set to '1' to show. All data series have the same number of points and must have the same sequence of time values for this option. =item min_scale_value() The point at which the Y axis starts, defaults to '0', if set to '' it will default to the minimum data value. =item max_scale_value() The point at which the Y axis ends, if set to '' it will default to the maximum data value. =item scale_divisions() This defines the gap between markers on the Y axis, default is a 10th of the range, e.g. you will have 10 markers on the Y axis. NOTE: do not set this too low - you are limited to 999 markers, after that the graph won't generate. =item show_x_labels() Whether to show labels on the X axis or not, defaults to 1, set to '0' if you want to turn them off. =item x_label_format() Format string for presenting the X axis labels. The POSIX strftime() function is used for formatting (see strftime man pages and LC_TIME locale information). =item show_y_labels() Whether to show labels on the Y axis or not, defaults to 1, set to '0' if you want to turn them off. =item y_label_format() Format string for presenting the Y axis labels (as per printf). =item timescale_divisions() This defines the gap between markers on the X axis. Default is the entire range (only start and end axis labels). The expected form is: ' [years | months | days | hours | minutes | seconds]' The default time period if not provided is 'days'. These time periods are used by the L methods. =item stagger_x_labels() This puts the labels at alternative levels so if they are long field names they will not overlap so easily. Default it '0', to turn on set to '1'. =item rotate_x_labels() This turns the X axis labels by 90 degrees. Default it '0', to turn on set to '1'. =item min_timescale_value() This sets the minimum timescale value (X axis). Any data points before this time will not be shown. The date/time is expected in ISO format: YYYY-MM-DD hh:mm:ss. =item max_timescale_value() This sets the maximum timescale value (X axis). Any data points after this time will not be shown. The date/time is expected in ISO format: YYYY-MM-DD hh:mm:ss. =item show_x_title() Whether to show the title under the X axis labels, default is 0, set to '1' to show. =item x_title() What the title under X axis should be, e.g. 'Months'. =item show_y_title() Whether to show the title under the Y axis labels, default is 0, set to '1' to show. =item y_title() What the title under Y axis should be, e.g. 'Sales in thousands'. =item show_graph_title() Whether to show a title on the graph, default is 0, set to '1' to show. =item graph_title() What the title on the graph should be. =item show_graph_subtitle() Whether to show a subtitle on the graph, default is 0, set to '1' to show. =item graph_subtitle() What the subtitle on the graph should be. =item key() Whether to show a key, defaults to 0, set to '1' if you want to show it. =item key_position() Where the key should be positioned, defaults to 'right', set to 'bottom' if you want to move it. =back =head1 NOTES The default stylesheet handles upto 12 data sets, if you use more you must create your own stylesheet and add the additional settings for the extra data sets. You will know if you go over 12 data sets as they will have no style and be in black. =head1 EXAMPLES For examples look at the project home page http://leo.cuckoo.org/projects/SVG-TT-Graph/ =head1 EXPORT None by default. =head1 ACKNOWLEDGEMENTS Leo Lapworth for SVG-TT-Graph. Stephen Morgan for creating the TT template and SVG. =head1 AUTHOR David Meibusch (David.Meibusch@adc.com) =head1 SEE ALSO L, L, L, L, L, L =cut sub get_template { my $self = shift; # read in template return $template if $template; while() { $template .= $_ . "\r\n"; } return $template; } sub _init { my $self = shift; } sub _set_defaults { my $self = shift; my @fields = (); my %default = ( 'fields' => \@fields, 'width' => '500', 'height' => '300', 'style_sheet' => '', 'show_data_points' => 1, 'show_data_values' => 1, 'max_time_span' => '', 'area_fill' => 0, 'show_y_labels' => 1, 'scale_divisions' => '', 'min_scale_value' => '0', 'stacked' => 0, 'show_x_labels' => 1, 'stagger_x_labels' => 0, 'rotate_x_labels' => 0, 'timescale_divisions' => '', 'x_label_format' => '%Y-%m-%d %H:%M:%S', 'show_x_title' => 0, 'x_title' => 'X Field names', 'show_y_title' => 0, 'y_title' => 'Y Scale', 'show_graph_title' => 0, 'graph_title' => 'Graph Title', 'show_graph_subtitle' => 0, 'graph_subtitle' => 'Graph Sub Title', 'key' => 0, 'key_position' => 'right', # bottom or right 'dateadd' => \&dateadd, ); while( my ($key,$value) = each %default ) { $self->{config}->{$key} = $value; } } # override this so we can pre-manipulate the data sub add_data { my ($self, $conf) = @_; croak 'no data provided' unless (defined $conf->{'data'} && ref($conf->{'data'}) eq 'ARRAY'); # create an array unless(defined $self->{'data'}) { my @data; $self->{'data'} = \@data; } # convert to sorted (by ascending time) array of [ time, value ] my @new_data = (); my ($i,$time,@pair); $i = 0; while ($i < @{$conf->{'data'}}) { @pair = (); if (ref($conf->{'data'}->[$i]) eq 'ARRAY') { push @pair,@{$conf->{'data'}->[$i]}; $i++; } else { $pair[0] = $conf->{'data'}->[$i++]; $pair[1] = $conf->{'data'}->[$i++]; } $time = str2time($pair[0]); # special case for time-only values if ((!defined $time) && ($pair[0] =~ m/^\w*(\d+:\d+:\d+)|(\d+:\d+)\w*$/)) { $time = str2time('1970-1-1 '.$pair[0]); } croak sprintf("Series %d contains an illegal datetime value %s at sample %d.", scalar(@{$self->{'data'}}), $pair[0], $i / 2) unless (defined $time); $pair[0] = $time; push @new_data, [ @pair ]; } my @sorted = sort {@{$a}[0] <=> @{$b}[0]} @new_data; # if stacked, we accumulate the if (($self->{config}->{stacked}) && (@{$self->{'data'}})) { my $prev = $self->{'data'}->[@{$self->{'data'}} - 1]->{pairs}; # check our length matches previous croak sprintf("Series %d can not be stacked on previous series. Mismatched length.", scalar(@{$self->{'data'}})) unless (scalar(@sorted) == scalar(@$prev)); for (my $i = 0; $i < @sorted; $i++) { # check the time value matches croak sprintf("Series %d can not be stacked on previous series. Mismatched timestamp at sample %d (time %s).", scalar(@{$self->{'data'}}), $i, HTTP::Date::time2iso($sorted[$i][0])) unless ($sorted[$i][0] == $prev->[$i][0]); $sorted[$i][1] += $prev->[$i][1]; } } my %store = ( 'pairs' => \@sorted, ); $store{'title'} = $conf->{'title'} if defined $conf->{'title'}; push (@{$self->{'data'}},\%store); return 1; } # Helper function for doing date/time calculations # Current implementations of DateTime can be slow :-( sub dateadd { my ($epoch,$value,$unit) = @_; my $dt = DateTime->from_epoch(epoch => $epoch); $dt->add( $unit => $value ); return $dt->epoch(); } # override calculations to set a few calculated values, mainly for scaling sub calculations { my $self = shift; # run through the data and calculate maximum and minimum values my ($max_key_size,$max_time,$min_time,$max_value,$min_value,$max_x_label_length,$x_label); foreach my $dataset (@{$self->{data}}) { $max_key_size = length($dataset->{title}) if ((!defined $max_key_size) || ($max_key_size < length($dataset->{title}))); foreach my $pair (@{$dataset->{pairs}}) { $max_time = $pair->[0] if ((!defined $max_time) || ($max_time < $pair->[0])); $min_time = $pair->[0] if ((!defined $min_time) || ($min_time > $pair->[0])); $max_value = $pair->[1] if (($pair->[1] ne '') && ((!defined $max_value) || ($max_value < $pair->[1]))); $min_value = $pair->[1] if (($pair->[1] ne '') && ((!defined $min_value) || ($min_value > $pair->[1]))); $x_label = strftime($self->{config}->{x_label_format},localtime($pair->[0])); $max_x_label_length = length($x_label) if ((!defined $max_x_label_length) || ($max_x_label_length < length($x_label))); } } $self->{calc}->{max_key_size} = $max_key_size; $self->{calc}->{max_time} = $max_time; $self->{calc}->{min_time} = $min_time; $self->{calc}->{max_value} = $max_value; $self->{calc}->{min_value} = $min_value; $self->{calc}->{max_x_label_length} = $max_x_label_length; # Calc the x axis scale values $self->{calc}->{min_timescale_value} = ($self->_is_valid_config('min_timescale_value')) ? str2time($self->{config}->{min_timescale_value}) : $min_time; $self->{calc}->{max_timescale_value} = ($self->_is_valid_config('max_timescale_value')) ? str2time($self->{config}->{max_timescale_value}) : $max_time; $self->{calc}->{timescale_range} = $self->{calc}->{max_timescale_value} - $self->{calc}->{min_timescale_value}; # Calc the y axis scale values $self->{calc}->{min_scale_value} = ($self->_is_valid_config('min_scale_value')) ? $self->{config}->{min_scale_value} : $min_value; $self->{calc}->{max_scale_value} = ($self->_is_valid_config('max_scale_value')) ? $self->{config}->{max_scale_value} : $max_value; $self->{calc}->{scale_range} = $self->{calc}->{max_scale_value} - $self->{calc}->{min_scale_value}; my ($range,$division,$precision); if ($self->_is_valid_config('scale_divisions')) { $division = $self->{config}->{scale_divisions}; if ($division >= 1) { $precision = 0; } else { $precision = length($division) - 2; } } else { # Find divisions, format and range ($range,$division,$precision) = $self->_range_calc($self->{calc}->{scale_range}); # If a max value hasn't been set we can set a revised range and max value if (! $self->_is_valid_config('max_scale_value')) { $self->{calc}->{max_scale_value} = $self->{calc}->{min_scale_value} + $range; $self->{calc}->{scale_range} = $self->{calc}->{max_scale_value} - $self->{calc}->{min_scale_value}; } } $self->{calc}->{scale_division} = $division; $self->{calc}->{y_label_format} = ($self->_is_valid_config('y_label_format')) ? $self->{config}->{y_label_format} : "%.${precision}f"; $self->{calc}->{data_value_format} = ($self->_is_valid_config('data_value_format')) ? $self->{config}->{data_value_format} : "%.${precision}f"; } 1; __DATA__ [% USE date %] [% stylesheet = 'included' %] [% IF config.style_sheet && config.style_sheet != '' %] [% ELSE %] [% stylesheet = 'excluded' %] [% END %] [% IF stylesheet == 'excluded' %] [%# include default stylesheet if none specified %] [% END %] [%# get dimensions of actual graph area (NOT SVG area) %] [% w = config.width %] [% h = config.height %] [%# set start/default coords of graph %] [% x = 0 %] [% y = 0 %] [% char_width = 8 %] [% half_char_height = 2.5 %] [%# reduce height of graph area if there is labelling on x axis %] [% IF config.show_x_labels %][% h = h - 20 %][% END %] [%# reduce height if x labels are rotated %] [% x_label_allowance = 0 %] [% IF config.rotate_x_labels %] [% x_label_allowance = (calc.max_x_label_length * char_width) - 20 %] [% h = h - x_label_allowance %] [% END %] [%# stagger x labels if overlapping occurs %] [% stagger = 0 %] [% IF config.show_x_labels && config.stagger_x_labels %] [% stagger = 17 %] [% h = h - stagger %] [% END %] [% IF config.show_x_title %][% h = h - 25 - stagger %][% END %] [%# pad top of graph if y axis has data labels so labels do not get chopped off %] [% IF config.show_y_labels %][% h = h - 10 %][% y = y + 10 %][% END %] [%# reduce height if graph has title or subtitle %] [% IF config.show_graph_title %][% h = h - 25 %][% y = y + 25 %][% END %] [% IF config.show_graph_subtitle %][% h = h - 10 %][% y = y + 10 %][% END %] [%# reduce graph dimensions if there is a KEY %] [% key_box_size = 12 %] [% key_padding = 5 %] [% IF config.key && config.key_position == 'right' %][% w = w - (calc.max_key_size * (char_width - 1)) - (key_box_size * 3 ) %] [% ELSIF config.key && config.key_position == 'bottom' %] [% IF data.size < 4 %] [% h = h - ((data.size + 1) * (key_box_size + key_padding))%] [% ELSE %] [% h = h - (4 * (key_box_size + key_padding))%] [% END %] [% END %] [%# base line %] [% base_line = h + y %] [%# find the string length of max value %] [% max_value_length = calc.max_scale_value.length %] [%# label width in pixels %] [% max_value_length_px = max_value_length * char_width %] [%# If the y labels are shown but the size of the x labels are small, pad for y labels %] [%# reduce width of graph area if there is large labelling on x axis %] [% space_b4_y_axis = (date.format(calc.min_timescale_value,config.x_label_format).length / 2) * char_width %] [% IF config.show_x_labels %] [% IF config.key && config.key_position == 'right' %] [% w = w - space_b4_y_axis %] [% ELSE %] [% w = w - (space_b4_y_axis * 2) %] [% END %] [% x = x + space_b4_y_axis %] [% ELSIF config.show_data_values %] [% w = w - (max_value_length_px * 2) %] [% x = x + max_value_length_px %] [% END %] [% IF config.show_y_labels && space_b4_y_axis < max_value_length_px %] [% IF max_value_length < 2 %] [% w = w - (max_value_length * (char_width * 2)) %] [% x = x + (max_value_length * (char_width * 2)) %] [% ELSE %] [% w = w - max_value_length_px %] [% x = x + max_value_length_px %] [% END %] [% ELSIF config.show_y_labels && !config.show_x_labels %] [% w = w - max_value_length_px %] [% x = x + max_value_length_px %] [% END %] [% IF config.show_y_title %] [% w = w - 25 %] [% x = x + 25 %] [% END %] [%# Missing data spans %] [% max_time_span = 0 %] [% IF (matches = config.max_time_span.match('(\d+) ?(\w+)?')) %] [% max_time_span = matches.0 %] [% IF (matches.1) %] [% max_time_span_units = matches.1 %] [% ELSE %] [% max_time_span_units = 'days' %] [% END %] [% END %] [%# graph bg and clipping regions for lines/fill and clip extended to included data labels %] [% dx = calc.timescale_range %] [% dw = w / dx %] [% IF config.show_x_labels %] [% date.format(calc.min_timescale_value,config.x_label_format) %] [% last_label = date.format(calc.min_timescale_value,config.x_label_format) %] [% IF config.timescale_divisions %] [% IF (matches = config.timescale_divisions.match('(\d+) ?(\w+)?')) %] [% timescale_division = matches.0 %] [% IF (matches.1) %] [% timescale_division_units = matches.1 %] [% ELSE %] [% timescale_division_units = 'days' %] [% END %] [% x_value = config.dateadd(calc.min_timescale_value,timescale_division,timescale_division_units) %] [% count = 0 %] [% WHILE ((x_value > calc.min_timescale_value) && ((x_value < calc.max_timescale_value))) %] [% xpos = (dw * (x_value - calc.min_timescale_value)) + x %] [% IF (config.stagger_x_labels && ((count % 2) == 0)) %] [% date.format(x_value,config.x_label_format) %] [% ELSE %] [% date.format(x_value,config.x_label_format) %] [% END %] [% last_label = date.format(x_value,config.x_label_format) %] [% x_value = config.dateadd(x_value,timescale_division,timescale_division_units) %] [% count = count + 1 %] [% LAST IF (count >= 999) %] [% END %] [% END %] [% END %] [% IF date.format(calc.max_timescale_value,config.x_label_format) != last_label %] [% IF (config.stagger_x_labels && ((count % 2) == 0)) %] [% date.format(calc.max_timescale_value,config.x_label_format) %] [% ELSE %] [% date.format(calc.max_timescale_value,config.x_label_format) %] [% END %] [% END %] [% END %] [%# how much padding between largest bar and top of graph %] [% top_pad = h / 40 %] [% dy = calc.scale_range %] [% dh = (h - top_pad) / dy %] [% count = 0 %] [% y_value = calc.min_scale_value %] [% IF config.show_y_labels %] [% WHILE ((y_value == calc.min_scale_value) || (y_value == calc.max_scale_value) || ((y_value > calc.min_scale_value) && (y_value < calc.max_scale_value))) %] [%- next_label = y_value FILTER format(calc.y_label_format) -%] [%- IF count == 0 -%] [%# no stroke for first line %] [% next_label %] [%- ELSE -%] [% IF next_label != last_label %] [% next_label %] [% END %] [%- END -%] [%- y_value = y_value + calc.scale_division -%] [%- last_label = next_label -%] [%- count = count + 1 -%] [%- LAST IF (count >= 999) -%] [% END %] [% END %] [% IF config.show_x_title %] [% IF !config.show_x_labels %] [% y_xtitle = 15 %] [% ELSE %] [% y_xtitle = 35 %] [% END %] [% config.x_title %] [% END %] [% IF config.show_y_title %] [% config.y_title %] [% END %] [% line = data.size %] [% FOREACH dataset = data.reverse %] [% IF config.area_fill %] [%# create alternate fill first (so line can overwrite if necessary) %] [% xcount = 0 %] [% FOREACH pair = dataset.pairs %] [%- IF ((pair.0 >= calc.min_timescale_value) && (pair.0 <= calc.max_timescale_value)) -%] [%- IF xcount == 0 -%][% lasttime = pair.0 %] [% END %] [% END %] [% xcount = 0 %] [% FOREACH pair = dataset.pairs %] [% IF ((pair.0 >= calc.min_timescale_value) && (pair.0 <= calc.max_timescale_value)) %] [%- IF xcount == 0 -%][%- lasttime = pair.0 -%] [% END %] [% IF config.show_data_points || config.show_data_values %] [% FOREACH pair = dataset.pairs %] [% IF ((pair.0 >= calc.min_timescale_value) && (pair.0 <= calc.max_timescale_value)) %] [% IF config.show_data_points %] [% END %] [% IF config.show_data_values %] [%# datavalue shown %] [% IF (pair.2.defined) && (pair.2 != '') %][% point_label = pair.2 %][% ELSE %][% point_label = pair.1 FILTER format(calc.data_value_format) %][% END %] [% point_label %] [% END %] [% END %] [% END %] [% END %] [% line = line - 1 %] [% END %] [% key_count = 1 %] [% IF config.key && config.key_position == 'right' %] [% FOREACH dataset = data %] [% dataset.title %] [% key_count = key_count + 1 %] [% END %] [% ELSIF config.key && config.key_position == 'bottom' %] [%# calc y position of start of key %] [% y_key = base_line %] [%# consider x title %] [% IF config.show_x_title %][% y_key = base_line + 25 %][% END %] [%# consider x label rotation and stagger %] [% IF config.rotate_x_labels && config.show_x_labels %] [% y_key = y_key + x_label_allowance %] [% ELSIF config.show_x_labels && stagger < 1 %] [% y_key = y_key + 20 %] [% END %] [% y_key_start = y_key %] [% x_key = x %] [% FOREACH dataset = data %] [% IF key_count == 4 || key_count == 7 || key_count == 10 %] [%# wrap key every 3 entries %] [% x_key = x_key + 200 %] [% y_key = y_key - (key_box_size * 4) - 2 %] [% END %] [% dataset.title %] [% key_count = key_count + 1 %] [% END %] [% END %] [% IF config.show_graph_title %] [% config.graph_title %] [% END %] [% IF config.show_graph_subtitle %] [% IF config.show_graph_title %] [% y_subtitle = 30 %] [% ELSE %] [% y_subtitle = 15 %] [% END %] [% config.graph_subtitle %] [% END %]