--- loncom/xml/lonplot.pm 2002/02/28 21:04:10 1.53
+++ loncom/xml/lonplot.pm 2008/05/13 11:01:43 1.138
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Dynamic plot
#
-# $Id: lonplot.pm,v 1.53 2002/02/28 21:04:10 matthew Exp $
+# $Id: lonplot.pm,v 1.138 2008/05/13 11:01:43 foxr Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -25,24 +25,38 @@
#
# 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 12/31 Matthew
-# 01/01/02 Matthew
-# 01/02 01/03 01/04 01/07 01/08 01/09 Matthew
-# 01/21 02/05 02/06 2/28Matthew
package Apache::lonplot;
use strict;
+use warnings FATAL=>'all';
+no warnings 'uninitialized';
use Apache::File;
use Apache::response;
use Apache::lonxml;
use Apache::edit;
+use Apache::lonnet;
+use LONCAPA;
+
+
+use vars qw/$weboutputformat $version/;
+
+
BEGIN {
- &Apache::lonxml::register('Apache::lonplot',('gnuplot'));
+ &Apache::lonxml::register('Apache::lonplot',('gnuplot'));
+ #
+ # Determine the version of GNUPLOT
+ $weboutputformat = 'gif';
+ my $versionstring = `gnuplot --version 2>/dev/null`;
+ ($version) = ($versionstring =~ /^gnuplot ([\d.]+)/);
+ if ($version >= 4) {
+ $weboutputformat = 'png';
+ }
+
}
+
##
## Description of data structures:
##
@@ -77,6 +91,12 @@ BEGIN {
my $max_str_len = 50; # if a label, title, xlabel, or ylabel text
# is longer than this, it will be truncated.
+my %linetypes =
+ (
+ solid => 1,
+ dashed => 0
+ );
+
my %linestyles =
(
lines => 2, # Maybe this will be used in the future
@@ -91,22 +111,21 @@ my %linestyles =
yerrorbars => [3,4],
xyerrorbars => [4,6],
boxes => 3,
-# boxerrorbars => [3,4,5],
-# boxxyerrorbars => [4,6,7],
-# financebars => 5,
-# candlesticks => 5,
+ filledcurves => 2,
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+)?$/};
-my $color_test = sub {$_[0]=~s/\s+//g;$_[0]=~/^x[\da-f]{6}$/};
+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 $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 $sml_test = sub {$_[0]=~/^(\d+|small|medium|large)$/};
my $linestyle_test = sub {exists($linestyles{$_[0]})};
-my $words_test = sub {$_[0]=~s/\s+/ /g;$_[0]=~/^([\w\(\)]+ ?)+$/};
+my $words_test = sub {$_[0]=~s/\s+/ /g;$_[0]=~/^([\w~!\@\#\$\%^&\*\(\)-=_\+\[\]\{\}:\;\'<>,\.\/\?\\]+ ?)+$/};
###################################################################
## ##
@@ -114,65 +133,48 @@ my $words_test = sub {$_[0]=~s/\s+/
## ##
###################################################################
my @gnuplot_edit_order =
- qw/bgcolor fgcolor height width font transparent grid border align/;
+ qw/alttag bgcolor fgcolor height width texwidth fontface font texfont
+ transparent grid samples
+ border align plotcolor plottype gridtype lmargin rmargin
+ tmargin bmargin major_ticscale minor_ticscale boxwidth gridlayer fillstyle
+ pattern solid/;
-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 $margin_choices = ['default',0..20];
my %gnuplot_defaults =
(
+ alttag => {
+ default => 'dynamically generated plot',
+ test => $words_test,
+ description => 'Brief description of the plot',
+ edit_type => 'entry',
+ size => '40'
+ },
height => {
- default => 200,
+ default => 300,
test => $int_test,
- description => 'height of image (pixels)',
+ description => 'Height of image (pixels)',
edit_type => 'entry',
size => '10'
},
width => {
- default => 200,
+ default => 400,
test => $int_test,
- description => 'width of image (pixels)',
+ description => 'Width of image (pixels)',
edit_type => 'entry',
size => '10'
},
bgcolor => {
default => 'xffffff',
test => $color_test,
- description => 'background color of image (xffffff)',
+ description => 'Background color of image (xffffff)',
edit_type => 'entry',
size => '10'
},
fgcolor => {
default => 'x000000',
test => $color_test,
- description => 'foreground color of image (x000000)',
+ description => 'Foreground color of image (x000000)',
edit_type => 'entry',
size => '10'
},
@@ -183,11 +185,24 @@ my %gnuplot_defaults =
edit_type => 'onoff'
},
grid => {
- default => 'off',
+ default => 'on',
test => $onoff_test,
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,
@@ -195,19 +210,138 @@ my %gnuplot_defaults =
edit_type => 'onoff'
},
font => {
- default => 'medium',
+ default => '9',
test => $sml_test,
- description => 'Size of font to use',
+ description => 'Font size to use in web output (pts)',
edit_type => 'choice',
- choices => ['small','medium','large']
+ choices => [['5','5 (small)'],'6','7','8',['9','9 (medium)'],'10',['11','11 (large)'],'12','15']
+ },
+ fontface => {
+ default => 'sans-serif',
+ test => sub {$_[0]=~/^(sans-serif|serif|classic)$/},
+ description => 'Type of font to use',
+ edit_type => 'choice',
+ choices => ['sans-serif','serif', 'classic']
+ },
+ samples => {
+ default => '100',
+ test => $int_test,
+ description => 'Number of samples for non-data plots',
+ edit_type => 'choice',
+ choices => ['100','200','500','1000','2000','5000']
},
align => {
- default => 'left',
- test => sub {$_[0]=~/^(left|right|center)$/},
- description => 'alignment for image in html',
+ 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',
+ test => $int_test,
+ description => 'Width of plot when printed (mm)',
+ edit_type => 'entry',
+ size => '5'
+ },
+ 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 => {
+ 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']
+ },
+ 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 => {
+ default => 'default',
+ test => sub {$_[0]=~/^(default|\d+)$/},
+ description => 'Right margin width (pts):',
+ edit_type => 'choice',
+ choices => $margin_choices,
+ },
+ tmargin => {
+ default => 'default',
+ test => sub {$_[0]=~/^(default|\d+)$/},
+ description => 'Top margin width (pts):',
+ edit_type => 'choice',
+ choices => $margin_choices,
+ },
+ 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 is auto',
+ edit_type => 'entry',
+ size => '5'
+ },
+ major_ticscale => {
+ default => '1',
+ test => $real_test,
+ description => 'Size of major tic marks (plot coordinates)',
+ edit_type => 'entry',
+ size => '5'
+ },
+ minor_ticscale => {
+ default => '0.5',
+ test => $real_test,
+ description => 'Size of minor tic mark (plot coordinates)',
+ edit_type => 'entry',
+ size => '5'
+ },
);
my %key_defaults =
@@ -228,7 +362,7 @@ my %key_defaults =
pos => {
default => 'top right',
test => $key_pos_test,
- description => 'position of the key on the plot',
+ description => 'Position of the key on the plot',
edit_type => 'choice',
choices => ['top left','top right','bottom left','bottom right',
'outside','below']
@@ -240,14 +374,14 @@ my %label_defaults =
xpos => {
default => 0,
test => $real_test,
- description => 'x position of label (graph coordinates)',
+ description => 'X position of label (graph coordinates)',
edit_type => 'entry',
size => '10'
},
ypos => {
default => 0,
test => $real_test,
- description => 'y position of label (graph coordinates)',
+ description => 'Y position of label (graph coordinates)',
edit_type => 'entry',
size => '10'
},
@@ -257,141 +391,178 @@ my %label_defaults =
description => 'justification of the label text on the plot',
edit_type => 'choice',
choices => ['left','right','center']
+ },
+ rotate => {
+ default => 0,
+ test => $real_test,
+ description => 'Rotation of label (degrees)',
+ edit_type => 'entry',
+ size => '10',
}
);
-my @tic_edit_order = ('location','mirror','start','increment','end');
+my @tic_edit_order = ('location','mirror','start','increment','end',
+ 'minorfreq');
my %tic_defaults =
(
location => {
default => 'border',
test => sub {$_[0]=~/^(border|axis)$/},
- description => 'Location of tick marks',
+ description => 'Location of major tic marks',
edit_type => 'choice',
choices => ['border','axis']
},
mirror => {
default => 'on',
test => $onoff_test,
- description => 'mirror ticks on opposite axis?',
+ description => 'Mirror tics on opposite axis?',
edit_type => 'onoff'
},
start => {
default => '-10.0',
test => $real_test,
- description => 'Start ticks at',
+ description => 'Start major tics at',
edit_type => 'entry',
size => '10'
},
increment => {
default => '1.0',
test => $real_test,
- description => 'Place a tick every',
+ description => 'Place a major tic every',
edit_type => 'entry',
size => '10'
},
end => {
default => ' 10.0',
test => $real_test,
- description => 'Stop ticks at ',
+ description => 'Stop major tics at ',
edit_type => 'entry',
size => '10'
},
+ minorfreq => {
+ default => '0',
+ test => $int_test,
+ description => 'Number of minor tics per major tic mark',
+ edit_type => 'entry',
+ size => '10'
+ },
);
+my @axis_edit_order = ('color','xmin','xmax','ymin','ymax','xformat', 'yformat');
my %axis_defaults =
(
color => {
default => 'x000000',
test => $color_test,
- description => 'color of axes (x000000)',
+ description => 'Color of grid lines (x000000)',
edit_type => 'entry',
size => '10'
},
xmin => {
default => '-10.0',
test => $real_test,
- description => 'minimum x-value shown in plot',
+ description => 'Minimum x-value shown in plot',
edit_type => 'entry',
size => '10'
},
xmax => {
default => ' 10.0',
test => $real_test,
- description => 'maximum x-value shown in plot',
+ description => 'Maximum x-value shown in plot',
edit_type => 'entry',
size => '10'
},
ymin => {
default => '-10.0',
test => $real_test,
- description => 'minimum y-value shown in plot',
+ description => 'Minimum y-value shown in plot',
edit_type => 'entry',
size => '10'
},
ymax => {
default => ' 10.0',
test => $real_test,
- description => 'maximum y-value shown in plot',
+ description => 'Maximum y-value shown in plot',
edit_type => 'entry',
size => '10'
- }
+ },
+ xformat => {
+ default => 'on',
+ test => sub {$_[0]=~/^(on|off|\d+(f|F|e|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))$/},
+ description => 'X-axis number formatting',
+ edit_type => 'choice',
+ choices => ['on', 'off', '2e', '2f'],
+ },
+
);
-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.
-