--- loncom/xml/lonplot.pm 2002/01/21 16:41:31 1.42
+++ loncom/xml/lonplot.pm 2002/02/06 10:24:55 1.48
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Dynamic plot
#
-# $Id: lonplot.pm,v 1.42 2002/01/21 16:41:31 matthew Exp $
+# $Id: lonplot.pm,v 1.48 2002/02/06 10:24:55 matthew Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -29,7 +29,7 @@
# 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 Matthew
+# 01/21 02/05 Matthew
package Apache::lonplot;
@@ -40,7 +40,7 @@ use Apache::lonxml;
use Apache::edit;
BEGIN {
- &Apache::lonxml::register('Apache::lonplot',('plot'));
+ &Apache::lonxml::register('Apache::lonplot',('gnuplot'));
}
##
@@ -113,9 +113,40 @@ my $words_test = sub {$_[0]=~s/\s+/
## Attribute metadata ##
## ##
###################################################################
-my @plot_edit_order =
+my @gnuplot_edit_order =
qw/bgcolor fgcolor height width font transparent grid border align/;
-my %plot_defaults =
+
+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,
@@ -149,19 +180,19 @@ my %plot_defaults =
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',
@@ -192,7 +223,7 @@ my %key_defaults =
default => 'off',
test => $onoff_test,
description => 'Draw a box around the key?',
- edit_type => 'on_off'
+ edit_type => 'onoff'
},
pos => {
default => 'top right',
@@ -229,6 +260,45 @@ 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 => {
@@ -268,6 +338,37 @@ my %axis_defaults =
}
);
+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.
+