File Coverage

blib/lib/Chart/Plotly/Plot.pm

Criterion	Covered	Total	%
statement	51	53	96.2
branch	15	20	75.0
condition	2	5	40.0
subroutine	9	9	100.0
pod	4	4	100.0
total	81	91	89.0

package Chart::Plotly::Plot;

use Moose;
use JSON qw();
use utf8;

use UUID::Tiny ':std';

our $VERSION = '0.041';    # VERSION

use Chart::Plotly;

has traces => ( traits  => ['Array'],
                is      => 'rw',
                isa     => 'ArrayRef',
                default => sub { [] },
                handles => { add_trace    => 'push',
                             get_trace    => 'get',
                             insert_trace => 'insert',
                             delete_trace => 'delete'
                }
);

has layout => ( is  => 'rw',
                isa => 'HashRef' );

has config => ( is  => 'rw',
                isa => 'HashRef' );

sub html {
    my $self                         = shift;
    my %params                       = @_;
    my $chart_id                     = $params{'div_id'} // create_uuid_as_string(UUID_TIME);
    my $load_plotly_using_script_tag = $params{'load_plotly_using_script_tag'} // 1;
    my $layout                       = $self->layout;
    my $config                       = $self->config;
    if ( defined $config ) {
        $config = Chart::Plotly::_process_data($config);
        if ( !defined $layout ) {
            $layout = {};
        }
    }
    if ( defined $layout ) {
        $layout = Chart::Plotly::_process_data($layout);
    }
    return
      Chart::Plotly::_render_cell( Chart::Plotly::_process_data( $self->traces() ),
                       $chart_id, $layout, $config, { load_plotly_using_script_tag => $load_plotly_using_script_tag } );
}

sub TO_JSON {
    my $self   = shift;
    my $layout = $self->layout;
    my $config = $self->config;
    my %json   = ( data => $self->traces() );
    if ( defined $layout ) {
        $json{layout} = $layout;
    }
    if ( defined $config ) {
        $json{config} = $config;
    }
    return \%json;
}

sub to_json_text {
    my $self   = shift;
    my $layout = $self->layout;
    my $config = $self->config;
    my $json   = '{ "data": ' . Chart::Plotly::_process_data( $self->traces() );
    if ( defined $layout ) {
        $layout = Chart::Plotly::_process_data($layout);
        $json .= ', "layout": ' . $layout;
    }
    if ( defined $config ) {
        $config = Chart::Plotly::_process_data($config);
        $json .= ', "config": ' . $config;
    }
    return $json . " }";
}

sub from_json {
    my $class = shift;
    my $json  = shift;
    my %data  = %{ JSON::from_json($json) };
    return
      $class->new( ( defined $data{"data"}   ? ( traces => $data{"data"} )   : () ),
                   ( defined $data{"layout"} ? ( layout => $data{"layout"} ) : () ),
                   ( defined $data{"config"} ? ( config => $data{"config"} ) : () )
      );
}

1;

__END__

=pod

=encoding utf-8

=head1 NAME

Chart::Plotly::Plot

=head1 VERSION

version 0.041

=head1 SYNOPSIS

 use Chart::Plotly::Trace::Scatter;
 use Chart::Plotly::Plot;
 use Chart::Plotly qw(show_plot);
 use HTML::Show;

 my $x = [1 .. 15];
 my $y = [map {rand 10 } @$x];
 my $scatter = Chart::Plotly::Trace::Scatter->new(x => $x, y => $y);
 my $plot = Chart::Plotly::Plot->new();
 $plot->add_trace($scatter);

 show_plot($plot);

 # This also works
 # HTML::Show::show(Chart::Plotly::render_full_html(data => $plot));
 # HTML::Show::show($plot->html);

=head1 DESCRIPTION

Represent a full plot composed of one or more traces (Chart::Plotly::Trace::*)

=head1 NAME

Chart::Plotly::Plot - Set of traces with their options and data

=head1 METHODS

=head2 config

Configuration options for the plot. See L<https://plot.ly/javascript/configuration-options/>

=head2 html

Returns the html corresponding to the plot

=head3 Parameters

=over 4

=item div_id

=item load_plotly_using_script_tag

Add the script tag neccesary for loading plotly.js. Default 1.

If plotly.js is going to be loaded in another place or some other way (e.g.: via RequireJS) is better to set to 0

=back

=head2 TO_JSON

Returns the structure suitable to serialize to JSON corresponding to the plot.

This method is meant to be called by a JSON serializer, not directly.

Beware with nested data. For example piddle are still there and you're
responsible to provide an appropiatte serializer. If you want
the text representation of json use the method: to_json_text

=head2 to_json_text

Returns the plot serialized in JSON. Not suitable to use in
nested structures. For nested structures you should check TO_JSON

=head2 from_json

Build the plot from a json string in the format returned by to_json_text.

Beware when using to_json_text and from_json the plot object can be
slightly different (although the representation is the same). That is the
reconstructed plot is equivalent to the first, for example when using PDL,
piddles are serialized to simple arrays and when deserialized are just plain
arrays.

=head1 AUTHOR

Pablo Rodríguez González

=head1 BUGS

Please report any bugs or feature requests via github: L<https://github.com/pablrod/p5-Chart-Plotly/issues>

=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.

If you like plotly.js please consider supporting them purchasing a pro subscription: L<https://plot.ly/products/cloud/>

=head1 LICENSE AND COPYRIGHT

Copyright 2016 Pablo Rodríguez González.

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

=head1 AUTHOR

Pablo Rodríguez González <[e-mail]>

=head1 COPYRIGHT AND LICENSE

This software is Copyright (c) 2020 by Pablo Rodríguez González.

This is free software, licensed under:

  The MIT (X11) License

=cut