Chart-Plotly/lib/Chart/Plotly/Trace/Barpolar.pm
package Chart::Plotly::Trace::Barpolar;
use Moose;
use MooseX::ExtraArgs;
use Moose::Util::TypeConstraints qw(enum union);
if ( !defined Moose::Util::TypeConstraints::find_type_constraint('PDL') ) {
Moose::Util::TypeConstraints::type('PDL');
}
use Chart::Plotly::Trace::Barpolar::Hoverlabel;
use Chart::Plotly::Trace::Barpolar::Legendgrouptitle;
use Chart::Plotly::Trace::Barpolar::Marker;
use Chart::Plotly::Trace::Barpolar::Selected;
use Chart::Plotly::Trace::Barpolar::Stream;
use Chart::Plotly::Trace::Barpolar::Transform;
use Chart::Plotly::Trace::Barpolar::Unselected;
our $VERSION = '0.042'; # VERSION
# ABSTRACT: The data visualized by the radial span of the bars is set in `r`
sub TO_JSON {
my $self = shift;
my $extra_args = $self->extra_args // {};
my $meta = $self->meta;
my %hash = %$self;
for my $name ( sort keys %hash ) {
my $attr = $meta->get_attribute($name);
if ( defined $attr ) {
my $value = $hash{$name};
my $type = $attr->type_constraint;
if ( $type && $type->equals('Bool') ) {
$hash{$name} = $value ? \1 : \0;
}
}
}
my $plotly_meta = delete $hash{'pmeta'};
if ( defined $plotly_meta ) {
$hash{'meta'} = $plotly_meta;
}
%hash = ( %hash, %$extra_args );
delete $hash{'extra_args'};
if ( $self->can('type') && ( !defined $hash{'type'} ) ) {
$hash{type} = $self->type();
}
return \%hash;
}
sub type {
my @components = split( /::/, __PACKAGE__ );
return lc( $components[-1] );
}
has base => (
is => "rw",
isa => "Any|ArrayRef[Any]",
documentation =>
"Sets where the bar base is drawn (in radial axis units). In *stack* barmode, traces that set *base* will be excluded and drawn in *overlay* mode instead.",
);
has basesrc => ( is => "rw",
isa => "Str",
documentation => "Sets the source reference on Chart Studio Cloud for `base`.",
);
has customdata => (
is => "rw",
isa => "ArrayRef|PDL",
documentation =>
"Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
);
has customdatasrc => ( is => "rw",
isa => "Str",
documentation => "Sets the source reference on Chart Studio Cloud for `customdata`.",
);
has dr => ( is => "rw",
isa => "Num",
documentation => "Sets the r coordinate step.",
);
has dtheta => (
is => "rw",
isa => "Num",
documentation =>
"Sets the theta coordinate step. By default, the `dtheta` step equals the subplot's period divided by the length of the `r` coordinates.",
);
has hoverinfo => (
is => "rw",
isa => "Str|ArrayRef[Str]",
documentation =>
"Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
);
has hoverinfosrc => ( is => "rw",
isa => "Str",
documentation => "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
);
has hoverlabel => ( is => "rw",
isa => "Maybe[HashRef]|Chart::Plotly::Trace::Barpolar::Hoverlabel", );
has hovertemplate => (
is => "rw",
isa => "Str|ArrayRef[Str]",
documentation =>
"Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:\$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example \"<extra>{fullData.name}</extra>\". To hide the secondary box completely, use an empty tag `<extra></extra>`.",
);
has hovertemplatesrc => ( is => "rw",
isa => "Str",
documentation => "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
);
has hovertext => ( is => "rw",
isa => "Str|ArrayRef[Str]",
documentation => "Same as `text`.",
);
has hovertextsrc => ( is => "rw",
isa => "Str",
documentation => "Sets the source reference on Chart Studio Cloud for `hovertext`.",
);
has ids => (
is => "rw",
isa => "ArrayRef|PDL",
documentation =>
"Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
);
has idssrc => ( is => "rw",
isa => "Str",
documentation => "Sets the source reference on Chart Studio Cloud for `ids`.",
);
has legendgroup => (
is => "rw",
isa => "Str",
documentation =>
"Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.",
);
has legendgrouptitle => ( is => "rw",
isa => "Maybe[HashRef]|Chart::Plotly::Trace::Barpolar::Legendgrouptitle", );
has legendrank => (
is => "rw",
isa => "Num",
documentation =>
"Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with `*reversed* `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items.",
);
has marker => ( is => "rw",
isa => "Maybe[HashRef]|Chart::Plotly::Trace::Barpolar::Marker", );
has pmeta => (
is => "rw",
isa => "Any|ArrayRef[Any]",
documentation =>
"Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
);
has metasrc => ( is => "rw",
isa => "Str",
documentation => "Sets the source reference on Chart Studio Cloud for `meta`.",
);
has name => ( is => "rw",
isa => "Str",
documentation => "Sets the trace name. The trace name appear as the legend item and on hover.",
);
has offset => ( is => "rw",
isa => "Num|ArrayRef[Num]",
documentation => "Shifts the angular position where the bar is drawn (in *thetatunit* units).",
);
has offsetsrc => ( is => "rw",
isa => "Str",
documentation => "Sets the source reference on Chart Studio Cloud for `offset`.",
);
has opacity => ( is => "rw",
isa => "Num",
documentation => "Sets the opacity of the trace.",
);
has r => ( is => "rw",
isa => "ArrayRef|PDL",
documentation => "Sets the radial coordinates",
);
has r0 => (
is => "rw",
isa => "Any",
documentation =>
"Alternate to `r`. Builds a linear space of r coordinates. Use with `dr` where `r0` is the starting coordinate and `dr` the step.",
);
has rsrc => ( is => "rw",
isa => "Str",
documentation => "Sets the source reference on Chart Studio Cloud for `r`.",
);
has selected => ( is => "rw",
isa => "Maybe[HashRef]|Chart::Plotly::Trace::Barpolar::Selected", );
has selectedpoints => (
is => "rw",
isa => "Any",
documentation =>
"Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.",
);
has showlegend => (
is => "rw",
isa => "Bool",
documentation => "Determines whether or not an item corresponding to this trace is shown in the legend.",
);
has stream => ( is => "rw",
isa => "Maybe[HashRef]|Chart::Plotly::Trace::Barpolar::Stream", );
has subplot => (
is => "rw",
documentation =>
"Sets a reference between this trace's data coordinates and a polar subplot. If *polar* (the default value), the data refer to `layout.polar`. If *polar2*, the data refer to `layout.polar2`, and so on.",
);
has text => (
is => "rw",
isa => "Str|ArrayRef[Str]",
documentation =>
"Sets hover text elements associated with each bar. If a single string, the same string appears over all bars. If an array of string, the items are mapped in order to the this trace's coordinates.",
);
has textsrc => ( is => "rw",
isa => "Str",
documentation => "Sets the source reference on Chart Studio Cloud for `text`.",
);
has theta => ( is => "rw",
isa => "ArrayRef|PDL",
documentation => "Sets the angular coordinates",
);
has theta0 => (
is => "rw",
isa => "Any",
documentation =>
"Alternate to `theta`. Builds a linear space of theta coordinates. Use with `dtheta` where `theta0` is the starting coordinate and `dtheta` the step.",
);
has thetasrc => ( is => "rw",
isa => "Str",
documentation => "Sets the source reference on Chart Studio Cloud for `theta`.",
);
has thetaunit => (
is => "rw",
isa => enum( [ "radians", "degrees", "gradians" ] ),
documentation => "Sets the unit of input *theta* values. Has an effect only when on *linear* angular axes.",
);
has transforms => ( is => "rw",
isa => "ArrayRef|ArrayRef[Chart::Plotly::Trace::Barpolar::Transform]", );
has uid => (
is => "rw",
isa => "Str",
documentation =>
"Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
);
has uirevision => (
is => "rw",
isa => "Any",
documentation =>
"Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.",
);
has unselected => ( is => "rw",
isa => "Maybe[HashRef]|Chart::Plotly::Trace::Barpolar::Unselected", );
has visible => (
is => "rw",
documentation =>
"Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
);
has width => ( is => "rw",
isa => "Num|ArrayRef[Num]",
documentation => "Sets the bar angular width (in *thetaunit* units).",
);
has widthsrc => ( is => "rw",
isa => "Str",
documentation => "Sets the source reference on Chart Studio Cloud for `width`.",
);
__PACKAGE__->meta->make_immutable();
1;
__END__
=pod
=encoding utf-8
=head1 NAME
Chart::Plotly::Trace::Barpolar - The data visualized by the radial span of the bars is set in `r`
=head1 VERSION
version 0.042
=head1 SYNOPSIS
use Chart::Plotly;
use Chart::Plotly::Trace::Barpolar;
use Chart::Plotly::Plot;
# Example from https://github.com/plotly/plotly.js/blob/235fe5b214a576d5749ab4c2aaf625dbf7138d63/test/image/mocks/polar_wind-rose.json
my $trace1 = Chart::Plotly::Trace::Barpolar->new(
r => [ 77.5, 72.5, 70.0, 45.0, 22.5, 42.5, 40.0, 62.5 ],
t => [ 'North', 'N-E', 'East', 'S-E', 'South', 'S-W', 'West', 'N-W' ],
name => '11-14 m/s',
marker => { color => 'rgb(106,81,163)' },
);
my $trace2 = {
r => [ 57.5, 50.0, 45.0, 35.0, 20.0, 22.5, 37.5, 55.0 ],
t => [ 'North', 'N-E', 'East', 'S-E', 'South', 'S-W', 'West', 'N-W' ],
name => '8-11 m/s',
marker => { color => 'rgb(158,154,200)' },
type => 'barpolar'
};
my $trace3 = {
r => [ 40.0, 30.0, 30.0, 35.0, 7.5, 7.5, 32.5, 40.0 ],
t => [ 'North', 'N-E', 'East', 'S-E', 'South', 'S-W', 'West', 'N-W' ],
name => '5-8 m/s',
marker => { color => 'rgb(203,201,226)' },
type => 'barpolar'
};
my $trace4 = {
r => [ 20.0, 7.5, 15.0, 22.5, 2.5, 2.5, 12.5, 22.5 ],
t => [ 'North', 'N-E', 'East', 'S-E', 'South', 'S-W', 'West', 'N-W' ],
name => '< 5 m/s',
marker => { color => 'rgb(242,240,247)' },
type => 'barpolar'
};
my $plot = Chart::Plotly::Plot->new(
traces => [ $trace1, $trace2, $trace3, $trace4 ],
layout => {
title => 'Wind Speed Distribution in Laurel, NE',
font => { size => 16 },
legend => { font => { size => 16 } },
polar => {
radialaxis => { ticksuffix => '%', angle => 45, dtick => 20 },
barmode => "overlay",
angularaxis => { direction => "clockwise" },
bargap => 0
}
}
);
Chart::Plotly::show_plot($plot);
=head1 DESCRIPTION
The data visualized by the radial span of the bars is set in `r`
Screenshot of the above example:
=for HTML <p>
<img src="https://raw.githubusercontent.com/pablrod/p5-Chart-Plotly/master/examples/traces/barpolar.png" alt="Screenshot of the above example">
</p>
=for markdown 
=for HTML <p>
<iframe src="https://raw.githubusercontent.com/pablrod/p5-Chart-Plotly/master/examples/traces/barpolar.html" style="border:none;" width="80%" height="520"></iframe>
</p>
This file has been autogenerated from the official plotly.js source.
If you like Plotly, please support them: L<https://plot.ly/>
Open source announcement: L<https://plot.ly/javascript/open-source-announcement/>
Full reference: L<https://plot.ly/javascript/reference/#barpolar>
=head1 DISCLAIMER
This is an unofficial Plotly Perl module. Currently I'm not affiliated in any way with Plotly.
But I think plotly.js is a great library and I want to use it with perl.
=head1 METHODS
=head2 TO_JSON
Serialize the trace to JSON. This method should be called only by L<JSON> serializer.
=head2 type
Trace type.
=head1 ATTRIBUTES
=over
=item * base
Sets where the bar base is drawn (in radial axis units). In *stack* barmode, traces that set *base* will be excluded and drawn in *overlay* mode instead.
=item * basesrc
Sets the source reference on Chart Studio Cloud for `base`.
=item * customdata
Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements
=item * customdatasrc
Sets the source reference on Chart Studio Cloud for `customdata`.
=item * dr
Sets the r coordinate step.
=item * dtheta
Sets the theta coordinate step. By default, the `dtheta` step equals the subplot's period divided by the length of the `r` coordinates.
=item * hoverinfo
Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
=item * hoverinfosrc
Sets the source reference on Chart Studio Cloud for `hoverinfo`.
=item * hoverlabel
=item * hovertemplate
Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
=item * hovertemplatesrc
Sets the source reference on Chart Studio Cloud for `hovertemplate`.
=item * hovertext
Same as `text`.
=item * hovertextsrc
Sets the source reference on Chart Studio Cloud for `hovertext`.
=item * ids
Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
=item * idssrc
Sets the source reference on Chart Studio Cloud for `ids`.
=item * legendgroup
Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
=item * legendgrouptitle
=item * legendrank
Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with `*reversed* `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items.
=item * marker
=item * pmeta
Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
=item * metasrc
Sets the source reference on Chart Studio Cloud for `meta`.
=item * name
Sets the trace name. The trace name appear as the legend item and on hover.
=item * offset
Shifts the angular position where the bar is drawn (in *thetatunit* units).
=item * offsetsrc
Sets the source reference on Chart Studio Cloud for `offset`.
=item * opacity
Sets the opacity of the trace.
=item * r
Sets the radial coordinates
=item * r0
Alternate to `r`. Builds a linear space of r coordinates. Use with `dr` where `r0` is the starting coordinate and `dr` the step.
=item * rsrc
Sets the source reference on Chart Studio Cloud for `r`.
=item * selected
=item * selectedpoints
Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.
=item * showlegend
Determines whether or not an item corresponding to this trace is shown in the legend.
=item * stream
=item * subplot
Sets a reference between this trace's data coordinates and a polar subplot. If *polar* (the default value), the data refer to `layout.polar`. If *polar2*, the data refer to `layout.polar2`, and so on.
=item * text
Sets hover text elements associated with each bar. If a single string, the same string appears over all bars. If an array of string, the items are mapped in order to the this trace's coordinates.
=item * textsrc
Sets the source reference on Chart Studio Cloud for `text`.
=item * theta
Sets the angular coordinates
=item * theta0
Alternate to `theta`. Builds a linear space of theta coordinates. Use with `dtheta` where `theta0` is the starting coordinate and `dtheta` the step.
=item * thetasrc
Sets the source reference on Chart Studio Cloud for `theta`.
=item * thetaunit
Sets the unit of input *theta* values. Has an effect only when on *linear* angular axes.
=item * transforms
=item * uid
Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
=item * uirevision
Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
=item * unselected
=item * visible
Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
=item * width
Sets the bar angular width (in *thetaunit* units).
=item * widthsrc
Sets the source reference on Chart Studio Cloud for `width`.
=back
=head1 AUTHOR
Pablo Rodríguez González <pablo.rodriguez.gonzalez@gmail.com>
=head1 COPYRIGHT AND LICENSE
This software is Copyright (c) 2022 by Pablo Rodríguez González.
This is free software, licensed under:
The MIT (X11) License
=cut