--- loncom/xml/lonplot.pm 2002/01/08 21:41:20 1.34
+++ loncom/xml/lonplot.pm 2002/02/27 16:54:58 1.50
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Dynamic plot
#
-# $Id: lonplot.pm,v 1.34 2002/01/08 21:41:20 matthew Exp $
+# $Id: lonplot.pm,v 1.50 2002/02/27 16:54:58 matthew Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -28,7 +28,9 @@
# 12/15/01 Matthew
# 12/17 12/18 12/19 12/20 12/21 12/27 12/28 12/30 12/31 Matthew
# 01/01/02 Matthew
-# 01/02 01/03 01/04 Matthew
+# 01/02 01/03 01/04 01/07 01/08 01/09 Matthew
+# 01/21 02/05 02/06 Matthew
+
package Apache::lonplot;
use strict;
@@ -38,7 +40,7 @@ use Apache::lonxml;
use Apache::edit;
BEGIN {
- &Apache::lonxml::register('Apache::lonplot',('plot'));
+ &Apache::lonxml::register('Apache::lonplot',('gnuplot'));
}
##
@@ -87,13 +89,13 @@ my %linestyles =
errorbars => 3,
xerrorbars => [3,4],
yerrorbars => [3,4],
- xyerrorbars => [4,6,7],
+ xyerrorbars => [4,6],
boxes => 3,
- boxerrorbars => [3,4,5],
- boxxyerrorbars => [4,6,7],
- financebars => 5,
- candlesticks => 5,
- vector => 2
+# boxerrorbars => [3,4,5],
+# boxxyerrorbars => [4,6,7],
+# financebars => 5,
+# candlesticks => 5,
+ vector => 4
);
my $int_test = sub {$_[0]=~s/\s+//g;$_[0]=~/^\d+$/};
@@ -111,51 +113,86 @@ my $words_test = sub {$_[0]=~s/\s+/
## Attribute metadata ##
## ##
###################################################################
-my @plot_edit_order =
- qw/bgcolor fgcolor height width font transparent grid border/;
-my %plot_defaults =
+my @gnuplot_edit_order =
+ qw/bgcolor fgcolor height width font transparent grid border align/;
+
+my $gnuplot_help_text = <<"ENDPLOTHELP";
+
+The gnuplot tag allows an author to design a plot which can
+be created on the fly. This is intended for use in homework problems
+where each student needs to see a distinct plot. It can be used in
+conjunction with a script tag to generate random plots.
+
+A gnuplot tag can contain the following sub-tags:
+
+
+
Plot Label
+
Allows you to place text at a given (x,y) coordinate on the plot.
+
Plot Title
+
The title of the plot
+
Plot Xlabel
+
The label on the horizontal axis of the plot
+
Plot Ylabel
+
The label on the vertical axis of the plot
+
Plot Axes
+
allows specification of the x and y ranges displayed in the plot
+
Plot Key
+
Lists the functions displayed in the plot.
+
Plot Curve
+
Sets the data used in the plot.
+
Plot Tics
+
Allows specification of the x and y coordinate 'tics' on the axes.
+This is mostly used to adjust the grid lines when a grid is displayed.
+
+ENDPLOTHELP
+
+my %gnuplot_defaults =
(
height => {
default => 200,
test => $int_test,
description => 'height of image (pixels)',
- edit_type => 'entry'
+ edit_type => 'entry',
+ size => '10'
},
width => {
default => 200,
test => $int_test,
description => 'width of image (pixels)',
- edit_type => 'entry'
+ edit_type => 'entry',
+ size => '10'
},
bgcolor => {
default => 'xffffff',
test => $color_test,
description => 'background color of image (xffffff)',
- edit_type => 'entry'
+ edit_type => 'entry',
+ size => '10'
},
fgcolor => {
default => 'x000000',
test => $color_test,
description => 'foreground color of image (x000000)',
- edit_type => 'entry'
+ edit_type => 'entry',
+ size => '10'
},
transparent => {
default => 'off',
test => $onoff_test,
description => 'Transparent image',
- edit_type => 'on_off'
+ edit_type => 'onoff'
},
grid => {
default => 'off',
test => $onoff_test,
description => 'Display grid',
- edit_type => 'on_off'
+ edit_type => 'onoff'
},
border => {
default => 'on',
test => $onoff_test,
description => 'Draw border around plot',
- edit_type => 'on_off'
+ edit_type => 'onoff'
},
font => {
default => 'medium',
@@ -179,13 +216,14 @@ my %key_defaults =
default => '',
test => $words_test,
description => 'Title of key',
- edit_type => 'entry'
+ edit_type => 'entry',
+ size => '40'
},
box => {
default => 'off',
test => $onoff_test,
description => 'Draw a box around the key?',
- edit_type => 'on_off'
+ edit_type => 'onoff'
},
pos => {
default => 'top right',
@@ -203,13 +241,15 @@ my %label_defaults =
default => 0,
test => $real_test,
description => 'x position of label (graph coordinates)',
- edit_type => 'entry'
+ edit_type => 'entry',
+ size => '10'
},
ypos => {
default => 0,
test => $real_test,
description => 'y position of label (graph coordinates)',
- edit_type => 'entry'
+ edit_type => 'entry',
+ size => '10'
},
justify => {
default => 'left',
@@ -220,64 +260,137 @@ my %label_defaults =
}
);
+my @tic_edit_order = ('location','mirror','start','increment','end');
+my %tic_defaults =
+ (
+ location => {
+ default => 'border',
+ test => sub {$_[0]=~/^(border|axis)$/},
+ description => 'Location of tick marks',
+ edit_type => 'choice',
+ choices => ['border','axis']
+ },
+ mirror => {
+ default => 'on',
+ test => $onoff_test,
+ description => 'mirror ticks on opposite axis?',
+ edit_type => 'onoff'
+ },
+ start => {
+ default => '-10.0',
+ test => $real_test,
+ description => 'Start ticks at',
+ edit_type => 'entry',
+ size => '10'
+ },
+ increment => {
+ default => '1.0',
+ test => $real_test,
+ description => 'Place a tick every',
+ edit_type => 'entry',
+ size => '10'
+ },
+ end => {
+ default => ' 10.0',
+ test => $real_test,
+ description => 'Stop ticks at ',
+ edit_type => 'entry',
+ size => '10'
+ },
+ );
+
my %axis_defaults =
(
color => {
default => 'x000000',
test => $color_test,
description => 'color of axes (x000000)',
- edit_type => 'entry'
+ edit_type => 'entry',
+ size => '10'
},
xmin => {
default => '-10.0',
test => $real_test,
description => 'minimum x-value shown in plot',
- edit_type => 'entry'
+ edit_type => 'entry',
+ size => '10'
},
xmax => {
default => ' 10.0',
test => $real_test,
description => 'maximum x-value shown in plot',
- edit_type => 'entry'
+ edit_type => 'entry',
+ size => '10'
},
ymin => {
default => '-10.0',
test => $real_test,
description => 'minimum y-value shown in plot',
- edit_type => 'entry'
+ edit_type => 'entry',
+ size => '10'
},
ymax => {
default => ' 10.0',
test => $real_test,
description => 'maximum y-value shown in plot',
- edit_type => 'entry'
+ edit_type => 'entry',
+ size => '10'
}
);
+my $curve_help_text = <<"ENDCURVEHELP";
+The curve tag is where you set the data to be plotted by gnuplot.
+There are two ways of entering the information:
+
+
Curve Data
+
Using a data tag you can specify the numbers used to produce
+the plot.
+
+By default, two data tags will be available in a plot. The
+first will specify X coordinates of the data and the second will
+give the Y coordinates of the data. When working with a linestyle that
+requires more than two data sets, inserting another data tag is
+required. Unfortunately, you must make sure the data tags appear
+in the order gnuplot expects the data.
+
+Specifying the data should usually be done with a perl variable or array,
+such as \@Xdata and \@Ydata. You may also specify numerical data seperated
+by commas. Again, the order of the data tags is important. The
+first tag will be the X data and the second will be the Y data.
+
+
Curve Function
+
The function tag allows you to specify the curve to be
+plotted as a formula that gnuplot can understand. Be careful using this
+tag - it is surprisingly easy to give gnuplot a function it cannot deal
+with properly. Be explicit: 2*sin(2*3.141592*x/4) will work but
+2sin(2*3.141592x/4) will not. If you do not receive any errors in the
+gnuplot data but still do not have an image produced, it is likely there
+is an error in your function tag.
+
'.
+ $result .= &Apache::edit::end_row().
+ &Apache::edit::start_spanning_row().
&Apache::edit::editfield('',$text,'',60,1);
} elsif ($target eq 'modified') {
- # Why do I do this?
+ $result.=&Apache::edit::rebuild_tag($token);
my $text=$$parser[-1]->get_text("/function");
$result.=&Apache::edit::modifiedfield($token);
}
@@ -598,12 +784,17 @@ sub start_data {
delete($curves[-1]->{'function'});
}
my $datatext = &Apache::lonxml::get_all_text("/data",$$parser[-1]);
- $datatext =~ s/\s+/ /g;
+ # Deal with cases where we're given an array...
+ if ($datatext =~ /^\@/) {
+ $datatext = &Apache::run::run('return "'.$datatext.'"',
+ $safeeval,1);
+ }
+ $datatext =~ s/\s+/ /g;
# Need to do some error checking on the @data array -
# make sure it's all numbers and make sure each array
# is of the same length.
my @data;
- if ($datatext =~ /,/) {
+ if ($datatext =~ /,/) { # comma deliminated
@data = split /,/,$datatext;
} else { # Assume it's space seperated.
@data = split / /,$datatext;
@@ -624,13 +815,22 @@ sub start_data {
$data[$i] = 1.15572734979092;
}
}
+ # 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]}})){
+ &Apache::lonxml::warning
+ ('Number of data points is not consistent with previous '.
+ 'number of data points');
+ }
push @{$curves[-1]->{'data'}},\@data;
} elsif ($target eq 'edit') {
- $result .= &Apache::edit::tag_start($target,$token,'Curve Data');
+ $result .= &Apache::edit::tag_start($target,$token,'Comma or space deliminated curve data');
my $text = &Apache::lonxml::get_all_text("/data",$$parser[-1]);
- $result .= '
'.
+ $result .= &Apache::edit::end_row().
+ &Apache::edit::start_spanning_row().
&Apache::edit::editfield('',$text,'',60,1);
} elsif ($target eq 'modified') {
+ $result.=&Apache::edit::rebuild_tag($token);
my $text=$$parser[-1]->get_text("/data");
$result.=&Apache::edit::modifiedfield($token);
}
@@ -662,7 +862,6 @@ sub start_axis {
($token,$parstack,$safeeval,keys(%axis_defaults));
if ($constructtag) {
$result = &Apache::edit::rebuild_tag($token);
- $result.= &Apache::edit::handle_insert();
}
}
return $result;
@@ -714,8 +913,10 @@ sub get_attributes{
}
return ;
}
+
##------------------------------------------------------- write_gnuplot_file
sub write_gnuplot_file {
+ my ($tmpdir,$filename)= @_;
my $gnuplot_input = '';
my $curve;
# Collect all the colors
@@ -734,16 +935,34 @@ sub write_gnuplot_file {
$gnuplot_input .= $plot{'font'} . ' ';
$gnuplot_input .= 'size '.$plot{'width'}.','.$plot{'height'}.' ';
$gnuplot_input .= "@Colors\n";
+ # set output
+ $gnuplot_input .= "set output\n";
# grid
$gnuplot_input .= 'set grid'.$/ if ($plot{'grid'} eq 'on');
# border
$gnuplot_input .= ($plot{'border'} eq 'on'?
'set border'.$/ :
'set noborder'.$/ ); # title, xlabel, ylabel
- $gnuplot_input .= "set output\n";
+ # titles
$gnuplot_input .= "set title \"$title\"\n" if (defined($title)) ;
$gnuplot_input .= "set xlabel \"$xlabel\"\n" if (defined($xlabel));
$gnuplot_input .= "set ylabel \"$ylabel\"\n" if (defined($ylabel));
+ # tics
+ if (%xtics) {
+ $gnuplot_input .= "set xtics $xtics{'location'} ";
+ $gnuplot_input .= ( $xtics{'mirror'} eq 'on'?"mirror ":"nomirror ");
+ $gnuplot_input .= "$xtics{'start'}, ";
+ $gnuplot_input .= "$xtics{'increment'}, ";
+ $gnuplot_input .= "$xtics{'end'}\n";
+ }
+ 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";
+ }
+ # axis
if (%axis) {
$gnuplot_input .= "set xrange \[$axis{'xmin'}:$axis{'xmax'}\]\n";
$gnuplot_input .= "set yrange \[$axis{'ymin'}:$axis{'ymax'}\]\n";
@@ -752,7 +971,7 @@ sub write_gnuplot_file {
if (%key) {
$gnuplot_input .= 'set key '.$key{'pos'}.' ';
if ($key{'title'} ne '') {
- $gnuplot_input .= 'title "'.$key{'title'}.'" ';
+ $gnuplot_input .= 'title " '.$key{'title'}.'" ';
}
$gnuplot_input .= ($key{'box'} eq 'on' ? 'box ' : 'nobox ').$/;
} else {
@@ -766,7 +985,6 @@ sub write_gnuplot_file {
}
# curves
$gnuplot_input .= 'plot ';
- my $datatext = '';
for (my $i = 0;$i<=$#curves;$i++) {
$curve = $curves[$i];
$gnuplot_input.= ', ' if ($i > 0);
@@ -776,9 +994,12 @@ sub write_gnuplot_file {
$curve->{'name'}.'" with '.
$curve->{'linestyle'};
} elsif (exists($curve->{'data'})) {
- $gnuplot_input.= '\'-\' title "'.
- $curve->{'name'}.'" with '.
- $curve->{'linestyle'};
+ # Store data values in $datatext
+ my $datatext = '';
+ # get new filename
+ my $datafilename = "$tmpdir/$filename.$i";
+ my $fh=Apache::File->new(">$datafilename");
+ # Compile data
my @Data = @{$curve->{'data'}};
my @Data0 = @{$Data[0]};
for (my $i =0; $i<=$#Data0; $i++) {
@@ -788,18 +1009,28 @@ sub write_gnuplot_file {
}
$datatext .= $/;
}
- $datatext .=$/;
+ # write file
+ print $fh $datatext;
+ close ($fh);
+ # generate gnuplot text
+ $gnuplot_input.= '"'.$datafilename.'" title "'.
+ $curve->{'name'}.'" with '.
+ $curve->{'linestyle'};
}
}
- $gnuplot_input .= $/.$datatext;
- return $gnuplot_input;
+ # Write the output to a file.
+ my $fh=Apache::File->new(">$tmpdir$filename");
+ print $fh $gnuplot_input;
+ close($fh);
+ # That's all folks.
+ return ;
}
#---------------------------------------------- check_inputs
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,\%plot_defaults); }
+ if (! %plot) { &set_defaults(\%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
@@ -829,23 +1060,19 @@ sub edit_attributes {
@keys = sort(keys(%$defaults));
}
foreach my $attr (@keys) {
+ # append a ' ' to the description if it doesn't have one already.
+ my $description = $defaults->{$attr}->{'description'};
+ $description .= ' ' if ($description !~ / $/);
if ($defaults->{$attr}->{'edit_type'} eq 'entry') {
- $result .= &Apache::edit::text_arg(
- $defaults->{$attr}->{'description'},
- $attr,
- $token);
+ $result .= &Apache::edit::text_arg
+ ($description,$attr,$token,
+ $defaults->{$attr}->{'size'});
} elsif ($defaults->{$attr}->{'edit_type'} eq 'choice') {
- $result .= &Apache::edit::select_arg(
- $defaults->{$attr}->{'description'},
- $attr,
- $defaults->{$attr}->{'choices'},
- $token);
- } elsif ($defaults->{$attr}->{'edit_type'} eq 'on_off') {
- $result .= &Apache::edit::select_arg(
- $defaults->{$attr}->{'description'},
- $attr,
- ['on','off'],
- $token);
+ $result .= &Apache::edit::select_arg
+ ($description,$attr,$defaults->{$attr}->{'choices'},$token);
+ } elsif ($defaults->{$attr}->{'edit_type'} eq 'onoff') {
+ $result .= &Apache::edit::select_arg
+ ($description,$attr,['on','off'],$token);
}
$result .= ' ';
}
@@ -859,30 +1086,55 @@ sub edit_attributes {
## ##
###################################################################
-#------------------------------------------------ insert_xxxxxxx
-sub insert_plot {
+sub insert_gnuplot {
my $result = '';
# plot attributes
- $result .= "{'default'}\"\n";
+ $result .= "{'default'}\"\n";
}
$result .= ">\n";
- # Add the components
- $result .= &insert_key();
- $result .= &insert_axis();
- $result .= &insert_title();
- $result .= &insert_xlabel();
- $result .= &insert_ylabel();
+ # Add the components (most are commented out for simplicity)
+ # $result .= &insert_key();
+ # $result .= &insert_axis();
+ # $result .= &insert_title();
+ # $result .= &insert_xlabel();
+ # $result .= &insert_ylabel();
$result .= &insert_curve();
- # close up the
- $result .= "\n";
+ # close up the
+ $result .= "\n";
+ return $result;
+}
+
+sub insert_tics {
+ my $result;
+ $result .= &insert_xtics() . &insert_ytics;
+ return $result;
+}
+
+sub insert_xtics {
+ my $result;
+ $result .= "\n {'default'}\" ";
+ }
+ $result .= "/>\n";
+ return $result;
+}
+
+sub insert_ytics {
+ my $result;
+ $result .= "\n {'default'}\" ";
+ }
+ $result .= "/>\n";
return $result;
}
sub insert_key {
my $result;
- $result .= " {'default'}\"\n";
}
@@ -892,7 +1144,7 @@ sub insert_key {
sub insert_axis{
my $result;
- $result .= ' {'default'}\"\n";
}
@@ -900,13 +1152,13 @@ sub insert_axis{
return $result;
}
-sub insert_title { return " \n"; }
-sub insert_xlabel { return " \n"; }
-sub insert_ylabel { return " \n"; }
+sub insert_title { return "\n \n"; }
+sub insert_xlabel { return "\n \n"; }
+sub insert_ylabel { return "\n \n"; }
sub insert_label {
my $result;
- $result .= '