Bio::G...dererI(3pm)

💖 NAME 💖

Bio::Graphics::RendererI — it's the renderer for the Bio::Graphics squad that takes your Bio::SeqFeature::CollectionI objects and ✨renders✨ them onto Bio::Graphics::Panels, using all the config tea that a Bio::Graphics::ConfiguratorI hands over. no cap, that's the whole job. 🎀

---

🌸 SYNOPSIS 🌸

# Get a renderer somehow, called $renderer

# create a new panel and render contents a feature collection onto it
my $config = new ConfigIO( $config_file )->getConfig();
my $features = $data_provider->getCollection();
my ( $tracks_rendered, $panel ) = $renderer->render( $features, $prefs );

like. get a renderer. get a collection. render it. slay. 💅

---

🦋 DESCRIPTION 🦋

okay so bestie, this thing is a renderer of Bio::SeqFeature::CollectionIs (aka collections of features, literally a whole friend group of features) onto a Bio::Graphics::Panel, and it uses a Bio::Graphics::ConfiguratorI to figure out the general rendering options and the per-track rendering options. it's giving project manager energy, honestly. 👑

---

📬 FEEDBACK 📬

💌 Mailing Lists 💌

user feedback is an integral part of the evolution of this module and the other Bioperl modules — like, the glow-up literally does not happen without you. send your comments and suggestions (preferably) to the Bioperl mailing list. your participation is so appreciated, fr fr. 🫶

bioperl-l@bioperl.org                  - General discussion
http://bioperl.org/wiki/Mailing_lists  - About the mailing lists

🐛 Reporting Bugs 🐛

found a bug? tell the Bioperl bug tracking system so they can keep track of it and get it resolved — that's how we keep the vibes immaculate. bug reports can be submitted via the web:

http://bugzilla.open-bio.org/

---

👑 AUTHOR 👑

Paul Edlefsen <paul@systemsbiology.org>. iconic behavior.

Copyright (c) 2003 Institute for Systems Biology

this library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. see DISCLAIMER.txt for disclaimers of warranty. (yes, actually read it, bestie — warranty disclaimers are not the vibe to skip. 😭)

---

✨ APPENDIX ✨

the rest of the documentation spills all the details on each of the object methods. internal methods are usually preceded with a _ (iykyk, that underscore is the "don't touch, that's private" signal 🙈).

🧚 render 🧚

Title   : render
Usage   : ( $rendered, $panel ) =
              $renderer->render( $collection, $configurator [, $panel ] );
Function: Renders the SeqFeatures in the given collection onto a
          Bio::Graphics::Panel (if no panel is given, one will be
          created), using the given Bio::Graphics::ConfiguratorI for general
          and track-specific rendering options.
Returns : In a scalar context returns the number of tracks rendered.
          In a list context, returns a two-element list containing
          the number of features rendered and the panel.
Args    : A Bio::SeqFeature::CollectionI and a Bio::Graphics::ConfiguratorI
          and optionally a Bio::Graphics::Panel.
Status  : Public

okay so real talk on the return values, because this trips people up: in scalar context you get back the number of tracks rendered. in list context you get a two-element list — the number of features rendered AND the panel. two different numbers depending on context, not me being chaotic, that's just the API. 📊

and if you don't hand it a Bio::Graphics::Panel, don't even worry, it'll make one for you. main character energy, it handles its own setup. ✨

---

that's the whole page, bestie!! this one's from perl v5.30.0, dated 2019-11-25, and it lives in the User Contributed Perl Documentation for Bio::Graphics::RendererI(3pm). go render something gorgeous. 💖🌈🎀