Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

jifty::plugin::chart(3pm) [debian man page]

Jifty::Plugin::Chart(3pm)				User Contributed Perl Documentation				 Jifty::Plugin::Chart(3pm)

NAME

       Jifty::Plugin::Chart - A charting API for Jifty

SYNOPSIS

       In your config.yml:

	 Plugins:
	   - Chart: {}

       In your Mason templates:

	 <% Jifty->web->chart(
	     type   => 'Bar',
	     width  => 400,
	     height => 300,
	     data   => [
		 [ '2004', '2005', '2006', '2007' ], # labels
		 [ 14,	   15,	   17,	   22	  ], # first data set
		 [ 22,	   25,	   20,	   21	  ], # second data set
	     ],
	 ) %>

DESCRIPTION

       CAUTION: This plugin is experimental. The API will change.

       This plugin provides a charting API that can be used by Jifty applications to build data visualizations without regard to the underlying
       rendering mechanism.

       As of this writing, the API is a barely veiled interface over Chart. However, I intend to expand the interface to apply to something like
       Maani's XML/SWF Charts or Imprise Javascript charts or even something like OpenLaszlo (or something Open Source and Perl if I can find or
       build such a thing in time).

INTERFACE

       By adding this method to the plugin configuration for your Jifty application, you will cause Jifty::Web to inherit a new method, "chart",
       which is the cornerstone of this API.

       This method is described in Jifty::Plugin::Chart::Web and an example is shown in the "SYNOPSIS" above.

CONFIGURATION

       Here is an example configuration for config.yml:

	 Plugins:
	   - Chart:
	       DefaultRenderer: PlotKit
	       PreloadRenderers:
		- XMLSWF
		- SimpleBars
		- App::Renderer::Custom

       The available options are:

       DefaultRenderer
	   This is the name of the class to use as the default renderer. Jifty::Plugin::Chart::Renderer::Chart is the current default, but that
	   could change in the future. It's recommended that you set this to your preference.

       PreloadRenderers
	   This is a list of other render classes to load during initialization. If they are not loaded during initialization some renderers may
	   not work correctly the first time they are run because they are not able to inform Jifty of the CSS or JS files they need before that
	   part of the page is already rendered. If you use the "renderer" option of "chart" in Jifty::Plugin::Chart::Web, then you should make
	   sure any value you use is set here in the configuration to make sure it works properly.

METHODS

   init
       Adds the "chart" in Jifty::Plugin::Chart::Web method to Jifty::Web.

   init_renderer
	 my $renderer = $chart_plugin->init_renderer($renderer_class)

       This is a helper method that is used by the API to initialize the renderer class. This is handled automatically so you probably shouldn't
       use this.

SEE ALSO

       Jifty::Plugin, Jifty::Web, Jifty::Plugin::Chart::Renderer, Jifty::Plugin::Chart::Renderer::Chart, Jifty::Plugin::Chart::View

AUTHOR

       Andrew Sterling Hanenkamp "<andrew.hanenkamp@boomer.com>"

COPYRIGHT AND LICENSE

       Copyright 2007 Boomer Consulting, Inc.

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

perl v5.12.4							    2009-07-15						 Jifty::Plugin::Chart(3pm)

Check Out this Related Man Page

Jifty::Plugin::Chart::Renderer(3pm)			User Contributed Perl Documentation		       Jifty::Plugin::Chart::Renderer(3pm)

NAME

       Jifty::Plugin::Chart::Renderer - Base class for chart rendering classes

SYNOPSIS

       In your config.yml:

	 Plugins:
	   - Chart:
	       DefaultRenderer: MyApp::Renderer

       In lib/MyApp/Renderer.pm:

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

	 sub init {
	     my $self = shift;

	     # Handle any required initialization, like required CSS, JS, etc.
	 }

	 sub render {
	     my $self = shift;
	     my %args = @_;

	     # Output your chart
	     Jifty->web->out( #{ Output your chart here... } );

	     # You could also return it as a string...
	     return;
	 }

METHODS

       Your renderer implementation must subclass this package and implement the following methods:

   new
       This is the constructor. Don't override this directly. Instead implement "init".

   init
	 $renderer->init();

       This is called by "new" immediately after constructing the object.  It is passed a param hash from the config file.  Subclasses should
       implement this method to do any required initialization such as letting Jifty know about required CSS files, JS files, etc.

   render
	 Jifty->web->out($renderer->render(%args));

       See Jifty::Plugin::Chart::Web for the arguments. It must (at least) accept the arguments given to the "chart" in Jifty::Plugin::Chart::Web
       method.

       The "render" method may either return it's output or print it out using Jifty::Web::out.

SEE ALSO

       Jifty::Plugin::Chart::Web, Jifty::Plugin::Chart::Renderer::Chart

AUTHOR

       Andrew Sterling Hanenkamp "<andrew.hanenkamp@boomer.com>"

COPYRIGHT AND LICENSE

       Copyright 2007 Boomer Consulting, Inc.

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

perl v5.12.4							    2009-03-09				       Jifty::Plugin::Chart::Renderer(3pm)
Man Page