Skip to content

StatisticalPlots macro #1374

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pstaabp wants to merge 5 commits into
base: develop
Choose a base branch
from
Open

StatisticalPlots macro #1374

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
84a9d72
The initial code for the beginning of the StatisticalPlots macro.
pstaabp Jan 29, 2026
97465b5
Add normalize functionality to add_histogram.
pstaabp Jan 31, 2026
16538fa
Adds some other functionality to StatisticalPlots.pl
pstaabp Feb 2, 2026
5fd4d24
Add pie chart.
pstaabp Feb 6, 2026
e3a3722
Adding custom tick labels and making sure it works in tikz as well.
pstaabp Feb 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 23 additions & 2 deletions htdocs/js/Plots/plots.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -375,9 +375,19 @@ const PGplots = {
options.xAxis.overrideOptions ?? {}
)
));
xAxis.defaultTicks.generateLabelText = plot.generateLabelText;

xAxis.defaultTicks.formatLabelText = plot.formatLabelText;

// If there are custom labels defined, create a function to generate them at the
// tick locations.
if (options.xAxis.ticks?.customLabels) {
xAxis.defaultTicks.generateLabelText = function (tick) {
return options.xAxis.ticks.customLabels[tick.usrCoords[1] / options.xAxis.ticks.distance - 1];
};
} else {
xAxis.defaultTicks.generateLabelText = plot.generateLabelText;
}

if (options.xAxis.location !== 'middle' && options.xAxis.name !== '') {
plot.xLabel = board.create(
'text',
Expand Down Expand Up @@ -474,8 +484,19 @@ const PGplots = {
options.yAxis.overrideOptions ?? {}
)
));
yAxis.defaultTicks.generateLabelText = plot.generateLabelText;

yAxis.defaultTicks.formatLabelText = plot.formatLabelText;
// If there are custom labels defined, create a function to generate them at the
// tick locations.
if (options.yAxis.ticks?.customLabels) {
console.log(options.yAxis);
yAxis.defaultTicks.generateLabelText = function (tick) {
console.log(tick);
return options.yAxis.ticks.customLabels[tick.usrCoords[2] / options.yAxis.ticks.distance - 1];
};
} else {
yAxis.defaultTicks.generateLabelText = plot.generateLabelText;
}

if (options.yAxis.location !== 'center' && options.yAxis.name !== '') {
plot.yLabel = board.create('text', [0, 0, options.yAxis.name ?? '\\(y\\)'], {
Expand Down
52 changes: 32 additions & 20 deletions lib/Plots/Axes.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ It is also possible to get multiple options for both axes using the get method,
a reference to a hash of requested keys, such as:

$bounds = $plot->axes->get('xmin', 'xmax', 'ymin', 'ymax');
# The following is equivlant to $plot->axes->grid
# The following is equivalent to $plot->axes->grid
$grid = $plot->axes->get('xmajor', 'xminor', 'xtick_delta', 'ymajor', 'yminor', 'ytick_delta');

It is also possible to get the bounds as an array in the order xmin, ymin, xmax, ymax
Expand Down Expand Up @@ -103,6 +103,17 @@ difference between the C<max> and C<min> divided by the C<tick_num>. Default: 0
This can be either 1 (show) or 0 (don't show) the labels for the major ticks.
Default: 1

=item tick_custom_labels

If defined, this replaces the automatically generated labels for the ticks.
This should be an array reference with the number of labels equal to the
expected number of ticks. If this is defined then the C<tick_label_format> is
ignored.

Example:

xtick_custom_labels => ['A', 'B', 'C', 'D']

=item tick_label_format

This can be one of "decimal", "fraction", "multiple", or "scinot". If this is
Expand Down Expand Up @@ -304,25 +315,26 @@ sub new {
sub axis_defaults {
my ($self, $axis) = @_;
return (
visible => 1,
min => -5,
max => 5,
label => $axis eq 'y' ? '\(y\)' : '\(x\)',
location => $axis eq 'y' ? 'center' : 'middle',
position => 0,
tick_labels => 1,
tick_label_format => 'decimal',
tick_label_digits => 2,
tick_distance => 0,
tick_scale => 1,
tick_scale_symbol => '',
show_ticks => 1,
tick_delta => 0,
tick_num => 5,
major => 1,
minor => 3,
minor_grids => 1,
arrows_both => 0,
visible => 1,
min => -5,
max => 5,
label => $axis eq 'y' ? '\(y\)' : '\(x\)',
location => $axis eq 'y' ? 'center' : 'middle',
position => 0,
tick_labels => 1,
tick_label_format => 'decimal',
tick_label_digits => 2,
tick_custom_labels => undef,
tick_distance => 0,
tick_scale => 1,
tick_scale_symbol => '',
show_ticks => 1,
tick_delta => 0,
tick_num => 5,
major => 1,
minor => 3,
minor_grids => 1,
arrows_both => 0,
);
}

Expand Down
4 changes: 2 additions & 2 deletions lib/Plots/Data.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ stored in the C<< $data->{function} >> hash, though other data is stored as a st
);

Note, the first argument must be $self->context when called from C<Plots::Plot>
to use a single context for all C<Plost::Data> objects.
to use a single context for all C<Plots::Data> objects.

This is also used to set a two variable function (used for slope or vector fields):

Expand Down Expand Up @@ -116,7 +116,7 @@ Takes a MathObject C<$formula> and replaces the function with either
a JavaScript or PGF function string. If the function contains any function
tokens not supported, a warning and empty string is returned.

$formula The mathobject formula object, either $self->{function}{Fx} or $self->{function}{Fy}.
$formula The MathObject formula object, either $self->{function}{Fx} or $self->{function}{Fy}.
$type 'js' or 'PGF' (falls back to js for any input except 'PGF').
$xvar The x-variable name, $self->{function}{xvar}.
$yvar The y-variable name, $self->{function}{yvar}, for vector fields.
Expand Down
28 changes: 18 additions & 10 deletions lib/Plots/JSXGraph.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,21 +122,29 @@ sub HTML {
$options->{mathJaxTickLabels} = $axes->style('mathjax_tick_labels') if $xvisible || $yvisible;

if ($xvisible) {
$options->{xAxis}{name} = $axes->xaxis('label');
$options->{xAxis}{ticks}{show} = $axes->xaxis('show_ticks');
$options->{xAxis}{ticks}{labels} = $axes->xaxis('tick_labels');
$options->{xAxis}{ticks}{labelFormat} = $axes->xaxis('tick_label_format');
$options->{xAxis}{ticks}{labelDigits} = $axes->xaxis('tick_label_digits');
$options->{xAxis}{name} = $axes->xaxis('label');
$options->{xAxis}{ticks}{show} = $axes->xaxis('show_ticks');
$options->{xAxis}{ticks}{labels} = $axes->xaxis('tick_labels');
if ($axes->xaxis('tick_custom_labels')) {
$options->{xAxis}{ticks}{customLabels} = $axes->xaxis('tick_custom_labels');
} else {
$options->{xAxis}{ticks}{labelFormat} = $axes->xaxis('tick_label_format');
$options->{xAxis}{ticks}{labelDigits} = $axes->xaxis('tick_label_digits');
}
$options->{xAxis}{ticks}{scaleSymbol} = $axes->xaxis('tick_scale_symbol');
$options->{xAxis}{arrowsBoth} = $axes->xaxis('arrows_both');
$options->{xAxis}{overrideOptions} = $axes->xaxis('jsx_options') if $axes->xaxis('jsx_options');
}
if ($yvisible) {
$options->{yAxis}{name} = $axes->yaxis('label');
$options->{yAxis}{ticks}{show} = $axes->yaxis('show_ticks');
$options->{yAxis}{ticks}{labels} = $axes->yaxis('tick_labels');
$options->{yAxis}{ticks}{labelFormat} = $axes->yaxis('tick_label_format');
$options->{yAxis}{ticks}{labelDigits} = $axes->yaxis('tick_label_digits');
$options->{yAxis}{name} = $axes->yaxis('label');
$options->{yAxis}{ticks}{show} = $axes->yaxis('show_ticks');
$options->{yAxis}{ticks}{labels} = $axes->yaxis('tick_labels');
if ($axes->yaxis('tick_custom_labels')) {
$options->{yAxis}{ticks}{customLabels} = $axes->yaxis('tick_custom_labels');
} else {
$options->{yAxis}{ticks}{labelFormat} = $axes->yaxis('tick_label_format');
$options->{yAxis}{ticks}{labelDigits} = $axes->yaxis('tick_label_digits');
}
$options->{yAxis}{ticks}{scaleSymbol} = $axes->yaxis('tick_scale_symbol');
$options->{yAxis}{arrowsBoth} = $axes->yaxis('arrows_both');
$options->{yAxis}{overrideOptions} = $axes->yaxis('jsx_options') if $axes->yaxis('jsx_options');
Expand Down
12 changes: 12 additions & 0 deletions lib/Plots/Plot.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -392,6 +392,18 @@ sub add_arc {
return $self->_add_arc(@data);
}

sub add_rectangle {
my ($self, $pt0, $pt2, %options) = @_;

Value::Error('The first point must be an array ref of length 2')
unless ref($pt0) eq 'ARRAY' && scalar(@$pt0) == 2;
Value::Error('The second point must be an array ref of length 2')
unless ref($pt2) eq 'ARRAY' && scalar(@$pt2) == 2;
# If the fill_color option is set, set the fill to 'self'.
$options{fill} = 'self' if $options{fill_color} && !defined($options{fill});
return $self->add_dataset($pt0, [ $pt2->[0], $pt0->[1] ], $pt2, [ $pt0->[0], $pt2->[1] ], $pt0, %options);
}

Comment on lines +395 to +406
Copy link
Member

@drgrice1 drgrice1 Mar 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is rather inconsistent with the rest of the Plot.pm code.

Most of the plots methods allow adding one or multiple of each object at a time. The add_rectangle method should do this as well.

No where in the plots code is the Value::Error method used to give messages about incorrect usage, and for good reason. Calling Value::Error dies and prevents the entire problem from rendering. That should really only be done in answer checkers where those exceptions are caught, and not for something like this where you really just want to notify the problem author of incorrect usage. A warn is certainly sufficient for that, and then the problem can still render. There is also no need for a separate message for the two points. Just give one.

In short change this to

Suggested change
sub add_rectangle {
my ($self, $pt0, $pt2, %options) = @_;
Value::Error('The first point must be an array ref of length 2')
unless ref($pt0) eq 'ARRAY' && scalar(@$pt0) == 2;
Value::Error('The second point must be an array ref of length 2')
unless ref($pt2) eq 'ARRAY' && scalar(@$pt2) == 2;
# If the fill_color option is set, set the fill to 'self'.
$options{fill} = 'self' if $options{fill_color} && !defined($options{fill});
return $self->add_dataset($pt0, [ $pt2->[0], $pt0->[1] ], $pt2, [ $pt0->[0], $pt2->[1] ], $pt0, %options);
}
sub _add_rectangle {
my ($self, $pt0, $pt2, %options) = @_;
unless (ref($pt0) eq 'ARRAY' && @$pt0 == 2 && ref($pt2) eq 'ARRAY' && @$pt2 == 2) {
warn 'A rectangle requires two points defined by length two array references.';
return;
}
$options{fill} = 'self' if $options{fill_color} && !defined $options{fill};
return $self->_add_dataset($pt0, [ $pt2->[0], $pt0->[1] ], $pt2, [ $pt0->[0], $pt2->[1] ], $pt0, %options);
}
sub add_rectangle {
my ($self, @data) = @_;
if (ref($data[0]) eq 'ARRAY' && ref($data[0][0]) eq 'ARRAY') {
return [ map { $self->_add_rectangle(@$_) } @data ];
}
return $self->_add_rectangle(@data);
}

sub add_vectorfield {
my ($self, @options) = @_;
my $data = Plots::Data->new(name => 'vectorfield');
Expand Down
37 changes: 31 additions & 6 deletions lib/Plots/Tikz.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,11 +213,19 @@ sub generate_axes {
my $x_tick_distance = $axes->xaxis('tick_distance');
my $x_tick_scale = $axes->xaxis('tick_scale') || 1;

# If there are custom labels and 0 is one of the ticks, an empty label needs to be added.
my @custom_xlabels;
@custom_xlabels = @{ $axes->xaxis('tick_custom_labels') } if $axes->xaxis('tick_custom_labels');

my @xticks =
grep { $_ > $xmin && $_ < $xmax }
map { -$_ * $x_tick_distance * $x_tick_scale }
reverse(1 .. -$xmin / ($x_tick_distance * $x_tick_scale));
push(@xticks, 0) if $xmin < 0 && $xmax > 0;
if ($xmin < 0 && $xmax > 0) {
push(@xticks, 0);
unshift(@custom_xlabels, '') if @custom_xlabels;
}

push(@xticks,
grep { $_ > $xmin && $_ < $xmax }
map { $_ * $x_tick_distance * $x_tick_scale } (1 .. $xmax / ($x_tick_distance * $x_tick_scale)));
Expand All @@ -226,8 +234,13 @@ sub generate_axes {
$xvisible
&& $axes->xaxis('show_ticks')
&& $axes->xaxis('tick_labels')
? (",\nxticklabel shift=9pt,\nxticklabel style={anchor=center},\nxticklabels={"
. join(',', map { $self->formatTickLabelText($_ / $x_tick_scale, 'xaxis') } @xticks) . '}')
? (
$axes->xaxis('tick_custom_labels')
? (",\nxticklabel shift=9pt,\nxticklabel style={anchor=center},\nxticklabels={"
. join(',', @custom_xlabels) . '}')
: (",\nxticklabel shift=9pt,\nxticklabel style={anchor=center},\nxticklabels={"
. join(',', map { $self->formatTickLabelText($_ / $x_tick_scale, 'xaxis') } @xticks) . '}')
)
: ",\nxticklabel=\\empty";

my @xminor_ticks;
Expand All @@ -250,7 +263,14 @@ sub generate_axes {
grep { $_ > $ymin && $_ < $ymax }
map { -$_ * $y_tick_distance * $y_tick_scale }
reverse(1 .. -$ymin / ($y_tick_distance * $y_tick_scale));
push(@yticks, 0) if $ymin < 0 && $ymax > 0;

# If there are custom labels and 0 is one of the ticks, an empty label needs to be added.
my @custom_ylabels;
@custom_ylabels = @{ $axes->yaxis('tick_custom_labels') } if $axes->yaxis('tick_custom_labels');
if ($ymin < 0 && $ymax > 0) {
push(@yticks, 0);
unshift(@custom_ylabels, '') if @custom_ylabels;
}
push(@yticks,
grep { $_ > $ymin && $_ < $ymax }
map { $_ * $y_tick_distance * $y_tick_scale } (1 .. $ymax / ($y_tick_distance * $y_tick_scale)));
Expand All @@ -259,8 +279,13 @@ sub generate_axes {
$yvisible
&& $axes->yaxis('show_ticks')
&& $axes->yaxis('tick_labels')
? (",\nyticklabel shift=-3pt,\nyticklabels={"
. join(',', map { $self->formatTickLabelText($_ / $y_tick_scale, 'yaxis') } @yticks) . '}')
? (
$axes->yaxis('tick_custom_labels')
? (",\nyticklabel shift=-3pt,\nyticklabel style={anchor=left},\nyticklabels={"
. join(',', @custom_ylabels) . '}')
: (",\nyticklabel shift=-3pt,\nyticklabels={"
. join(',', map { $self->formatTickLabelText($_ / $y_tick_scale, 'yaxis') } @yticks) . '}')
)
: ",\nyticklabel=\\empty";

my @yminor_ticks;
Expand Down
7 changes: 2 additions & 5 deletions macros/core/PGbasicmacros.pl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2923,7 +2923,7 @@ sub image {
);
next;
}
if (ref $image_item eq 'Plots::Plot') {
if (ref $image_item eq 'Plots::Plot' || ref $image_item eq 'Plots::StatPlot') {
Copy link
Contributor

@somiaj somiaj Jan 31, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be worthwhile to make this more general, for future extension macros. Maybe call your package Plots::Plot::StatPlot, and then have this only check if ref $image_item starts with Plots::Plot, that way this won't have to be updated each time someone wants to extend Plots?

Copy link
Contributor

@somiaj somiaj Jan 31, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also think there are some other places that might need to be updated, I recall having to modify a few places to check for the ref being equal to Plots::Plot beyond just this place (for some older image macros).

Copy link
Member

@drgrice1 drgrice1 Jan 31, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideally this would be an isa call. Then any object that derives from a Plots::Plot object would work here. Unfortunately, to properly do that you need the Scalar::Util::blessed method which is not available here. The correct way to check if an object, say $object, derives from a particular class is if (blessed($object) && $object->isa('Parent::Package')).

When I was creating the SimpleGraph.pl macro, I almost made that package derive from the Plots::Plot package, and then wanted to make this code that way, but ran into the issue with the lack of the blessed method availability. I ended up going a different direction with the SimpleGraph.pl macro though.

Copy link
Member

@drgrice1 drgrice1 Jan 31, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, line 2946 below needs to check the ref also.

Copy link
Member

@drgrice1 drgrice1 Jan 31, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DO NOT add this ref check to either macros/core/VectorField2D.pl or macros/graph/unionImage.pl. There are checks for the Plots::Plot object in those macros.

The VectorField2D.pl macro usage doesn't make sense for this statistical graph macro.

As to the unionImage.pl one, I told @somiaj not to add that there. It should be removed. No one should be using that macro anymore, and it should be moved into the deprecated folder.

# Update image attributes as needed.
$image_item->{width} = $width if $out_options{width};
$image_item->{height} = $height if $out_options{height};
Expand All @@ -2942,10 +2942,7 @@ sub image {
$width_ratio = 0.001 * $image_item->{tex_size};
}
$image_item = insertGraph($image_item)
if (ref $image_item eq 'WWPlot'
|| ref $image_item eq 'Plots::Plot'
|| ref $image_item eq 'PGlateximage'
|| ref $image_item eq 'PGtikz');
if (grep { ref $image_item eq $_ } ('WWPlot', 'Plots::Plot', 'Plots::StatPlot', 'PGlateximage', 'PGtikz'));
my $imageURL = alias($image_item) // '';
$imageURL = ($envir{use_site_prefix}) ? $envir{use_site_prefix} . $imageURL : $imageURL;
my $id = $main::PG->getUniqueName('img');
Expand Down
Loading