--- loncom/xml/lonplot.pm 2001/12/31 17:30:09 1.27
+++ loncom/xml/lonplot.pm 2002/01/09 16:58:18 1.36
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Dynamic plot
#
-# $Id: lonplot.pm,v 1.27 2001/12/31 17:30:09 matthew Exp $
+# $Id: lonplot.pm,v 1.36 2002/01/09 16:58:18 matthew Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -26,7 +26,16 @@
# http://www.lon-capa.org/
#
# 12/15/01 Matthew
-# 12/17 12/18 12/19 12/20 12/21 12/27 12/28 12/30 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 01/07 01/08 01/09 Matthew
+
+# Current issues
+# 1. Gnuplot is unable to vary the color or linestyle of <data> plots.
+# The key does not know this so it is misleading for the user.
+# Multiple <function>s can be plotted with varying line styles and
+# colors.
+#
package Apache::lonplot;
use strict;
@@ -35,7 +44,7 @@ use Apache::response;
use Apache::lonxml;
use Apache::edit;
-sub BEGIN {
+BEGIN {
&Apache::lonxml::register('Apache::lonplot',('plot'));
}
@@ -69,6 +78,31 @@ sub BEGIN {
## Tests used in checking the validitity of input ##
## ##
###################################################################
+
+my $max_str_len = 50; # if a label, title, xlabel, or ylabel text
+ # is longer than this, it will be truncated.
+
+my %linestyles =
+ (
+ lines => 2, # Maybe this will be used in the future
+ linespoints => 2, # to check on whether or not they have
+ dots => 2, # supplied enough <data></data> fields
+ points => 2, # to use the given line style. But for
+ steps => 2, # now there are more important things
+ fsteps => 2, # for me to deal with.
+ histeps => 2,
+ errorbars => 3,
+ xerrorbars => [3,4],
+ yerrorbars => [3,4],
+ xyerrorbars => [4,6],
+ boxes => 3,
+# boxerrorbars => [3,4,5],
+# boxxyerrorbars => [4,6,7],
+# financebars => 5,
+# candlesticks => 5,
+ vector => 4
+ );
+
my $int_test = sub {$_[0]=~s/\s+//g;$_[0]=~/^\d+$/};
my $real_test =
sub {$_[0]=~s/\s+//g;$_[0]=~/^[+-]?\d*\.?\d*([eE][+-]\d+)?$/};
@@ -76,7 +110,7 @@ my $color_test = sub {$_[0]=~s/\s+//
my $onoff_test = sub {$_[0]=~/^(on|off)$/};
my $key_pos_test = sub {$_[0]=~/^(top|bottom|right|left|outside|below| )+$/};
my $sml_test = sub {$_[0]=~/^(small|medium|large)$/};
-my $linestyle_test = sub {$_[0]=~/^(lines|linespoints|dots|points|steps)$/};
+my $linestyle_test = sub {exists($linestyles{$_[0]})};
my $words_test = sub {$_[0]=~s/\s+/ /g;$_[0]=~/^([\w\(\)]+ ?)+$/};
###################################################################
@@ -84,18 +118,20 @@ 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 =
(
height => {
default => 200,
test => $int_test,
- description => 'vertical size of image (pixels)',
+ description => 'height of image (pixels)',
edit_type => 'entry'
},
width => {
default => 200,
test => $int_test,
- description => 'horizontal size of image (pixels)',
+ description => 'width of image (pixels)',
edit_type => 'entry'
},
bgcolor => {
@@ -113,19 +149,19 @@ my %plot_defaults =
transparent => {
default => 'off',
test => $onoff_test,
- description => '',
+ description => 'Transparent image',
edit_type => 'on_off'
},
grid => {
default => 'off',
test => $onoff_test,
- description => '',
+ description => 'Display grid',
edit_type => 'on_off'
},
border => {
default => 'on',
test => $onoff_test,
- description => '',
+ description => 'Draw border around plot',
edit_type => 'on_off'
},
font => {
@@ -193,7 +229,7 @@ my %label_defaults =
my %axis_defaults =
(
- color => {
+ color => {
default => 'x000000',
test => $color_test,
description => 'color of axes (x000000)',
@@ -222,13 +258,6 @@ my %axis_defaults =
test => $real_test,
description => 'maximum y-value shown in plot',
edit_type => 'entry'
- },
- linestyle => {
- default => 'points',
- test => $linestyle_test,
- description => 'Style of the axis lines',
- edit_type => 'choice',
- choices => ['lines','linespoints','dots','points']
}
);
@@ -249,9 +278,13 @@ my %curve_defaults =
linestyle => {
default => 'lines',
test => $linestyle_test,
- description => 'Style of the axis lines',
+ description => 'Line style',
edit_type => 'choice',
- choices => ['lines','linespoints','dots','points','steps']
+ choices => ['lines','linespoints','dots','points','steps',
+ 'fsteps','histeps','errorbars','xerrorbars',
+ 'yerrorbars','xyerrorbars','boxes','boxerrorbars',
+ 'boxxyerrorbars','financebars','candlesticks',
+ 'vector']
}
);
@@ -271,18 +304,17 @@ sub start_plot {
my $result='';
&Apache::lonxml::register('Apache::lonplot',
('title','xlabel','ylabel','key','axis','label','curve'));
- push (@Apache::lonxml::namespace,'plot');
- my $inside = &Apache::lonxml::get_all_text("/plot",$$parser[-1]);
+ push (@Apache::lonxml::namespace,'lonplot');
if ($target eq 'web') {
+ my $inside = &Apache::lonxml::get_all_text("/plot",$$parser[-1]);
$inside=&Apache::run::evaluate($inside,$safeeval,$$parstack[-1]);
- }
- &Apache::lonxml::newparser($parser,\$inside);
- if ($target eq 'web') {
+ &Apache::lonxml::newparser($parser,\$inside);
&get_attributes(\%plot,\%plot_defaults,$parstack,$safeeval,
$tagstack->[-1]);
} elsif ($target eq 'edit') {
$result .= &Apache::edit::tag_start($target,$token,'Plot');
- $result .= &edit_attributes($target,$token,\%plot_defaults);
+ $result .= &edit_attributes($target,$token,\%plot_defaults,
+ \@plot_edit_order);
} elsif ($target eq 'modified') {
my $constructtag=&Apache::edit::get_new_args
($token,$parstack,$safeeval,keys(%plot_defaults));
@@ -307,7 +339,7 @@ sub end_plot {
## Determine filename
my $tmpdir = '/home/httpd/perl/tmp/';
my $filename = $ENV{'user.name'}.'_'.$ENV{'user.domain'}.
- '_'.time.'_'.$$.'_plot.data';
+ '_'.time.'_'.$$.int(rand(1000)).'_plot.data';
## Write the plot description to the file
my $fh=Apache::File->new(">$tmpdir$filename");
print $fh &write_gnuplot_file();
@@ -363,13 +395,16 @@ sub start_title {
my $result='';
if ($target eq 'web') {
$title = &Apache::lonxml::get_all_text("/title",$$parser[-1]);
+ if (length($title) > $max_str_len) {
+ $title = substr($title,0,$max_str_len);
+ }
} elsif ($target eq 'edit') {
$result.=&Apache::edit::tag_start($target,$token,'Plot Title');
my $text=&Apache::lonxml::get_all_text("/title",$$parser[-1]);
$result.='</td></tr><tr><td colspan="3">'.
- &Apache::edit::editfield('',$text,'',20,1);
+ &Apache::edit::editfield('',$text,'',60,1);
} elsif ($target eq 'modified') {
- my $text=$$parser[-1]->get_text("/function");
+ my $text=$$parser[-1]->get_text("/title");
$result.=&Apache::edit::modifiedfield($token);
}
return $result;
@@ -390,13 +425,16 @@ sub start_xlabel {
my $result='';
if ($target eq 'web') {
$xlabel = &Apache::lonxml::get_all_text("/xlabel",$$parser[-1]);
+ if (length($xlabel) > $max_str_len) {
+ $xlabel = substr($xlabel,0,$max_str_len);
+ }
} elsif ($target eq 'edit') {
$result.=&Apache::edit::tag_start($target,$token,'Plot Xlabel');
my $text=&Apache::lonxml::get_all_text("/xlabel",$$parser[-1]);
$result.='</td></tr><tr><td colspan="3">'.
- &Apache::edit::editfield('',$text,'',20,1);
+ &Apache::edit::editfield('',$text,'',60,1);
} elsif ($target eq 'modified') {
- my $text=$$parser[-1]->get_text("/function");
+ my $text=$$parser[-1]->get_text("/xlabel");
$result.=&Apache::edit::modifiedfield($token);
}
return $result;
@@ -418,13 +456,16 @@ sub start_ylabel {
my $result='';
if ($target eq 'web') {
$ylabel = &Apache::lonxml::get_all_text("/ylabel",$$parser[-1]);
+ if (length($ylabel) > $max_str_len) {
+ $ylabel = substr($ylabel,0,$max_str_len);
+ }
} elsif ($target eq 'edit') {
$result .= &Apache::edit::tag_start($target,$token,'Plot Ylabel');
my $text = &Apache::lonxml::get_all_text("/ylabel",$$parser[-1]);
$result .= '</td></tr><tr><td colspan="3">'.
- &Apache::edit::editfield('',$text,'',20,1);
+ &Apache::edit::editfield('',$text,'',60,1);
} elsif ($target eq 'modified') {
- my $text=$$parser[-1]->get_text("/function");
+ my $text=$$parser[-1]->get_text("/ylabel");
$result.=&Apache::edit::modifiedfield($token);
}
return $result;
@@ -448,18 +489,16 @@ sub start_label {
my %label;
&get_attributes(\%label,\%label_defaults,$parstack,$safeeval,
$tagstack->[-1]);
- $label{'text'} = &Apache::lonxml::get_all_text("/label",$$parser[-1]);
- if (! &$words_test($label{'text'})) {
- # I should probably warn about it, too.
- $label{'text'} = 'Illegal text';
- }
+ my $text = &Apache::lonxml::get_all_text("/label",$$parser[-1]);
+ $text = substr($text,0,$max_str_len) if (length($text) > $max_str_len);
+ $label{'text'} = $text;
push(@labels,\%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[-1]);
$result .= '</td></tr><tr><td colspan="3">'.
- &Apache::edit::editfield('',$text,'',20,1);
+ &Apache::edit::editfield('',$text,'',60,1);
} elsif ($target eq 'modified') {
my $constructtag=&Apache::edit::get_new_args
($token,$parstack,$safeeval,keys(%label_defaults));
@@ -499,7 +538,7 @@ sub start_curve {
$result .= &edit_attributes($target,$token,\%curve_defaults);
} elsif ($target eq 'modified') {
my $constructtag=&Apache::edit::get_new_args
- ($token,$parstack,$safeeval,keys(%label_defaults));
+ ($token,$parstack,$safeeval,keys(%curve_defaults));
if ($constructtag) {
$result = &Apache::edit::rebuild_tag($token);
$result.= &Apache::edit::handle_insert();
@@ -535,7 +574,7 @@ sub start_function {
$result .= &Apache::edit::tag_start($target,$token,'Curve Function');
my $text = &Apache::lonxml::get_all_text("/function",$$parser[-1]);
$result .= '</td></tr><tr><td colspan="3">'.
- &Apache::edit::editfield('',$text,'',20,1);
+ &Apache::edit::editfield('',$text,'',60,1);
} elsif ($target eq 'modified') {
# Why do I do this?
my $text=$$parser[-1]->get_text("/function");
@@ -571,7 +610,7 @@ sub start_data {
# 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;
@@ -592,12 +631,19 @@ 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');
my $text = &Apache::lonxml::get_all_text("/data",$$parser[-1]);
$result .= '</td></tr><tr><td colspan="3">'.
- &Apache::edit::editfield('',$text,'',20,1);
+ &Apache::edit::editfield('',$text,'',60,1);
} elsif ($target eq 'modified') {
my $text=$$parser[-1]->get_text("/data");
$result.=&Apache::edit::modifiedfield($token);
@@ -626,6 +672,12 @@ sub start_axis {
$result .= &Apache::edit::tag_start($target,$token,'Plot Axes');
$result .= &edit_attributes($target,$token,\%axis_defaults);
} elsif ($target eq 'modified') {
+ my $constructtag=&Apache::edit::get_new_args
+ ($token,$parstack,$safeeval,keys(%axis_defaults));
+ if ($constructtag) {
+ $result = &Apache::edit::rebuild_tag($token);
+ $result.= &Apache::edit::handle_insert();
+ }
}
return $result;
}
@@ -637,12 +689,6 @@ sub end_axis {
} elsif ($target eq 'edit') {
$result.=&Apache::edit::tag_end($target,$token);
} elsif ($target eq 'modified') {
- my $constructtag=&Apache::edit::get_new_args
- ($token,$parstack,$safeeval,keys(%axis_defaults));
- if ($constructtag) {
- $result = &Apache::edit::rebuild_tag($token);
- $result.= &Apache::edit::handle_insert();
- }
}
return $result;
}
@@ -769,7 +815,7 @@ sub check_inputs {
## Make sure we have all the input we need:
if (! %plot) { &set_defaults(\%plot,\%plot_defaults); }
if (! %key ) {} # No key for this plot, thats okay
- if (! %axis) { &set_defaults(\%axis,\%axis_defaults); }
+# if (! %axis) { &set_defaults(\%axis,\%axis_defaults); }
if (! defined($title )) {} # No title for this plot, thats okay
if (! defined($xlabel)) {} # No xlabel for this plot, thats okay
if (! defined($ylabel)) {} # No ylabel for this plot, thats okay
@@ -789,20 +835,26 @@ sub check_inputs {
#------------------------------------------------ make_edit
sub edit_attributes {
- my ($target,$token,$defaults) = @_;
- my $result;
- foreach my $attr (sort keys(%$defaults)) {
+ my ($target,$token,$defaults,$keys) = @_;
+ my ($result,@keys);
+ if ($keys && ref($keys) eq 'ARRAY') {
+ @keys = @$keys;
+ } else {
+ @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);
} elsif ($defaults->{$attr}->{'edit_type'} eq 'choice') {
- $result .= &Apache::edit::select_arg(
- $defaults->{$attr}->{'description'},
- $attr,
- $defaults->{$attr}->{'choices'},
- $token);
+ $result .= &Apache::edit::select_arg
+ ($description,$attr,$defaults->{$attr}->{'choices'},$token);
+ } elsif ($defaults->{$attr}->{'edit_type'} eq 'on_off') {
+ $result .= &Apache::edit::select_arg
+ ($description,$attr,['on','off'],$token);
}
$result .= '<br />';
}
@@ -818,24 +870,20 @@ sub edit_attributes {
#------------------------------------------------ insert_xxxxxxx
sub insert_plot {
- my $result;
+ my $result = '';
# plot attributes
- $result .= '<plot ';
- foreach my $attr (%plot_defaults) {
- $result .= ' '.$attr.'="'.$plot_defaults{$attr}->{'default'}.
- "\"\n";
+ $result .= "<plot \n";
+ foreach my $attr (keys(%plot_defaults)) {
+ $result .= " $attr=\"$plot_defaults{$attr}->{'default'}\"\n";
}
$result .= ">\n";
# Add the components
$result .= &insert_key();
$result .= &insert_axis();
- $result .= &insert_label();
- $result .= &insert_curve();
- $result .= &insert_function();
- $result .= "</curve>\n";
+ $result .= &insert_title();
+ $result .= &insert_xlabel();
+ $result .= &insert_ylabel();
$result .= &insert_curve();
- $result .= &insert_data();
- $result .= "</curve>\n";
# close up the <plot>
$result .= "</plot>\n";
return $result;
@@ -843,10 +891,9 @@ sub insert_plot {
sub insert_key {
my $result;
- $result .= ' <key ';
- foreach my $attr (%key_defaults) {
- $result .= ' '.$attr.'="'.$key_defaults{$attr}->{'default'}.
- "\"\n";
+ $result .= " <key \n";
+ foreach my $attr (keys(%key_defaults)) {
+ $result .= " $attr=\"$key_defaults{$attr}->{'default'}\"\n";
}
$result .= " />\n";
return $result;
@@ -855,18 +902,21 @@ sub insert_key {
sub insert_axis{
my $result;
$result .= ' <axis ';
- foreach my $attr (%axis_defaults) {
- $result .= ' '.$attr.'="'.$axis_defaults{$attr}->{'default'}.
- "\"\n";
+ foreach my $attr (keys(%axis_defaults)) {
+ $result .= " $attr=\"$axis_defaults{$attr}->{'default'}\"\n";
}
$result .= " />\n";
return $result;
}
+sub insert_title { return " <title></title>\n"; }
+sub insert_xlabel { return " <xlabel></xlabel>\n"; }
+sub insert_ylabel { return " <ylabel></ylabel>\n"; }
+
sub insert_label {
my $result;
$result .= ' <label ';
- foreach my $attr (%label_defaults) {
+ foreach my $attr (keys(%label_defaults)) {
$result .= ' '.$attr.'="'.
$label_defaults{$attr}->{'default'}."\"\n";
}
@@ -877,11 +927,11 @@ sub insert_label {
sub insert_curve {
my $result;
$result .= ' <curve ';
- foreach my $attr (%curve_defaults) {
+ foreach my $attr (keys(%curve_defaults)) {
$result .= ' '.$attr.'="'.
$curve_defaults{$attr}->{'default'}."\"\n";
}
- $result .= " >\n";
+ $result .= " ></curve>\n";
}
sub insert_function {
@@ -893,7 +943,6 @@ sub insert_function {
sub insert_data {
my $result;
$result .= " <data></data>\n";
- $result .= " <data></data>\n";
return $result;
}