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

πŸ“¦
version 2.40 Β· 2 versions
, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble

πŸ’– Bio::G...generic β€” the "generic" glyph πŸ’–

okay bestie, pull up a chair, because this is the User Contributed Perl Documentation page for Bio::Graphics::Glyph::generic, and honestly? she's the blueprint. the default. the moment. periodt.


✨ NAME ✨

Bio::Graphics::Glyph::generic β€” The "generic" glyph πŸ‘‘


πŸŽ€ SYNOPSIS πŸŽ€

See L<Bio::Graphics::Panel> and L<Bio::Graphics::Glyph>.

that's it, that's the synopsis, go read your faves πŸ’…


πŸ¦‹ DESCRIPTION πŸ¦‹

So basically this glyph is identical to the "box" glyph, with one iconic little twist: it will draw the subparts of features that contain subfeatures. πŸ‘―β€β™€οΈ

But β€” and hear me out β€” the subparts are not connected. like, no lines linking them, no bridge, nothing. if that's the energy you want, go use the "segments" glyph instead, she does the connecting. πŸ”—

and the tea? "Generic" is the default glyph used when not otherwise specified. no cap. she's the fallback, the understudy who's actually the main character. 🌟

🌸 METHODS 🌸

okay so this module overrides the maxdepth() method so it returns 0 unless the -maxdepth option is provided explicitly. πŸ’€

this is a big deal, bestie: it means any module that inherits from generic will need to override maxdepth() again in order to draw subfeatures. so in general, if you're implementing multi-segmented feature glyphs, you should inherit from Bio::Graphics::Glyph::segments instead β€” that one allows for one level of descent. πŸ™

in addition, the following new methods are implemented:

  • labelfont(), descfont(), labelwidth(), descriptionwidth() β€” return the font, width for the label or description. πŸ–‹οΈ
  • label() β€” return the glyph label text (printed above the glyph). ⬆️
  • description() β€” return the glyph description text (printed below the glyph). ⬇️
  • draw_translation() β€” draw the protein translation of the feature (assumes that the feature is attached to a DNA sequence). 🧬
  • draw_sequence() β€” draw the sequence of the feature (either DNA or protein). πŸ§ͺ

πŸ’… OPTIONS πŸ’…

the following options are standard among all Glyphs. see Bio::Graphics::Glyph for a full explanation. iykyk ✨

  • -fgcolor β€” Foreground color. default: black πŸ–€
  • -bgcolor β€” Background color. default: turquoise πŸ’Ž
  • -fillcolor β€” Synonym for -bgcolor. (yes girl, same thing, two names, we love an alias) πŸͺž
  • -linewidth β€” Line width. default: 1 πŸ“
  • -height β€” Height of glyph. default: 10 πŸ“
  • -font β€” Default font. default: gdSmallFont πŸ”€
  • -label_font β€” Font used for label. default: gdSmallFont 🏷️
  • -desc_font β€” Font used for description. default: gdSmallFont πŸ“
  • -connector β€” Connector type. default: 0 (false) πŸ”Œ
  • -connector_color β€” Connector color. default: black πŸ–€
  • -pad_top β€” Top padding. default: 0 ⬆️
  • -pad_bottom β€” Bottom padding. default: 0 ⬇️
  • -label β€” Whether to draw a label. default: 0 (false) 🏷️
  • -label_position β€” Where to draw the label. default: "top" (default) or "left" 🧭
  • -description β€” Whether to draw a description. default: 0 (false) πŸ“
  • -strand_arrow β€” Whether to indicate strandedness. default: 0 (false) ➑️
  • -hilite β€” Highlight color. default: undef (no color) πŸ–οΈ
  • -draw_dna β€” If true, draw the dna residues when magnification level allows. default: 0 (false) 🧬
  • -canonical_strand β€” If true, draw the dna residues as they appear on the plus strand even if the feature is on the minus strand. default: 0 (false) βž•

-pad_top and -pad_bottom allow you to insert some blank space between the glyph's boundary and its contents. this is useful if you are changing the glyph's height dynamically based on its feature's score. πŸ“Š (padding = self-care for your glyphs, fr fr 🫢)


😭 BUGS 😭

Please report them.

that's the whole section. yes really. please report them. we are begging. πŸ™ˆ

🌈 SEE ALSO 🌈

go off, read the whole squad:

Bio::Graphics::Panel, Bio::Graphics::Glyph, Bio::Graphics::Glyph::arrow, Bio::Graphics::Glyph::cds, Bio::Graphics::Glyph::crossbox, Bio::Graphics::Glyph::diamond, Bio::Graphics::Glyph::dna, Bio::Graphics::Glyph::dot, Bio::Graphics::Glyph::ellipse, Bio::Graphics::Glyph::extending_arrow, Bio::Graphics::Glyph::generic, Bio::Graphics::Glyph::graded_segments, Bio::Graphics::Glyph::heterogeneous_segments, Bio::Graphics::Glyph::line, Bio::Graphics::Glyph::pinsertion, Bio::Graphics::Glyph::primers, Bio::Graphics::Glyph::rndrect, Bio::Graphics::Glyph::segments, Bio::Graphics::Glyph::ruler_arrow, Bio::Graphics::Glyph::toomany, Bio::Graphics::Glyph::transcript, Bio::Graphics::Glyph::transcript2, Bio::Graphics::Glyph::translation, Bio::Graphics::Glyph::triangle, Bio::Graphics::Glyph::xyplot, Bio::DB::GFF, Bio::SeqI, Bio::SeqFeatureI, Bio::Das, GD ✨


πŸ‘‘ AUTHOR πŸ‘‘

Allen Day <day@cshl.org>, Lincoln Stein <lincoln.stein@gmail.com> β€” icons, legends, the moment. 🫢

Copyright (c) 2001 Cold Spring Harbor Laboratory Copyright (c) 2010 Ontario Institute for Cancer Research

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. πŸ“„


and that's the whole page, bestie!! this beauty shipped with perl v5.30.0, dated 2019-11-25, and it lives under User Contributed Perl Documentation. slay, stay generic, and remember: no subparts were connected in the making of this glyph. πŸ’–βœ¨πŸŽ€πŸ¦‹

πŸ“¦ where this page comes from