Chart-Plotly
view release on metacpan or search on metacpan
lib/Chart/Plotly/Trace/Funnelarea.pm view on Meta::CPAN
if ( $self->can('type') && ( !defined $hash{'type'} ) ) {
$hash{type} = $self->type();
}
return \%hash;
}
sub type {
my @components = split( /::/, __PACKAGE__ );
return lc( $components[-1] );
}
has aspectratio => ( is => "rw",
isa => "Num",
documentation => "Sets the ratio between height and width",
);
has baseratio => ( is => "rw",
isa => "Num",
documentation => "Sets the ratio between bottom length and maximum top length.",
);
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 dlabel => ( is => "rw",
isa => "Num",
documentation => "Sets the label step. See `label0` for more info.",
);
has domain => ( is => "rw",
isa => "Maybe[HashRef]|Chart::Plotly::Trace::Funnelarea::Domain", );
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::Funnelarea::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_}....
);
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 =>
"Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace's sectors. To be seen, trace `hoverinfo` must contain a *...
);
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 insidetextfont => ( is => "rw",
isa => "Maybe[HashRef]|Chart::Plotly::Trace::Funnelarea::Insidetextfont", );
has label0 => (
is => "rw",
isa => "Num",
documentation =>
"Alternate to `labels`. Builds a numeric set of labels. Use with `dlabel` where `label0` is the starting label and `dlabel` the step.",
);
has labels => (
is => "rw",
isa => "ArrayRef|PDL",
documentation =>
"Sets the sector labels. If `labels` entries are duplicated, we sum associated `values` or simply count occurrences if `values` is not provided. For other array attributes (including color) we use the first non-empty entry among all occurrences...
);
has labelssrc => ( is => "rw",
isa => "Str",
documentation => "Sets the source reference on Chart Studio Cloud for `labels`.",
);
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.",
);
lib/Chart/Plotly/Trace/Funnelarea.pm view on Meta::CPAN
has name => ( is => "rw",
isa => "Str",
documentation => "Sets the trace name. The trace name appear as the legend item and on hover.",
);
has opacity => ( is => "rw",
isa => "Num",
documentation => "Sets the opacity of the trace.",
);
has scalegroup => (
is => "rw",
isa => "Str",
documentation =>
"If there are multiple funnelareas that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group.",
);
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::Funnelarea::Stream", );
has text => (
is => "rw",
isa => "ArrayRef|PDL",
documentation =>
"Sets text elements associated with each sector. If trace `textinfo` contains a *text* flag, these elements will be seen on the chart. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the ho...
);
has textfont => ( is => "rw",
isa => "Maybe[HashRef]|Chart::Plotly::Trace::Funnelarea::Textfont", );
has textinfo => ( is => "rw",
isa => "Str",
documentation => "Determines which trace information appear on the graph.",
);
has textposition => ( is => "rw",
isa => union( [ enum( [ "inside", "none" ] ), "ArrayRef" ] ),
documentation => "Specifies the location of the `textinfo`.",
);
has textpositionsrc => ( is => "rw",
isa => "Str",
documentation => "Sets the source reference on Chart Studio Cloud for `textposition`.",
);
has textsrc => ( is => "rw",
isa => "Str",
documentation => "Sets the source reference on Chart Studio Cloud for `text`.",
);
has texttemplate => (
is => "rw",
isa => "Str|ArrayRef[Str]",
documentation =>
"Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\". Numbers are formatted using d3-format's syntax %{variabl...
);
has texttemplatesrc => ( is => "rw",
isa => "Str",
documentation => "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
);
has title => ( is => "rw",
isa => "Maybe[HashRef]|Chart::Plotly::Trace::Funnelarea::Title", );
has transforms => ( is => "rw",
isa => "ArrayRef|ArrayRef[Chart::Plotly::Trace::Funnelarea::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-d...
);
has values => ( is => "rw",
isa => "ArrayRef|PDL",
documentation => "Sets the values of the sectors. If omitted, we count occurrences of each label.",
);
has valuessrc => ( is => "rw",
isa => "Str",
documentation => "Sets the source reference on Chart Studio Cloud for `values`.",
);
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).",
);
__PACKAGE__->meta->make_immutable();
1;
__END__
=pod
=encoding utf-8
=head1 NAME
Chart::Plotly::Trace::Funnelarea - Visualize stages in a process using area-encoded trapezoids. This trace can be used to show data in a part-to-whole representation similar to a "pie" trace, wherein each item appears in a single stage. See also the ...
=head1 VERSION
version 0.042
lib/Chart/Plotly/Trace/Funnelarea.pm view on Meta::CPAN
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/#funnelarea>
=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 * aspectratio
Sets the ratio between height and width
=item * baseratio
Sets the ratio between bottom length and maximum top length.
=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 * dlabel
Sets the label step. See `label0` for more info.
=item * domain
=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 sho...
=item * hovertemplatesrc
Sets the source reference on Chart Studio Cloud for `hovertemplate`.
=item * hovertext
Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace's sectors. To be seen, trace `hoverinfo` must contain a *text* f...
=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 * insidetextfont
=item * label0
Alternate to `labels`. Builds a numeric set of labels. Use with `dlabel` where `label0` is the starting label and `dlabel` the step.
=item * labels
Sets the sector labels. If `labels` entries are duplicated, we sum associated `values` or simply count occurrences if `values` is not provided. For other array attributes (including color) we use the first non-empty entry among all occurrences of the...
=item * labelssrc
Sets the source reference on Chart Studio Cloud for `labels`.
=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...
=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` tex...
=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 * opacity
Sets the opacity of the trace.
=item * scalegroup
If there are multiple funnelareas that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group.
=item * showlegend
Determines whether or not an item corresponding to this trace is shown in the legend.
=item * stream
=item * text
Sets text elements associated with each sector. If trace `textinfo` contains a *text* flag, these elements will be seen on the chart. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover lab...
=item * textfont
=item * textinfo
Determines which trace information appear on the graph.
=item * textposition
Specifies the location of the `textinfo`.
=item * textpositionsrc
Sets the source reference on Chart Studio Cloud for `textposition`.
=item * textsrc
Sets the source reference on Chart Studio Cloud for `text`.
=item * texttemplate
Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-form...
=item * texttemplatesrc
Sets the source reference on Chart Studio Cloud for `texttemplate`.
=item * title
=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 t...
=item * values
Sets the values of the sectors. If omitted, we count occurrences of each label.
=item * valuessrc
Sets the source reference on Chart Studio Cloud for `values`.
=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).
=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
( run in 1.175 second using v1.01-cache-2.11-cpan-39bf76dae61 )