--- loncom/xml/lonplot.pm 2008/06/03 10:49:00 1.145
+++ loncom/xml/lonplot.pm 2012/07/04 11:09:22 1.158
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Dynamic plot
#
-# $Id: lonplot.pm,v 1.145 2008/06/03 10:49:00 foxr Exp $
+# $Id: lonplot.pm,v 1.158 2012/07/04 11:09:22 foxr Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -26,6 +26,9 @@
# http://www.lon-capa.org/
#
+
+
+
package Apache::lonplot;
use strict;
@@ -57,6 +60,8 @@ BEGIN {
}
+=pod
+
##
## Description of data structures:
##
@@ -88,14 +93,21 @@ BEGIN {
## ##
###################################################################
+=cut
+
my $max_str_len = 50; # if a label, title, xlabel, or ylabel text
# is longer than this, it will be truncated.
-my %linetypes =
+my %linetypes = # For png use these linetypes.
(
solid => 1,
dashed => 0
);
+my %ps_linetypes = # For ps the line types are different!
+ (
+ solid => 0,
+ dashed => 7
+ );
my %linestyles =
(
@@ -169,14 +181,16 @@ my %gnuplot_defaults =
test => $color_test,
description => 'Background color of image (xffffff)',
edit_type => 'entry',
- size => '10'
+ size => '10',
+ class => 'colorchooser'
},
fgcolor => {
default => 'x000000',
test => $color_test,
description => 'Foreground color of image (x000000)',
edit_type => 'entry',
- size => '10'
+ size => '10',
+ class => 'colorchooser'
},
transparent => {
default => 'off',
@@ -448,7 +462,7 @@ my %tic_defaults =
},
);
-my @axis_edit_order = ('color','xmin','xmax','ymin','ymax','xformat', 'yformat');
+my @axis_edit_order = ('color','xmin','xmax','ymin','ymax','xformat', 'yformat', 'xzero', 'yzero');
my %axis_defaults =
(
color => {
@@ -456,7 +470,8 @@ my %axis_defaults =
test => $color_test,
description => 'Color of grid lines (x000000)',
edit_type => 'entry',
- size => '10'
+ size => '10',
+ class => 'colorchooser'
},
xmin => {
default => '-10.0',
@@ -496,11 +511,26 @@ my %axis_defaults =
yformat => {
default => 'on',
test => sub {$_[0]=~/^(on|off|\d+(f|F|e|E))$/},
- description => 'X-axis number formatting',
+ description => 'Y-axis number formatting',
edit_type => 'choice',
choices => ['on', 'off', '2e', '2f'],
},
-
+
+ xzero => {
+ default => 'off',
+ test => sub {$_[0]=~/^(off|line|thick-line|dotted)$/},
+ description => 'Show x-zero (y=0) axis',
+ edit_type => 'choice',
+ choices => ['off', 'line', 'thick-line', 'dotted'],
+ },
+
+ yzero => {
+ default => 'off',
+ test => sub {$_[0]=~/^(off|line|thick-line|dotted)$/},
+ description => 'Show y-zero (x=0) axis',
+ edit_type => 'choice',
+ choices => ['off', 'line', 'thick-line', 'dotted'],
+ },
);
my @curve_edit_order = ('color','name','linestyle','linewidth','linetype','pointtype','pointsize','limit');
@@ -512,7 +542,8 @@ my %curve_defaults =
test => $color_test,
description => 'Color of curve (x000000)',
edit_type => 'entry',
- size => '10'
+ size => '10',
+ class => 'colorchooser'
},
name => {
default => '',
@@ -598,7 +629,18 @@ sub start_gnuplot {
} elsif ($target eq 'modified') {
my $constructtag=&Apache::edit::get_new_args
($token,$parstack,$safeeval,keys(%gnuplot_defaults));
+
if ($constructtag) {
+ #
+ # The color chooser does not prepent x to the color values
+ # Do that here:
+ #
+ foreach my $attribute ('bgcolor', 'fgcolor') {
+ my $value = $token->[2]{$attribute};
+ if (defined $value && !($value =~ /^x/)) {
+ $token->[2]{$attribute} = 'x' . $value;
+ }
+ }
$result = &Apache::edit::rebuild_tag($token);
}
}
@@ -612,6 +654,8 @@ sub end_gnuplot {
('title','xlabel','ylabel','key','axis','label','curve'));
my $result = '';
my $randnumber;
+ my $tmpdir =LONCAPA::tempdir(); # Where temporary files live:
+
# need to call rand everytime start_script would evaluate, as the
# safe space rand number generator and the global rand generator
# are not separate
@@ -623,7 +667,6 @@ sub end_gnuplot {
&check_inputs(); # Make sure we have all the data we need
##
## Determine filename
- my $tmpdir = '/home/httpd/perl/tmp/';
my $filename = $env{'user.name'}.'_'.$env{'user.domain'}.
'_'.time.'_'.$$.$randnumber.'_plot';
## Write the plot description to the file
@@ -644,7 +687,7 @@ ENDIMAGE
#might be inside the safe space, register the URL for later
&Apache::lonxml::register_ssi("/cgi-bin/plot.gif?file=$filename.data&output=eps");
$result = "%DYNAMICIMAGE:$Apache::lonplot::plot{'width'}:$Apache::lonplot::plot{'height'}:$Apache::lonplot::plot{'texwidth'}\n";
- $result .= '\graphicspath{{/home/httpd/perl/tmp/}}'."\n";
+ $result .= '\graphicspath{{'.$tmpdir.'}}'."\n";
$result .= '\includegraphics[width='.$Apache::lonplot::plot{'texwidth'}.' mm]{'.&unescape($filename).'.eps}';
}
} elsif ($target eq 'edit') {
@@ -757,6 +800,7 @@ sub get_font {
$selected_font = $font_properties{$Apache::lonplot::plot{'fontface'}};
}
if ($target eq 'tex' && defined($Apache::lonplot::plot{'texfont'})) {
+# $selected_font = $font_properties{'classic'};
$size = $Apache::lonplot::plot{'texfont'};
}
return ($size, $selected_font);
@@ -1327,6 +1371,13 @@ sub start_curve {
my $constructtag=&Apache::edit::get_new_args
($token,$parstack,$safeeval,keys(%curve_defaults));
if ($constructtag) {
+ #
+ # Fix up the color attribute as jcolor does not prepend an x
+ #
+ my $value = $token->[2]{'color'};
+ if (defined $value && !($value =~ /^x/)) {
+ $token->[2]{'color'} = 'x' . $value;
+ }
$result = &Apache::edit::rebuild_tag($token);
}
}
@@ -1361,6 +1412,7 @@ sub start_function {
my $function = &Apache::lonxml::get_all_text("/function",$parser,
$style);
$function = &Apache::run::evaluate($function,$safeeval,$$parstack[-1]);
+ $function=~s/\^/\*\*/gs;
$curves[-1]->{'function'} = $function;
} elsif ($target eq 'edit') {
$result .= &Apache::edit::tag_start($target,$token,'Gnuplot compatible curve function');
@@ -1431,7 +1483,7 @@ sub start_data {
}
# complain if the number of data points is not the same as
# in previous sets of data.
- if (($curves[-1]->{'data'}) && ($#data != $#{@{$curves[-1]->{'data'}->[0]}})){
+ if (($curves[-1]->{'data'}) && ($#data != $#{$curves[-1]->{'data'}->[0]})){
&Apache::lonxml::warning
('Number of data points is not consistent with previous '.
'number of data points');
@@ -1472,7 +1524,17 @@ sub start_axis {
} elsif ($target eq 'modified') {
my $constructtag=&Apache::edit::get_new_args
($token,$parstack,$safeeval,keys(%axis_defaults));
+
if ($constructtag) {
+ #
+ # Fix up the color attribute since jchooser does not
+ # prepend an x to the color:
+ #
+ my $value = $token->[2]{'color'};
+ if (defined $value && !($value =~ /^x/)) {
+ $token->[2]{'color'} = 'x' . $value;
+ }
+
$result = &Apache::edit::rebuild_tag($token);
}
}
@@ -1565,6 +1627,7 @@ sub write_gnuplot_file {
$curve->{'color'} :
$Apache::lonplot::plot{'fgcolor'} );
}
+
# set term
if ($target eq 'web') {
$gnuplot_input .= 'set terminal png enhanced nocrop ';
@@ -1577,7 +1640,7 @@ sub write_gnuplot_file {
# set output
$gnuplot_input .= "set output\n";
} elsif ($target eq 'tex') {
- $gnuplot_input .= "set term postscript eps enhanced $Apache::lonplot::plot{'plotcolor'} solid ";
+ $gnuplot_input .= "set term postscript eps enhanced $Apache::lonplot::plot{'plotcolor'} dash ";
if (!$font_properties->{'tex_no_file'}) {
$gnuplot_input .=
'fontfile "'.$Apache::lonnet::perlvar{'lonFontsDir'}.
@@ -1585,7 +1648,7 @@ sub write_gnuplot_file {
}
$gnuplot_input .= ' "'.$font_properties->{'printname'}.'" ';
$gnuplot_input .= $fontsize;
- $gnuplot_input .= "\nset output \"/home/httpd/perl/tmp/".
+ $gnuplot_input .= "\nset output \"".$tmpdir.
&unescape($filename).".eps\"\n";
$gnuplot_input .= "set encoding iso_8859_1\n"; # Get access to extended font.
@@ -1675,20 +1738,36 @@ sub write_gnuplot_file {
$gnuplot_input .= ( $xtics{'mirror'} eq 'on'?"mirror ":"nomirror ");
$gnuplot_input .= "$xtics{'start'}, ";
$gnuplot_input .= "$xtics{'increment'}, ";
- $gnuplot_input .= "$xtics{'end'}\n";
+ $gnuplot_input .= "$xtics{'end'} ";
+ if ($target eq 'tex') {
+ $gnuplot_input .= 'font "Helvetica,22"'; # Needed in iso 8859-1 enc.
+ }
+ $gnuplot_input .= "\n";
if ($xtics{'minorfreq'} != 0) {
$gnuplot_input .= "set mxtics ".$xtics{'minorfreq'}."\n";
}
+ } else {
+ if ($target eq 'tex') {
+ $gnuplot_input .= 'set xtics font "Helvetica,22"'."\n"; # needed in iso 8859-1 enc
+ }
}
if (%ytics) {
$gnuplot_input .= "set ytics $ytics{'location'} ";
$gnuplot_input .= ( $ytics{'mirror'} eq 'on'?"mirror ":"nomirror ");
$gnuplot_input .= "$ytics{'start'}, ";
$gnuplot_input .= "$ytics{'increment'}, ";
- $gnuplot_input .= "$ytics{'end'}\n";
+ $gnuplot_input .= "$ytics{'end'} ";
+ if ($target eq 'tex') {
+ $gnuplot_input .= 'font "Helvetica,22"'; # Needed in iso-8859-1 encoding.
+ }
+ $gnuplot_input .= "\n";
if ($ytics{'minorfreq'} != 0) {
$gnuplot_input .= "set mytics ".$ytics{'minorfreq'}."\n";
}
+ } else {
+ if ($target eq 'tex') {
+ $gnuplot_input .= 'set ytics font "Helvetica,22"'."\n"; # Needed for iso 8859-1 enc.
+ }
}
# axis
if (%axis) {
@@ -1710,6 +1789,26 @@ sub write_gnuplot_file {
}
$gnuplot_input .= "set xrange \[$axis{'xmin'}:$axis{'xmax'}\]\n";
$gnuplot_input .= "set yrange \[$axis{'ymin'}:$axis{'ymax'}\]\n";
+ if ($axis{'xzero'} ne 'off') {
+ $gnuplot_input .= "set xzeroaxis ";
+ if ($axis{'xzero'} eq 'line' || $axis{'xzero'} eq 'thick-line') {
+ $gnuplot_input .= "lt -1 ";
+ if ($axis{'xzero'} eq 'thick-line') {
+ $gnuplot_input .= "lw 3 ";
+ }
+ }
+ $gnuplot_input .= "\n";
+ }
+ if ($axis{'yzero'} ne 'off') {
+ $gnuplot_input .= "set yzeroaxis ";
+ if ($axis{'yzero'} eq 'line' || $axis{'yzero'} eq 'thick-line') {
+ $gnuplot_input .= "lt -1 ";
+ if ($axis{'yzero'} eq 'thick-line') {
+ $gnuplot_input .= "lw 3 ";
+ }
+ }
+ $gnuplot_input .= "\n";
+ }
}
# Key
if (%key) {
@@ -1741,40 +1840,30 @@ sub write_gnuplot_file {
$gnuplot_input .="\n";
}
# curves
- $gnuplot_input .= 'plot ';
+ #
+ # Each curve will have its very own linestyle.
+ # (This should work just fine in web rendition I think).
+ # The line_xxx variables will hold the elements of the line style.
+ # type (solid/dashed), color, width
+ #
+ my $linestyle_index = 50;
+ my $line_width = '';
+
+ my $plot_command;
+ my $plot_type;
+
for (my $i = 0;$i<=$#curves;$i++) {
$curve = $curves[$i];
- $gnuplot_input.= ', ' if ($i > 0);
+ $plot_command.= ', ' if ($i > 0);
if ($target eq 'tex') {
$curve->{'linewidth'} *= 2;
}
+ $line_width = $curve->{'linewidth'};
if (exists($curve->{'function'})) {
- $gnuplot_input.=
+ $plot_type =
$curve->{'function'}.' title "'.
$curve->{'name'}.'" with '.
$curve->{'linestyle'};
-
- if (($curve->{'linestyle'} eq 'points') ||
- ($curve->{'linestyle'} eq 'linespoints') ||
- ($curve->{'linestyle'} eq 'errorbars') ||
- ($curve->{'linestyle'} eq 'xerrorbars') ||
- ($curve->{'linestyle'} eq 'yerrorbars') ||
- ($curve->{'linestyle'} eq 'xyerrorbars')) {
- $gnuplot_input.=' pointtype '.$curve->{'pointtype'};
- $gnuplot_input.=' pointsize '.$curve->{'pointsize'};
- } elsif ($curve->{'linestyle'} eq 'filledcurves') {
- $gnuplot_input.= ' '.$curve->{'limit'};
- } elsif ($curve->{'linetype'} ne '' &&
- $curve->{'linestyle'} eq 'lines') {
- $gnuplot_input.= ' linetype ';
- $gnuplot_input.= $linetypes{$curve->{'linetype'}};
- $gnuplot_input.= ' linecolor rgb "';
- # convert color from xaaaaaa to #aaaaaa
- $curve->{'color'} =~ s/^x/#/;
- $gnuplot_input.= $curve->{'color'}.'"';
- }
- $gnuplot_input.= ' linewidth '.$curve->{'linewidth'};
-
} elsif (exists($curve->{'data'})) {
# Store data values in $datatext
my $datatext = '';
@@ -1795,30 +1884,48 @@ sub write_gnuplot_file {
print $fh $datatext;
close($fh);
# generate gnuplot text
- $gnuplot_input.= '"'.$datafilename.'" title "'.
+ $plot_type = '"'.$datafilename.'" title "'.
$curve->{'name'}.'" with '.
$curve->{'linestyle'};
- if (($curve->{'linestyle'} eq 'points') ||
- ($curve->{'linestyle'} eq 'linespoints') ||
- ($curve->{'linestyle'} eq 'errorbars') ||
- ($curve->{'linestyle'} eq 'xerrorbars') ||
- ($curve->{'linestyle'} eq 'yerrorbars') ||
- ($curve->{'linestyle'} eq 'xyerrorbars')) {
- $gnuplot_input.=' pointtype '.$curve->{'pointtype'};
- $gnuplot_input.=' pointsize '.$curve->{'pointsize'};
- } elsif ($curve->{'linestyle'} eq 'filledcurves') {
- $gnuplot_input.= ' '.$curve->{'limit'};
- } elsif ($curve->{'linetype'} ne '' &&
- $curve->{'linestyle'} eq 'lines') {
- $gnuplot_input.= ' linetype ';
- $gnuplot_input.= $linetypes{$curve->{'linetype'}};
- $gnuplot_input.= ' linecolor rgb "';
- # convert color from xaaaaaa to #aaaaaa
- $curve->{'color'} =~ s/^x/#/;
- $gnuplot_input.= $curve->{'color'}.'"';
- }
- $gnuplot_input.= ' linewidth '.$curve->{'linewidth'};
}
+ my $pointtype = '';
+ my $pointsize = '';
+
+ if (($curve->{'linestyle'} eq 'points') ||
+ ($curve->{'linestyle'} eq 'linespoints') ||
+ ($curve->{'linestyle'} eq 'errorbars') ||
+ ($curve->{'linestyle'} eq 'xerrorbars') ||
+ ($curve->{'linestyle'} eq 'yerrorbars') ||
+ ($curve->{'linestyle'} eq 'xyerrorbars')) {
+
+ $pointtype =' pointtype '.$curve->{'pointtype'};
+ $pointsize =' pointsize '.$curve->{'pointsize'};
+ } elsif ($curve->{'linestyle'} eq 'filledcurves') {
+ $plot_command.= ' '.$curve->{'limit'};
+ }
+
+
+ # Figure out the linestyle:
+
+ my $lt = $curve->{'linetype'} ne '' ? $curve->{'linetype'}
+ : 'solid'; # Line type defaults to solid.
+ # The mapping of lt -> the actual gnuplot line type depends on the target:
+
+ if ($target eq 'tex') {
+ $lt = $ps_linetypes{$lt};
+ } else {
+ $lt = $linetypes{$lt}
+ }
+
+ my $color = $curve->{'color'};
+ $color =~ s/^x/#/; # Convert xhex color -> #hex color.
+
+ my $style_command = "set style line $linestyle_index $pointtype $pointsize linetype $lt linewidth $line_width lc rgb '$color'\n";
+ $gnuplot_input .= $style_command;
+
+ $plot_command.= " ls $linestyle_index";
+ $gnuplot_input .= 'plot ' . $plot_type . ' ' . $plot_command . "\n";
+ $linestyle_index++; # Each curve get a unique linestyle.
}
# Write the output to a file.
open (my $fh,">$tmpdir$filename.data");
@@ -1869,7 +1976,8 @@ sub edit_attributes {
if ($defaults->{$attr}->{'edit_type'} eq 'entry') {
$result .= &Apache::edit::text_arg
($description,$attr,$token,
- $defaults->{$attr}->{'size'});
+ $defaults->{$attr}->{'size'},
+ $defaults->{$attr}->{'class'});
} elsif ($defaults->{$attr}->{'edit_type'} eq 'choice') {
$result .= &Apache::edit::select_or_text_arg
($description,$attr,$defaults->{$attr}->{'choices'},$token);
@@ -1998,3 +2106,118 @@ sub insert_data {
__END__
+=head1 NAME
+
+Apache::lonplot.pm
+
+=head1 SYNOPSIS
+
+XML-based plotter of graphs
+
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
+
+
+=head1 SUBROUTINES (parsing and edit rendering)
+
+=over
+
+=item start_gnuplot()
+
+=item end_gnuplot()
+
+=item start_xtics()
+
+=item end_xtics()
+
+=item start_ytics()
+
+=item end_ytics()
+
+=item get_font()
+
+=item start_key()
+
+=item end_key()
+
+=item parse_label()
+
+=item replace_entities()
+
+=item start_title()
+
+=item end_title()
+
+=item start_xlabel()
+
+=item end_xlabel()
+
+=item start_ylabel()
+
+=item end_label()
+
+=item start_curve()
+
+=item end_curve()
+
+=item start_function()
+
+=item end_function()
+
+=item start_data()
+
+=item end_data()
+
+=item start_axis()
+
+=item end_axis
+
+=back
+
+=head1 SUBROUTINES (Utility)
+
+=over
+
+=item set_defaults()
+
+=item get_attributes()
+
+=item write_gnuplot_file()
+
+=item check_inputs()
+
+=item edit_attributes()
+
+=back
+
+=head1 SUBROUTINES (Insertion functions for editing plots)
+
+=over
+
+=item insert_gnuplot()
+
+=item insert_tics()
+
+=item insert_xtics()
+
+=item insert_key()
+
+=item insert_axis()
+
+=item insert_title()
+
+=item insert_xlabel()
+
+=item insert_ylabel()
+
+=item insert_label()
+
+=item insert_curve()
+
+=item insert_function()
+
+=item insert_data()
+
+=back
+
+=cut