--- loncom/xml/lonplot.pm 2012/07/17 09:54:48 1.161
+++ loncom/xml/lonplot.pm 2018/09/26 15:24:46 1.180
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Dynamic plot
#
-# $Id: lonplot.pm,v 1.161 2012/07/17 09:54:48 foxr Exp $
+# $Id: lonplot.pm,v 1.180 2018/09/26 15:24:46 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -78,7 +78,7 @@ BEGIN {
## align
##
## @labels: $labels[$i] = \%label
-## %label: text, xpos, ypos, justify
+## %label: text, xpos, ypos, justify, rotate, zlayer
##
## @curves: $curves[$i] = \%curve
## %curve: name, linestyle, ( function | data )
@@ -105,7 +105,7 @@ my %linetypes = # For png use these li
);
my %ps_linetypes = # For ps the line types are different!
(
- solid => 0,
+ solid => 1,
dashed => 7
);
@@ -132,7 +132,12 @@ my $real_test =
sub {$_[0]=~s/\s+//g;$_[0]=~/^[+-]?\d*\.?\d*([eE][+-]\d+)?$/};
my $pos_real_test =
sub {$_[0]=~s/\s+//g;$_[0]=~/^[+]?\d*\.?\d*([eE][+-]\d+)?$/};
-my $color_test = sub {$_[0]=~s/\s+//g;$_[0]=~/^x[\da-fA-F]{6}$/};
+my $color_test;
+if ($version < 4.6) {
+ $color_test = sub {$_[0]=~s/\s+//g;$_[0]=~s/^\#/x/;$_[0]=~/^x[\da-fA-F]{6}$/};
+} else {
+ $color_test = sub {$_[0]=~s/\s+//g;$_[0]=~s/^x/#/;$_[0]=~/^\#[\da-fA-F]{6}$/};
+}
my $onoff_test = sub {$_[0]=~/^(on|off)$/};
my $key_pos_test = sub {$_[0]=~/^(top|bottom|right|left|outside|below| )+$/};
my $sml_test = sub {$_[0]=~/^(\d+|small|medium|large)$/};
@@ -253,7 +258,7 @@ my %gnuplot_defaults =
test => sub {$_[0]=~/^(left|right|middle|center)$/},
description => 'Alignment for image in HTML',
edit_type => 'choice',
- choices => ['left','right','middle']
+ choices => ['left','right','middle','center']
},
texwidth => {
default => '93',
@@ -416,7 +421,14 @@ my %label_defaults =
description => 'Rotation of label (degrees)',
edit_type => 'entry',
size => '10',
- }
+ },
+ zlayer => {
+ default => '',
+ test => sub {$_[0]=~/^(front|back)$/},
+ description => 'Z position of label',
+ edit_type => 'choice',
+ choices => ['front','back'],
+ },
);
my @tic_edit_order = ('location','mirror','start','increment','end',
@@ -463,7 +475,13 @@ my %tic_defaults =
description => 'Number of minor tics per major tic mark',
edit_type => 'entry',
size => '10'
- },
+ },
+ rotate => {
+ default => 'off',
+ test => $onoff_test,
+ description => 'Rotate tic label by 90 degrees if on',
+ edit_type => 'onoff'
+ }
);
my @axis_edit_order = ('color','xmin','xmax','ymin','ymax','xformat', 'yformat', 'xzero', 'yzero');
@@ -507,14 +525,14 @@ my %axis_defaults =
},
xformat => {
default => 'on',
- test => sub {$_[0]=~/^(on|off|\d+(f|F|e|E))$/},
+ test => sub {$_[0]=~/^(on|off|\d+(f|F|e|E|P(|\s*\Q\0317\0200\E)))$/},
description => 'X-axis number formatting',
edit_type => 'choice',
choices => ['on', 'off', '2e', '2f'],
},
yformat => {
default => 'on',
- test => sub {$_[0]=~/^(on|off|\d+(f|F|e|E))$/},
+ test => sub {$_[0]=~/^(on|off|\d+(f|F|e|E|P(|\s*\Q\0317\0200\E)))$/},
description => 'Y-axis number formatting',
edit_type => 'choice',
choices => ['on', 'off', '2e', '2f'],
@@ -537,6 +555,7 @@ my %axis_defaults =
},
);
+
my @curve_edit_order = ('color','name','linestyle','linewidth','linetype',
'pointtype','pointsize','limit', 'arrowhead', 'arrowstyle',
'arrowlength', 'arrowangle', 'arrowbackangle'
@@ -649,6 +668,8 @@ my %curve_defaults =
undef %Apache::lonplot::plot;
my (%key,%axis,$title,$xlabel,$ylabel,@labels,@curves,%xtics,%ytics);
+my $current_tics; # Reference to the current tick hash
+
sub start_gnuplot {
undef(%Apache::lonplot::plot); undef(%key); undef(%axis);
undef($title); undef($xlabel); undef($ylabel);
@@ -718,13 +739,19 @@ sub end_gnuplot {
$filename = &escape($filename);
## return image tag for the plot
if ($target eq 'web') {
- $result .= <<"ENDIMAGE";
-<img src = "/cgi-bin/plot.$weboutputformat?file=$filename.data"
- width = "$Apache::lonplot::plot{'width'}"
- height = "$Apache::lonplot::plot{'height'}"
- align = "$Apache::lonplot::plot{'align'}"
- alt = "$Apache::lonplot::plot{'alttag'}" />
-ENDIMAGE
+ my $srcatt = "src=\"/cgi-bin/plot.$weboutputformat?file=$filename.data\"";
+ my $widthatt = "width=\"$Apache::lonplot::plot{'width'}\"";
+ my $heightatt = "height=\"$Apache::lonplot::plot{'height'}\"";
+ my $alignatt = "align=\"$Apache::lonplot::plot{'align'}\"";
+ my $altatt = "alt=\"$Apache::lonplot::plot{'alttag'}\"";
+ if ($Apache::lonplot::plot{'align'} eq 'center') {
+ $result .= '<div style="text-align:center">'.
+ "<img $srcatt $widthatt $heightatt $altatt>".
+ "</div>\n";
+
+ } else {
+ $result .= "<img $srcatt $widthatt $heightatt $alignatt $altatt>";
+ }
} elsif ($target eq 'tex') {
&Apache::lonxml::debug(" gnuplot wid = $Apache::lonplot::plot{'width'}");
&Apache::lonxml::debug(" gnuplot ht = $Apache::lonplot::plot{'height'}");
@@ -732,7 +759,13 @@ ENDIMAGE
&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{{'.$tmpdir.'}}'."\n";
+ if ($Apache::lonplot::plot{'align'} eq 'center') {
+ $result .= '\begin{center}';
+ }
$result .= '\includegraphics[width='.$Apache::lonplot::plot{'texwidth'}.' mm]{'.&unescape($filename).'.eps}';
+ if ($Apache::lonplot::plot{'align'} eq 'center') {
+ $result .= '\end{center}';
+ }
}
} elsif ($target eq 'edit') {
$result.=&Apache::edit::tag_end($target,$token);
@@ -748,6 +781,8 @@ sub start_xtics {
if ($target eq 'web' || $target eq 'tex') {
&get_attributes(\%xtics,\%tic_defaults,$parstack,$safeeval,
$tagstack->[-1]);
+ $current_tics = \%xtics;
+ &Apache::lonxml::register('Apache::lonplot', 'tic');
} elsif ($target eq 'edit') {
$result .= &Apache::edit::tag_start($target,$token,'xtics');
$result .= &edit_attributes($target,$token,\%tic_defaults,
@@ -766,6 +801,7 @@ sub end_xtics {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
my $result = '';
if ($target eq 'web' || $target eq 'tex') {
+ &Apache::lonxml::deregister('Apache::lonplot', 'tic');
} elsif ($target eq 'edit') {
$result.=&Apache::edit::tag_end($target,$token);
}
@@ -779,6 +815,8 @@ sub start_ytics {
if ($target eq 'web' || $target eq 'tex') {
&get_attributes(\%ytics,\%tic_defaults,$parstack,$safeeval,
$tagstack->[-1]);
+ $current_tics = \%ytics;
+ &Apache::lonxml::register('Apache::lonplot', 'tic');
} elsif ($target eq 'edit') {
$result .= &Apache::edit::tag_start($target,$token,'ytics');
$result .= &edit_attributes($target,$token,\%tic_defaults,
@@ -797,12 +835,55 @@ sub end_ytics {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
my $result = '';
if ($target eq 'web' || $target eq 'tex') {
+ &Apache::lonxml::deregister('Apache::lonplot', 'tic');
} elsif ($target eq 'edit') {
$result.=&Apache::edit::tag_end($target,$token);
}
return $result;
}
+
+##----------------------------------------------------------------
+#
+# Tic handling:
+# The <tic> tag allows users to specify exact Tic positions and labels
+# for each axis. In this version we only support level 0 tics (major tic).
+# Each tic has associated with it a position and a label
+# $current_tics is a reference to the current tick description hash.
+# We add elements to an array in that has: ticspecs whose elements
+# are 'pos' - the tick position and 'label' - the tic label.
+#
+
+
+sub start_tic {
+ my ($target, $token, $tagstack, $parstack, $parser, $safeeval, $style) = @_;
+
+ my $result = '';
+ if ($target eq 'web' || $target eq 'tex') {
+ my $tic_location = &Apache::lonxml::get_param('location', $parstack, $safeeval);
+ my $tic_label = &Apache::lonxml::get_all_text('/tic', $parser);
+
+ # Tic location must e a real:
+
+ if (!&$real_test($tic_location)) {
+ &Apache::lonxml::warning("Tic location: $tic_location must be a real number");
+ } else {
+
+ if (!defined $current_tics->{'ticspecs'}) {
+ $current_tics->{'ticspecs'} = [];
+ }
+ my $ticspecs = $current_tics->{'ticspecs'};
+ push (@$ticspecs, {'pos' => $tic_location, 'label' => $tic_label});
+ }
+ }
+
+ return $result;
+}
+
+sub end_tic {
+ return '';
+}
+
##-----------------------------------------------------------------font
my %font_properties =
(
@@ -1457,6 +1538,8 @@ sub start_function {
$style);
$function = &Apache::run::evaluate($function,$safeeval,$$parstack[-1]);
$function=~s/\^/\*\*/gs;
+ $function=~ s/^\s+//; # Trim leading
+ $function=~ s/\s+$//; # And trailing whitespace.
$curves[-1]->{'function'} = $function;
} elsif ($target eq 'edit') {
$result .= &Apache::edit::tag_start($target,$token,'Gnuplot compatible curve function');
@@ -1636,6 +1719,65 @@ sub get_attributes{
}
return ;
}
+##
+# Generate tic mark specifications.
+#
+# @param type - type of tics (xtics or ytics).
+# @param spec - Reference to a hash that contains the tic specification.
+# @param target - 'tex' if hard copy target.
+#
+# @return string - the tic specification command.
+#
+sub generate_tics {
+ my ($type, $spec, $target) = @_;
+ my $result = '';
+
+
+ if ((ref($spec) eq 'HASH') && (keys(%{$spec}) > 0)) {
+
+
+
+ # Major tics: - If there are 'ticspecs' these override any other
+ # specifications:
+
+
+
+ $result .= "set $type $spec->{'location'} ";
+ $result .= ($spec->{'mirror'} eq 'on') ? 'mirror ' : 'nomirror ';
+ if ($spec->{'rotate'} eq 'on') {
+ $result .= ' rotate ';
+ }
+ if (defined $spec->{'ticspecs'}) {
+ $result .= '( ';
+ my @ticspecs;
+ my $ticinfo = $spec->{'ticspecs'};
+ foreach my $tic (@$ticinfo) {
+ push(@ticspecs, '"' . $tic->{'label'} . '" ' . $tic->{'pos'} );
+ }
+ $result .= join(', ', (@ticspecs));
+ $result .= ' )';
+ } else {
+ $result .= "$spec->{'start'}, ";
+ $result .= "$spec->{'increment'}, ";
+ $result .= "$spec->{'end'} ";
+ }
+ if ($target eq 'tex' ) {
+ $result .= 'font "Helvetica,22"';
+ }
+ $result .= "\n";
+
+ # minor frequency:
+
+ if ($spec->{'minorfreq'} != 0) {
+ $result .= "set m$type $spec->{'minorfreq'}\n";
+ }
+ } elsif ($target eq 'tex' ) {
+ $result .= "set $type font " . '"Helvetica,22"' ."\n";
+ }
+
+
+ return $result;
+}
##------------------------------------------------------- write_gnuplot_file
sub write_gnuplot_file {
@@ -1765,8 +1907,8 @@ sub write_gnuplot_file {
$gnuplot_input .= "set samples $Apache::lonplot::plot{'samples'}\n";
# title, xlabel, ylabel
# titles
- my $extra_space_x = ($xtics{'location'} eq 'axis') ? ' 0, -0.5 ' : '';
- my $extra_space_y = ($ytics{'location'} eq 'axis') ? ' -0.5, 0 ' : '';
+ my $extra_space_x = ($xtics{'location'} eq 'axis') ? ' offset 0, -0.5 ' : '';
+ my $extra_space_y = ($ytics{'location'} eq 'axis') ? ' offset -0.5, 0 ' : '';
if ($target eq 'tex') {
$gnuplot_input .= "set title \"$title\" font \"".$font_properties->{'printname'}.",".$fontsize."pt\"\n" if (defined($title)) ;
@@ -1778,42 +1920,10 @@ sub write_gnuplot_file {
$gnuplot_input .= "set ylabel \"$ylabel\" $extra_space_y \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'} ";
- 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'} ";
- 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.
- }
- }
+ $gnuplot_input .= &generate_tics('xtics', \%xtics, $target);
+
+ $gnuplot_input .= &generate_tics('ytics', \%ytics, $target);
+
# axis
if (%axis) {
if ($axis{'xformat'} ne 'on') {
@@ -1876,7 +1986,10 @@ sub write_gnuplot_file {
$gnuplot_input .= ' '.$label->{'justify'};
if ($target eq 'tex') {
- $gnuplot_input .=' font "'.$font_properties->{'printname'}.','.$fontsize.'pt"' ;
+ $gnuplot_input .=' font "'.$font_properties->{'printname'}.','.$fontsize.'pt"';
+ }
+ if (($label->{'zlayer'} eq 'front') || ($label->{'zlayer'} eq 'back')) {
+ $gnuplot_input .= ' '.$label->{'zlayer'};
}
$gnuplot_input .= $/;
}
@@ -1893,24 +2006,26 @@ sub write_gnuplot_file {
#
my $linestyle_index = 50;
my $line_width = '';
+ my $plots = '';
# If arrows are needed there will be an arrow style for each as well:
#
my $arrow_style_index = 50;
- my $plot_command;
- my $plot_type;
-
for (my $i = 0;$i<=$#curves;$i++) {
$curve = $curves[$i];
- $plot_command.= ', ' if ($i > 0);
+ my $plot_command = '';
+ my $plot_type = '';
+ if ($i > 0) {
+ $plot_type = ', ';
+ }
if ($target eq 'tex') {
$curve->{'linewidth'} *= 2;
}
$line_width = $curve->{'linewidth'};
if (exists($curve->{'function'})) {
- $plot_type =
+ $plot_type .=
$curve->{'function'}.' title "'.
$curve->{'name'}.'" with '.
$curve->{'linestyle'};
@@ -1934,7 +2049,7 @@ sub write_gnuplot_file {
print $fh $datatext;
close($fh);
# generate gnuplot text
- $plot_type = '"'.$datafilename.'" title "'.
+ $plot_type .= '"'.$datafilename.'" title "'.
$curve->{'name'}.'" with '.
$curve->{'linestyle'};
}
@@ -1956,10 +2071,6 @@ sub write_gnuplot_file {
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;
-
-
if (($curve->{'linestyle'} eq 'points') ||
($curve->{'linestyle'} eq 'linespoints') ||
@@ -1990,8 +2101,8 @@ sub write_gnuplot_file {
$arrow_style_index++;
}
-
-
+ my $style_command = "set style line $linestyle_index $pointtype $pointsize linetype $lt linewidth $line_width lc rgb '$color'\n";
+ $gnuplot_input .= $style_command;
# The condition below is because gnuplot lumps the linestyle in with the
# arrowstyle _sigh_.
@@ -2000,10 +2111,13 @@ sub write_gnuplot_file {
$plot_command.= " ls $linestyle_index";
}
- $gnuplot_input .= 'plot ' . $plot_type . ' ' . $plot_command . "\n";
+ $plots .= $plot_type . ' ' . $plot_command;
$linestyle_index++; # Each curve get a unique linestyle.
}
+ $gnuplot_input .= 'plot '.$plots;
# Write the output to a file.
+
+ # &Apache::lonnet::logthis($gnuplot_input); # uncomment to log the gnuplot input.
open (my $fh, "> $tmpdir$filename.data");
binmode($fh, ':utf8');
print $fh $gnuplot_input;