--- loncom/xml/lonplot.pm 2005/05/31 22:15:32 1.108 +++ loncom/xml/lonplot.pm 2007/09/18 23:30:25 1.118.2.2 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Dynamic plot # -# $Id: lonplot.pm,v 1.108 2005/05/31 22:15:32 foxr Exp $ +# $Id: lonplot.pm,v 1.118.2.2 2007/09/18 23:30:25 albertel Exp $ # # Copyright Michigan State University Board of Trustees # @@ -36,14 +36,13 @@ use Apache::response; use Apache::lonxml; use Apache::edit; use Apache::lonnet; +use lib '/home/httpd/lib/perl/'; +use LONCAPA; + use vars qw/$weboutputformat $versionstring/; -# -# This variable allows a callback to be registered -# if a gnuplot tag block is performed. -# -my $notify_callback; + BEGIN { &Apache::lonxml::register('Apache::lonplot',('gnuplot')); @@ -54,31 +53,9 @@ BEGIN { if ($versionstring =~ /^gnuplot 4/) { $weboutputformat = 'png'; } - $notify_callback = undef; } -# register_callback(\&callback) -# Arranges for callback to be invoked on the -# tag. -# -sub register_callback { - $notify_callback = shift; -} -# clear_callback(); -# Undefs the callback. -# -sub clear_callback { - $notify_callback = undef; -} -# invoke_callback() -# Invokes the callback if defined -# -sub invoke_callback { - if (defined $notify_callback) { - &$notify_callback(); - } -} ## ## Description of data structures: @@ -128,6 +105,7 @@ my %linestyles = yerrorbars => [3,4], xyerrorbars => [4,6], boxes => 3, + filledcurves => 2, vector => 4 ); @@ -150,8 +128,9 @@ 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 plotcolor plottype lmargin rmargin tmargin - bmargin major_ticscale minor_ticscale/; + border align texwidth texfont plotcolor plottype gridtype lmargin rmargin + tmargin bmargin major_ticscale minor_ticscale boxwidth gridlayer fillstyle + pattern solid/; my $margin_choices = ['default',0..20]; @@ -204,6 +183,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, @@ -217,7 +209,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', @@ -225,11 +217,11 @@ my %gnuplot_defaults = choices => ['100','200','500','1000','2000','5000'] }, align => { - default => 'center', - test => sub {$_[0]=~/^(left|right|center)$/}, + default => 'middle', + test => sub {$_[0]=~/^(left|right|middle|center)$/}, description => 'alignment for image in html', edit_type => 'choice', - choices => ['left','right','center'] + choices => ['left','right','middle'] }, texwidth => { default => '93', @@ -238,55 +230,90 @@ 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/], }, - plotcolor => { + plotcolor => { default => 'monochrome', test => sub {$_[0]=~/^(monochrome|color|colour)$/}, description => 'Color setting for printing:', edit_type => 'choice', choices => [qw/monochrome color colour/], }, - plottype => { + 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 => { + gridtype => { + default => 'Cartesian', + test => sub {$_[0]=~/^(Polar|Cartesian|Linear-Log|Log-Linear|Log-Log)$/}, + description => 'Grid type:', + edit_type => 'choice', + choices => ['Cartesian','Polar','Linear-Log','Log-Linear','Log-Log'] + }, + 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 => '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, @@ -440,7 +467,7 @@ my %axis_defaults = } ); -my @curve_edit_order = ('color','name','linestyle','pointtype','pointsize'); +my @curve_edit_order = ('color','name','linestyle','linewidth','pointtype','pointsize','limit'); my %curve_defaults = ( @@ -465,14 +492,13 @@ my %curve_defaults = edit_type => 'choice', choices => [keys(%linestyles)] }, -# gnuplots term=gif driver does not handle linewidth :( -# linewidth => { -# default => 1, -# test => $int_test, -# description => 'Line width (may not apply to all line styles)', -# edit_type => 'choice', -# choices => [1,2,3,4,5,6,7,8,9,10] -# }, + linewidth => { + default => 1, + test => $int_test, + description => 'Line width (may not apply to all line styles)', + edit_type => 'choice', + choices => [1,2,3,4,5,6,7,8,9,10] + }, pointsize => { default => 1, test => $pos_real_test, @@ -486,7 +512,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'] + }, ); ################################################################### @@ -516,7 +549,9 @@ sub start_gnuplot { } elsif ($target eq 'edit') { $result .= &Apache::edit::tag_start($target,$token,'GnuPlot'); $result .= &edit_attributes($target,$token,\%gnuplot_defaults, - \@gnuplot_edit_order); + \@gnuplot_edit_order) + .&Apache::edit::end_row() + .&Apache::edit::start_spanning_row(); } elsif ($target eq 'modified') { my $constructtag=&Apache::edit::get_new_args ($token,$parstack,$safeeval,keys(%gnuplot_defaults)); @@ -550,11 +585,11 @@ sub end_gnuplot { '_'.time.'_'.$$.$randnumber.'_plot'; ## Write the plot description to the file &write_gnuplot_file($tmpdir,$filename,$target); - $filename = &Apache::lonnet::escape($filename); + $filename = &escape($filename); ## return image tag for the plot if ($target eq 'web') { $result .= <<"ENDIMAGE"; - $max_str_len) { @@ -681,10 +717,8 @@ 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); - $result.=&Apache::edit::end_row(). - &Apache::edit::start_spanning_row(). - &Apache::edit::editline('',$text,'',60); + my $text=&Apache::lonxml::get_all_text("/title",$parser,$style); + $result.=&Apache::edit::editline('',$text,'',60); } elsif ($target eq 'modified') { $result.=&Apache::edit::rebuild_tag($token); $result.=&Apache::edit::modifiedfield("/title",$parser); @@ -706,7 +740,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) { @@ -714,10 +748,8 @@ 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); - $result.=&Apache::edit::end_row(). - &Apache::edit::start_spanning_row(). - &Apache::edit::editline('',$text,'',60); + my $text=&Apache::lonxml::get_all_text("/xlabel",$parser,$style); + $result.=&Apache::edit::editline('',$text,'',60); } elsif ($target eq 'modified') { $result.=&Apache::edit::rebuild_tag($token); $result.=&Apache::edit::modifiedfield("/xlabel",$parser); @@ -740,7 +772,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) { @@ -748,10 +780,8 @@ 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); - $result .= &Apache::edit::end_row(). - &Apache::edit::start_spanning_row(). - &Apache::edit::editline('',$text,'',60); + my $text = &Apache::lonxml::get_all_text("/ylabel",$parser,$style); + $result .= &Apache::edit::editline('',$text,'',60); } elsif ($target eq 'modified') { $result.=&Apache::edit::rebuild_tag($token); $result.=&Apache::edit::modifiedfield("/ylabel",$parser); @@ -777,7 +807,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); @@ -786,7 +816,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); @@ -823,13 +853,15 @@ sub start_curve { } elsif ($target eq 'edit') { $result .= &Apache::edit::tag_start($target,$token,'Curve'); $result .= &edit_attributes($target,$token,\%curve_defaults, - \@curve_edit_order); + \@curve_edit_order) + .&Apache::edit::end_row() + .&Apache::edit::start_spanning_row(); + } elsif ($target eq 'modified') { my $constructtag=&Apache::edit::get_new_args ($token,$parstack,$safeeval,keys(%curve_defaults)); if ($constructtag) { $result = &Apache::edit::rebuild_tag($token); - $result.= &Apache::edit::handle_insert(); } } return $result; @@ -860,15 +892,14 @@ 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); - $result .= &Apache::edit::end_row(). - &Apache::edit::start_spanning_row(). - &Apache::edit::editline('',$text,'',60); + my $text = &Apache::lonxml::get_all_text("/function",$parser,$style); + $result .= &Apache::edit::editline('',$text,'',60); } elsif ($target eq 'modified') { $result.=&Apache::edit::rebuild_tag($token); $result.=&Apache::edit::modifiedfield("/function",$parser); @@ -899,7 +930,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 =~ /^\@/) { @@ -942,10 +973,8 @@ 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); - $result .= &Apache::edit::end_row(). - &Apache::edit::start_spanning_row(). - &Apache::edit::editline('',$text,'',60); + my $text = &Apache::lonxml::get_all_text("/data",$parser,$style); + $result .= &Apache::edit::editline('',$text,'',60); } elsif ($target eq 'modified') { $result.=&Apache::edit::rebuild_tag($token); $result.=&Apache::edit::modifiedfield("/data",$parser); @@ -1082,14 +1111,35 @@ sub write_gnuplot_file { } elsif ($target eq 'tex') { $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"; + &unescape($filename).".eps\"\n"; } - # cartesian or polar? + # cartesian or polar plot? if (lc($Apache::lonplot::plot{'plottype'}) eq 'polar') { $gnuplot_input .= 'set polar'.$/; } else { # Assume Cartesian } + # cartesian or polar grid? + if (lc($Apache::lonplot::plot{'gridtype'}) eq 'polar') { + $gnuplot_input .= 'set grid polar'.$/; + } elsif (lc($Apache::lonplot::plot{'gridtype'}) eq 'linear-log') { + $gnuplot_input .= 'set logscale x'.$/; + } elsif (lc($Apache::lonplot::plot{'gridtype'}) eq 'log-linear') { + $gnuplot_input .= 'set logscale y'.$/; + } elsif (lc($Apache::lonplot::plot{'gridtype'}) eq 'log-log') { + $gnuplot_input .= 'set logscale x'.$/; + $gnuplot_input .= 'set logscale y'.$/; + } 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($Apache::lonplot::plot{'lmargin'}) ne 'default') { $gnuplot_input .= 'set lmargin '.$Apache::lonplot::plot{'lmargin'}.$/; @@ -1106,6 +1156,14 @@ sub write_gnuplot_file { # tic scales $gnuplot_input .= 'set 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 ($Apache::lonplot::plot{'grid'} eq 'on'); # border @@ -1180,12 +1238,16 @@ sub write_gnuplot_file { for (my $i = 0;$i<=$#curves;$i++) { $curve = $curves[$i]; $gnuplot_input.= ', ' if ($i > 0); + if ($target eq 'tex') { + $curve->{'linewidth'} *= 2; + } if (exists($curve->{'function'})) { $gnuplot_input.= $curve->{'function'}.' title "'. $curve->{'name'}.'" with '. $curve->{'linestyle'}; - $gnuplot_input.= ' linewidth 4 ' if ($target eq 'tex'); + $gnuplot_input.= ' linewidth '.$curve->{'linewidth'}; + if (($curve->{'linestyle'} eq 'points') || ($curve->{'linestyle'} eq 'linespoints') || ($curve->{'linestyle'} eq 'errorbars') || @@ -1194,6 +1256,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 @@ -1218,7 +1282,7 @@ sub write_gnuplot_file { $gnuplot_input.= '"'.$datafilename.'" title "'. $curve->{'name'}.'" with '. $curve->{'linestyle'}; - $gnuplot_input.= ' linewidth 4 ' if ($target eq 'tex'); + $gnuplot_input.= ' linewidth '.$curve->{'linewidth'}; if (($curve->{'linestyle'} eq 'points') || ($curve->{'linestyle'} eq 'linespoints') || ($curve->{'linestyle'} eq 'errorbars') || @@ -1227,6 +1291,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'}; } } }