Bio/Graphics/RendererI.pm

   1 # $Id$
   2
   3 =head1 NAME
   4
   5 Bio::Graphics::RendererI - A renderer for the Bio::Graphics class that
   6 renders Bio::SeqFeature::CollectionI objects onto
   7 Bio::Graphics::Panels using configuration information provided by a
   8 Bio::Graphics::ConfiguratorI.
   9
  10 =head1 SYNOPSIS
  11
  12  # Get a renderer somehow, called $renderer
  13
  14  # create a new panel and render contents a feature collection onto it
  15  my $config = new ConfigIO( $config_file )->getConfig();
  16  my $features = $data_provider->getCollection();
  17  my ( $tracks_rendered, $panel ) = $renderer->render( $features, $prefs );
  18
  19 =head1 DESCRIPTION
  20
  21 Renderer of Bio::SeqFeature::CollectionIs (collections of features)
  22 onto a Bio::Graphics::Panel using a Bio::Graphics::ConfiguratorI for
  23 general and track-specific rendering options.
  24
  25 =head1 FEEDBACK
  26
  27 =head2 Mailing Lists
  28
  29 User feedback is an integral part of the evolution of this and other
  30 Bioperl modules. Send your comments and suggestions preferably to
  31 the Bioperl mailing list.  Your participation is much appreciated.
  32
  33   bioperl-l@bioperl.org                  - General discussion
  34   http://bioperl.org/wiki/Mailing_lists  - About the mailing lists
  35
  36 =head2 Reporting Bugs
  37
  38 Report bugs to the Bioperl bug tracking system to help us keep track
  39 of the bugs and their resolution. Bug reports can be submitted via the
  40 web:
  41
  42   http://bugzilla.open-bio.org/
  43
  44 =head1 AUTHOR
  45
  46 Paul Edlefsen E<lt>paul@systemsbiology.orgE<gt>.
  47
  48 Copyright (c) 2003 Institute for Systems Biology
  49
  50 This library is free software; you can redistribute it and/or modify
  51 it under the same terms as Perl itself.  See DISCLAIMER.txt for
  52 disclaimers of warranty.
  53
  54 =head1 APPENDIX
  55
  56 The rest of the documentation details each of the object methods.
  57 Internal methods are usually preceded with a _
  58
  59 =cut
  60
  61 # Let the code begin...
  62
  63 package Bio::Graphics::RendererI;
  64 use strict;
  65
  66 use base qw(Bio::Root::RootI);
  67
  68 =head2 render
  69
  70  Title   : render
  71  Usage   : ( $rendered, $panel ) =
  72                $renderer->render( $collection, $configurator [, $panel ] );
  73  Function: Renders the SeqFeatures in the given collection onto a
  74            Bio::Graphics::Panel (if no panel is given, one will be
  75            created), using the given Bio::Graphics::ConfiguratorI for general
  76            and track-specific rendering options.
  77  Returns : In a scalar context returns the number of tracks rendered.
  78            In a list context, returns a two-element list containing
  79            the number of features rendered and the panel.
  80  Args    : A Bio::SeqFeature::CollectionI and a Bio::Graphics::ConfiguratorI
  81            and optionally a Bio::Graphics::Panel.
  82  Status  : Public
  83
  84 =cut
  85
  86 sub render {
  87   shift->throw_not_implemented();
  88 }
  89
  90 1;