~ubuntu-branches/ubuntu/karmic/libjifty-plugin-chart-perl/karmic

use strict;

use warnings;

 

package Jifty::Plugin::Chart::Renderer::PlotKit;

use base qw/Jifty::Plugin::Chart::Renderer /;

 

use Jifty::YAML;

 

=head1 NAME

 

Jifty::Plugin::Chart::Renderer::PlotKit - A chart renderer using PlotKit

 

=head1 DESCRIPTION

 

This is an alternate chart renderer used by the L<Jifty::Plugin::Chart> plugin. It works by rendering a <div> tag in the HTML output and some JavaScript in a <script> tag.

 

=head1 METHODS

 

=head2 init

 

Adds the various JavaScript files required to use PlotKit.

 

=cut

 

sub init {

 

    Jifty->web->add_external_javascript(qw(

        /static/js/mochikit.noexport.js

        /static/js/MochiKit/MochiKit.js

    ));

    Jifty->web->add_javascript(qw(

        PlotKit/excanvas.js

        PlotKit/PlotKit_Packed-20060807-custom.js

    ));

}

 

=head2 render

 

Implemented the L<Jifty::Plugin::Chart::Renderer/render> method interface.

 

=cut

 

sub render {

    my $self = shift;

    my %args = ( options => {}, @_ );

 

    # translations from generic type to PlotKit types

    my %types = (

        lines          => { type => 'line' },

        bars           => { type => 'bar', barOrientation => 'vertical' },

        pie            => { type => 'pie' },

        horizontalbars => { type => 'bar', barOrientation => 'horizontal' },

    );

 

    # save it for error reporting

    my $orig_type = $args{type};

 

    # Make sure the type is ready to be used

    my $options = $types{ $args{type} } || {};

    $args{type} = delete $options->{type};

    $args{options}{$_} = $options->{$_} foreach keys %$options;

 

    # Bad stuff, not a supported type

    if ( not defined $args{type} ) {

        $self->log->warn("Unsupported chart type: $orig_type!");

        return;

    }

 

    # Kill the "px" unit

    $args{width} =~ s/px$//;

    $args{height} =~ s/px$//;

 

    $self->_transform_data( \%args );

 

    # Save the data for retrieval from the session later

    my $chart_id   = 'chart_' . Jifty->web->serial;

 

    # Output the <canvas> tag and include the chart's JS

    my $div;

    $div  = qq{<div id="$chart_id"};

    $div .= qq{ class="@{[ join ' ', @{ $args{class} } ]}"};

    $div .= qq{ height="$args{height}"} if $args{height};

    $div .= qq{ width="$args{width}"}   if $args{width};

    $div .= qq{></div>};

 

    Jifty->web->out(<<"    END_OF_HTML");

$div

 

<script type="text/javascript">

var plot = function() {

    var plotter = PlotKit.EasyPlot(

        "$args{type}",

        @{[Jifty::JSON::objToJson( $args{options} )]},

        \$("$chart_id"),

        @{[Jifty::JSON::objToJson( $args{data} )]}

    );

};

YAHOO.util.Event.onAvailable( "$chart_id", plot );

</script>

    END_OF_HTML

 

    # Make sure we don't return anything that will get output

    return;

}

 

sub _transform_data {

    my $self = shift;

    my $args = shift;

 

    my @data;

    my $labels = shift @{ $args->{data} };

 

    for ( my $i = 0; $i < @$labels; $i++ ) {

        push @{$args->{options}{xTicks}}, { v => $i, label => $labels->[$i] }

            if defined $labels->[$i];

    }

    

    for my $dataset ( @{ $args->{data} } ) {

        my @ds;

        for ( my $i = 0; $i < @$dataset; $i++ ) {

            # PlotKit can't deal with undefined values

            if ( not ref $dataset->[$i] ) {

                push @ds, [ $i, defined $dataset->[$i] ? $dataset->[$i] : '0' ];

            } else {

                push @ds, $dataset->[$i];

            }

        }

        push @data, \@ds;

    }

 

    $args->{data} = \@data;

}

 

sub prereq_plugins {

  return ("Prototypism");

}

 

=head1 SEE ALSO

 

L<Jifty::Plugin::Chart>, L<Jifty::Plugin::Chart::Renderer>

 

=head1 AUTHOR

 

Thomas Sibley

 

=head1 COPYRIGHT AND LICENSE

 

Copyright 2007 Best Practical Solutions, LLC

 

This is free software and may be modified and distributed under the same terms as Perl itself.

 

=cut

 

1;