--- loncom/xml/lonplot.pm 2004/09/13 13:34:06 1.103
+++ loncom/xml/lonplot.pm 2005/12/01 18:46:17 1.112
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Dynamic plot
#
-# $Id: lonplot.pm,v 1.103 2004/09/13 13:34:06 matthew Exp $
+# $Id: lonplot.pm,v 1.112 2005/12/01 18:46:17 albertel Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -35,9 +35,12 @@ use Apache::File;
use Apache::response;
use Apache::lonxml;
use Apache::edit;
+use Apache::lonnet;
use vars qw/$weboutputformat $versionstring/;
+
+
BEGIN {
&Apache::lonxml::register('Apache::lonplot',('gnuplot'));
#
@@ -47,8 +50,10 @@ BEGIN {
if ($versionstring =~ /^gnuplot 4/) {
$weboutputformat = 'png';
}
+
}
+
##
## Description of data structures:
##
@@ -97,6 +102,7 @@ my %linestyles =
yerrorbars => [3,4],
xyerrorbars => [4,6],
boxes => 3,
+ filledcurves => 2,
vector => 4
);
@@ -119,11 +125,11 @@ my $words_test = sub {$_[0]=~s/\s+/
###################################################################
my @gnuplot_edit_order =
qw/alttag bgcolor fgcolor height width font transparent grid samples
- border align texwidth texfont plottype lmargin rmargin tmargin bmargin
- major_ticscale minor_ticscale/;
+ border align texwidth texfont plotcolor plottype lmargin rmargin tmargin
+ bmargin major_ticscale minor_ticscale boxwidth gridlayer fillstyle
+ pattern solid/;
-my $margin_choices = ['default',
- qw{0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20}];
+my $margin_choices = ['default',0..20];
my %gnuplot_defaults =
(
@@ -174,6 +180,19 @@ my %gnuplot_defaults =
description => 'Display grid',
edit_type => 'onoff'
},
+ gridlayer => {
+ default => 'off',
+ test => $onoff_test,
+ description => 'Display grid front layer over filled boxes or filled curves',
+ edit_type => 'onoff'
+ },
+ box_border => {
+ default => 'noborder',
+ test => sub {$_[0]=~/^(noborder|border)$/},
+ description => 'Draw border for boxes',
+ edit_type => 'choice',
+ choices => ['border','noborder']
+ },
border => {
default => 'on',
test => $onoff_test,
@@ -187,7 +206,7 @@ my %gnuplot_defaults =
edit_type => 'choice',
choices => ['small','medium','large']
},
- samples => {
+ samples => {
default => '100',
test => $int_test,
description => 'Number of samples for non-data plots',
@@ -208,48 +227,83 @@ my %gnuplot_defaults =
edit_type => 'entry',
size => '5'
},
- texfont => {
+ texfont => {
default => '22',
test => $int_test,
description => 'Font size to use in TeX output (pts):',
edit_type => 'choice',
choices => [qw/8 10 12 14 16 18 20 22 24 26 28 30 32 34 36/],
},
- plottype => {
+ plotcolor => {
+ default => 'monochrome',
+ test => sub {$_[0]=~/^(monochrome|color|colour)$/},
+ description => 'Color setting for printing:',
+ edit_type => 'choice',
+ choices => [qw/monochrome color colour/],
+ },
+ pattern => {
+ default => '',
+ test => $int_test,
+ description => 'pattern value for boxes:',
+ edit_type => 'choice',
+ choices => [0,1,2,3,4,5,6]
+ },
+ solid => {
+ default => 0,
+ test => $real_test,
+ description => 'The density of fill style for boxes',
+ edit_type => 'entry',
+ size => '5'
+ },
+ fillstyle => {
+ default => 'empty',
+ test => sub {$_[0]=~/^(empty|solid|pattern)$/},
+ description => 'Filled style for boxes:',
+ edit_type => 'choice',
+ choices => ['empty','solid','pattern']
+ },
+ plottype => {
default => 'Cartesian',
test => sub {$_[0]=~/^(Polar|Cartesian)$/},
description => 'Plot type:',
edit_type => 'choice',
choices => ['Cartesian','Polar']
},
- lmargin => {
+ lmargin => {
default => 'default',
test => sub {$_[0]=~/^(default|\d+)$/},
description => 'Left margin width (pts):',
edit_type => 'choice',
choices => $margin_choices,
},
- rmargin => {
+ rmargin => {
default => 'default',
test => sub {$_[0]=~/^(default|\d+)$/},
description => 'Right margin width (pts):',
edit_type => 'choice',
choices => $margin_choices,
},
- tmargin => {
+ tmargin => {
default => 'default',
test => sub {$_[0]=~/^(default|\d+)$/},
description => 'Top margin width (pts):',
edit_type => 'choice',
choices => $margin_choices,
},
- bmargin => {
+ bmargin => {
default => 'default',
test => sub {$_[0]=~/^(default|\d+)$/},
- description => 'Bottm margin width (pts):',
+ description => 'Bottom margin width (pts):',
edit_type => 'choice',
choices => $margin_choices,
},
+ boxwidth => {
+ default => '',
+ test => $real_test,
+ description => 'width of boxes default auto',
+ edit_type => 'entry',
+ size => '5'
+ },
major_ticscale => {
default => '1',
test => $real_test,
@@ -403,7 +457,7 @@ my %axis_defaults =
}
);
-my @curve_edit_order = ('color','name','linestyle','pointtype','pointsize');
+my @curve_edit_order = ('color','name','linestyle','pointtype','pointsize','limit');
my %curve_defaults =
(
@@ -449,7 +503,14 @@ my %curve_defaults =
description => 'point type (may not apply to all line styles)',
edit_type => 'choice',
choices => [0,1,2,3,4,5,6]
- }
+ },
+ limit => {
+ default => 'closed',
+ test => sub {$_[0]=~/^(closed|x1|x2|y1|y2)$/},
+ description => 'point to fill -- for filledcurves',
+ edit_type => 'choice',
+ choices => ['closed','x1','x2','y1','y2']
+ },
);
###################################################################
@@ -457,10 +518,12 @@ my %curve_defaults =
## parsing and edit rendering ##
## ##
###################################################################
-my (%plot,%key,%axis,$title,$xlabel,$ylabel,@labels,@curves,%xtics,%ytics);
+
+undef %Apache::lonplot::plot;
+my (%key,%axis,$title,$xlabel,$ylabel,@labels,@curves,%xtics,%ytics);
sub start_gnuplot {
- undef(%plot); undef(%key); undef(%axis);
+ undef(%Apache::lonplot::plot); undef(%key); undef(%axis);
undef($title); undef($xlabel); undef($ylabel);
undef(@labels); undef(@curves);
undef(%xtics); undef(%ytics);
@@ -472,7 +535,7 @@ sub start_gnuplot {
'xtics','ytics'));
push (@Apache::lonxml::namespace,'lonplot');
if ($target eq 'web' || $target eq 'tex') {
- &get_attributes(\%plot,\%gnuplot_defaults,$parstack,$safeeval,
+ &get_attributes(\%Apache::lonplot::plot,\%gnuplot_defaults,$parstack,$safeeval,
$tagstack->[-1]);
} elsif ($target eq 'edit') {
$result .= &Apache::edit::tag_start($target,$token,'GnuPlot');
@@ -507,7 +570,7 @@ sub end_gnuplot {
##
## Determine filename
my $tmpdir = '/home/httpd/perl/tmp/';
- my $filename = $ENV{'user.name'}.'_'.$ENV{'user.domain'}.
+ my $filename = $env{'user.name'}.'_'.$env{'user.domain'}.
'_'.time.'_'.$$.$randnumber.'_plot';
## Write the plot description to the file
&write_gnuplot_file($tmpdir,$filename,$target);
@@ -516,15 +579,19 @@ sub end_gnuplot {
if ($target eq 'web') {
$result .= <<"ENDIMAGE";
<img src = "/cgi-bin/plot.gif?file=$filename.data&output=$weboutputformat"
- width = "$plot{'width'}"
- height = "$plot{'height'}"
- align = "$plot{'align'}"
- alt = "$plot{'alttag'}" />
+ width = "$Apache::lonplot::plot{'width'}"
+ height = "$Apache::lonplot::plot{'height'}"
+ align = "$Apache::lonplot::plot{'align'}"
+ alt = "$Apache::lonplot::plot{'alttag'}" />
ENDIMAGE
} elsif ($target eq 'tex') {
+ &Apache::lonxml::debug(" gnuplot wid = $Apache::lonplot::plot{'width'}");
+ &Apache::lonxml::debug(" gnuplot ht = $Apache::lonplot::plot{'height'}");
#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 = '\graphicspath{{/home/httpd/perl/tmp/}}\includegraphics[width='.$plot{'texwidth'}.' mm]{'.&Apache::lonnet::unescape($filename).'.eps}';
+ $result = "%DYNAMICIMAGE:$Apache::lonplot::plot{'width'}:$Apache::lonplot::plot{'height'}:$Apache::lonplot::plot{'texwidth'}\n";
+ $result .= '\graphicspath{{/home/httpd/perl/tmp/}}'."\n";
+ $result .= '\includegraphics[width='.$Apache::lonplot::plot{'texwidth'}.' mm]{'.&Apache::lonnet::unescape($filename).'.eps}';
}
} elsif ($target eq 'edit') {
$result.=&Apache::edit::tag_end($target,$token);
@@ -631,7 +698,7 @@ sub start_title {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
my $result='';
if ($target eq 'web' || $target eq 'tex') {
- $title = &Apache::lonxml::get_all_text("/title",$parser);
+ $title = &Apache::lonxml::get_all_text("/title",$parser,$style);
$title=&Apache::run::evaluate($title,$safeeval,$$parstack[-1]);
$title =~ s/\n/ /g;
if (length($title) > $max_str_len) {
@@ -639,7 +706,7 @@ sub start_title {
}
} elsif ($target eq 'edit') {
$result.=&Apache::edit::tag_start($target,$token,'Plot Title');
- my $text=&Apache::lonxml::get_all_text("/title",$parser);
+ my $text=&Apache::lonxml::get_all_text("/title",$parser,$style);
$result.=&Apache::edit::end_row().
&Apache::edit::start_spanning_row().
&Apache::edit::editline('',$text,'',60);
@@ -664,7 +731,7 @@ sub start_xlabel {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
my $result='';
if ($target eq 'web' || $target eq 'tex') {
- $xlabel = &Apache::lonxml::get_all_text("/xlabel",$parser);
+ $xlabel = &Apache::lonxml::get_all_text("/xlabel",$parser,$style);
$xlabel=&Apache::run::evaluate($xlabel,$safeeval,$$parstack[-1]);
$xlabel =~ s/\n/ /g;
if (length($xlabel) > $max_str_len) {
@@ -672,7 +739,7 @@ sub start_xlabel {
}
} elsif ($target eq 'edit') {
$result.=&Apache::edit::tag_start($target,$token,'Plot Xlabel');
- my $text=&Apache::lonxml::get_all_text("/xlabel",$parser);
+ my $text=&Apache::lonxml::get_all_text("/xlabel",$parser,$style);
$result.=&Apache::edit::end_row().
&Apache::edit::start_spanning_row().
&Apache::edit::editline('',$text,'',60);
@@ -698,7 +765,7 @@ sub start_ylabel {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
my $result='';
if ($target eq 'web' || $target eq 'tex') {
- $ylabel = &Apache::lonxml::get_all_text("/ylabel",$parser);
+ $ylabel = &Apache::lonxml::get_all_text("/ylabel",$parser,$style);
$ylabel = &Apache::run::evaluate($ylabel,$safeeval,$$parstack[-1]);
$ylabel =~ s/\n/ /g;
if (length($ylabel) > $max_str_len) {
@@ -706,7 +773,7 @@ sub start_ylabel {
}
} elsif ($target eq 'edit') {
$result .= &Apache::edit::tag_start($target,$token,'Plot Ylabel');
- my $text = &Apache::lonxml::get_all_text("/ylabel",$parser);
+ my $text = &Apache::lonxml::get_all_text("/ylabel",$parser,$style);
$result .= &Apache::edit::end_row().
&Apache::edit::start_spanning_row().
&Apache::edit::editline('',$text,'',60);
@@ -735,7 +802,7 @@ sub start_label {
my %label;
&get_attributes(\%label,\%label_defaults,$parstack,$safeeval,
$tagstack->[-1]);
- my $text = &Apache::lonxml::get_all_text("/label",$parser);
+ my $text = &Apache::lonxml::get_all_text("/label",$parser,$style);
$text = &Apache::run::evaluate($text,$safeeval,$$parstack[-1]);
$text =~ s/\n/ /g;
$text = substr($text,0,$max_str_len) if (length($text) > $max_str_len);
@@ -744,7 +811,7 @@ sub start_label {
} elsif ($target eq 'edit') {
$result .= &Apache::edit::tag_start($target,$token,'Plot Label');
$result .= &edit_attributes($target,$token,\%label_defaults);
- my $text = &Apache::lonxml::get_all_text("/label",$parser);
+ my $text = &Apache::lonxml::get_all_text("/label",$parser,$style);
$result .= &Apache::edit::end_row().
&Apache::edit::start_spanning_row().
&Apache::edit::editline('',$text,'',60);
@@ -818,12 +885,13 @@ sub start_function {
'curve function declaration.');
delete $curves[-1]->{'data'} ;
}
- my $function = &Apache::lonxml::get_all_text("/function",$parser);
+ my $function = &Apache::lonxml::get_all_text("/function",$parser,
+ $style);
$function = &Apache::run::evaluate($function,$safeeval,$$parstack[-1]);
$curves[-1]->{'function'} = $function;
} elsif ($target eq 'edit') {
$result .= &Apache::edit::tag_start($target,$token,'Gnuplot compatible curve function');
- my $text = &Apache::lonxml::get_all_text("/function",$parser);
+ my $text = &Apache::lonxml::get_all_text("/function",$parser,$style);
$result .= &Apache::edit::end_row().
&Apache::edit::start_spanning_row().
&Apache::edit::editline('',$text,'',60);
@@ -857,7 +925,7 @@ sub start_data {
'curve data declaration.');
delete($curves[-1]->{'function'});
}
- my $datatext = &Apache::lonxml::get_all_text("/data",$parser);
+ my $datatext = &Apache::lonxml::get_all_text("/data",$parser,$style);
$datatext=&Apache::run::evaluate($datatext,$safeeval,$$parstack[-1]);
# Deal with cases where we're given an array...
if ($datatext =~ /^\@/) {
@@ -900,7 +968,7 @@ sub start_data {
push @{$curves[-1]->{'data'}},\@data;
} elsif ($target eq 'edit') {
$result .= &Apache::edit::tag_start($target,$token,'Comma or space deliminated curve data');
- my $text = &Apache::lonxml::get_all_text("/data",$parser);
+ my $text = &Apache::lonxml::get_all_text("/data",$parser,$style);
$result .= &Apache::edit::end_row().
&Apache::edit::start_spanning_row().
&Apache::edit::editline('',$text,'',60);
@@ -999,7 +1067,7 @@ sub write_gnuplot_file {
my ($tmpdir,$filename,$target)= @_;
my $gnuplot_input = '';
my $curve;
- my $pt = $plot{'texfont'};
+ my $pt = $Apache::lonplot::plot{'texfont'};
#
# Check to be sure we do not have any empty curves
my @curvescopy;
@@ -1020,58 +1088,74 @@ sub write_gnuplot_file {
@curves = @curvescopy;
# Collect all the colors
my @Colors;
- push @Colors, $plot{'bgcolor'};
- push @Colors, $plot{'fgcolor'};
- push @Colors, (defined($axis{'color'})?$axis{'color'}:$plot{'fgcolor'});
+ push @Colors, $Apache::lonplot::plot{'bgcolor'};
+ push @Colors, $Apache::lonplot::plot{'fgcolor'};
+ push @Colors, (defined($axis{'color'})?$axis{'color'}:$Apache::lonplot::plot{'fgcolor'});
foreach $curve (@curves) {
push @Colors, ($curve->{'color'} ne '' ?
$curve->{'color'} :
- $plot{'fgcolor'} );
+ $Apache::lonplot::plot{'fgcolor'} );
}
# set term
if ($target eq 'web') {
$gnuplot_input .= 'set term '.$weboutputformat .' ';
- $gnuplot_input .= 'transparent ' if ($plot{'transparent'} eq 'on');
- $gnuplot_input .= $plot{'font'} . ' ';
- $gnuplot_input .= 'size '.$plot{'width'}.','.$plot{'height'}.' ';
+ $gnuplot_input .= 'transparent ' if ($Apache::lonplot::plot{'transparent'} eq 'on');
+ $gnuplot_input .= $Apache::lonplot::plot{'font'} . ' ';
+ $gnuplot_input .= 'size '.$Apache::lonplot::plot{'width'}.','.$Apache::lonplot::plot{'height'}.' ';
$gnuplot_input .= "@Colors\n";
# set output
$gnuplot_input .= "set output\n";
} elsif ($target eq 'tex') {
- $gnuplot_input .= "set term postscript eps monochrome solid \"Helvetica\" $pt \n";
+ $gnuplot_input .= "set term postscript eps $Apache::lonplot::plot{'plotcolor'} solid \"Helvetica\" $pt \n";
$gnuplot_input .= "set output \"/home/httpd/perl/tmp/".
&Apache::lonnet::unescape($filename).".eps\"\n";
}
# cartesian or polar?
- if (lc($plot{'plottype'}) eq 'polar') {
+ if (lc($Apache::lonplot::plot{'plottype'}) eq 'polar') {
$gnuplot_input .= 'set polar'.$/;
} else {
# Assume Cartesian
}
+ # solid or pattern for boxes?
+ if (lc($Apache::lonplot::plot{'fillstyle'}) eq 'solid') {
+ $gnuplot_input .= 'set style fill solid '.
+ $Apache::lonplot::plot{'solid'}.$Apache::lonplot::plot{'box_border'}.$/;
+ } elsif (lc($Apache::lonplot::plot{'fillstyle'}) eq 'pattern') {
+ $gnuplot_input .= 'set style fill pattern '.$Apache::lonplot::plot{'pattern'}.$Apache::lonplot::plot{'box_border'}.$/;
+ } elsif (lc($Apache::lonplot::plot{'fillstyle'}) eq 'empty') {
+ }
# margin
- if (lc($plot{'lmargin'}) ne 'default') {
- $gnuplot_input .= 'set lmargin '.$plot{'lmargin'}.$/;
+ if (lc($Apache::lonplot::plot{'lmargin'}) ne 'default') {
+ $gnuplot_input .= 'set lmargin '.$Apache::lonplot::plot{'lmargin'}.$/;
}
- if (lc($plot{'rmargin'}) ne 'default') {
- $gnuplot_input .= 'set rmargin '.$plot{'rmargin'}.$/;
+ if (lc($Apache::lonplot::plot{'rmargin'}) ne 'default') {
+ $gnuplot_input .= 'set rmargin '.$Apache::lonplot::plot{'rmargin'}.$/;
}
- if (lc($plot{'tmargin'}) ne 'default') {
- $gnuplot_input .= 'set tmargin '.$plot{'tmargin'}.$/;
+ if (lc($Apache::lonplot::plot{'tmargin'}) ne 'default') {
+ $gnuplot_input .= 'set tmargin '.$Apache::lonplot::plot{'tmargin'}.$/;
}
- if (lc($plot{'bmargin'}) ne 'default') {
- $gnuplot_input .= 'set bmargin '.$plot{'bmargin'}.$/;
+ if (lc($Apache::lonplot::plot{'bmargin'}) ne 'default') {
+ $gnuplot_input .= 'set bmargin '.$Apache::lonplot::plot{'bmargin'}.$/;
}
# tic scales
$gnuplot_input .= 'set ticscale '.
- $plot{'major_ticscale'}.' '.$plot{'minor_ticscale'}.$/;
+ $Apache::lonplot::plot{'major_ticscale'}.' '.$Apache::lonplot::plot{'minor_ticscale'}.$/;
+ #boxwidth
+ if (lc($Apache::lonplot::plot{'boxwidth'}) ne '') {
+ $gnuplot_input .= 'set boxwidth '.$Apache::lonplot::plot{'boxwidth'}.$/;
+ }
+ # gridlayer
+ $gnuplot_input .= 'set grid noxtics noytics front '.$/
+ if ($Apache::lonplot::plot{'gridlayer'} eq 'on');
+
# grid
- $gnuplot_input .= 'set grid'.$/ if ($plot{'grid'} eq 'on');
+ $gnuplot_input .= 'set grid'.$/ if ($Apache::lonplot::plot{'grid'} eq 'on');
# border
- $gnuplot_input .= ($plot{'border'} eq 'on'?
+ $gnuplot_input .= ($Apache::lonplot::plot{'border'} eq 'on'?
'set border'.$/ :
'set noborder'.$/ );
# sampling rate for non-data curves
- $gnuplot_input .= "set samples $plot{'samples'}\n";
+ $gnuplot_input .= "set samples $Apache::lonplot::plot{'samples'}\n";
# title, xlabel, ylabel
# titles
if ($target eq 'tex') {
@@ -1130,7 +1214,7 @@ sub write_gnuplot_file {
$gnuplot_input .= $/;
}
if ($target eq 'tex') {
- $gnuplot_input .="set size 1,".$plot{'height'}/$plot{'width'}*1.38;
+ $gnuplot_input .="set size 1,".$Apache::lonplot::plot{'height'}/$Apache::lonplot::plot{'width'}*1.38;
$gnuplot_input .="\n";
}
# curves
@@ -1152,6 +1236,8 @@ sub write_gnuplot_file {
($curve->{'linestyle'} eq 'xyerrorbars')) {
$gnuplot_input.=' pointtype '.$curve->{'pointtype'};
$gnuplot_input.=' pointsize '.$curve->{'pointsize'};
+ } elsif ($curve->{'linestyle'} eq 'filledcurves') {
+ $gnuplot_input.= ' '.$curve->{'limit'};
}
} elsif (exists($curve->{'data'})) {
# Store data values in $datatext
@@ -1185,6 +1271,8 @@ sub write_gnuplot_file {
($curve->{'linestyle'} eq 'xyerrorbars')) {
$gnuplot_input.=' pointtype '.$curve->{'pointtype'};
$gnuplot_input.=' pointsize '.$curve->{'pointsize'};
+ } elsif ($curve->{'linestyle'} eq 'filledcurves') {
+ $gnuplot_input.= ' '.$curve->{'limit'};
}
}
}
@@ -1200,7 +1288,7 @@ sub write_gnuplot_file {
sub check_inputs {
## Note: no inputs, no outputs - this acts only on global variables.
## Make sure we have all the input we need:
- if (! %plot) { &set_defaults(\%plot,\%gnuplot_defaults); }
+ if (! %Apache::lonplot::plot) { &set_defaults(\%Apache::lonplot::plot,\%gnuplot_defaults); }
if (! %key ) {} # No key for this plot, thats okay
# if (! %axis) { &set_defaults(\%axis,\%axis_defaults); }
if (! defined($title )) {} # No title for this plot, thats okay