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

🌸 NAME 🌸

Bio::Graphics::Glyph::arrow — the "arrow" glyph, bestie. That's it, that's the whole vibe. 💖

---

✨ SYNOPSIS ✨

See Bio::Graphics::Panel and Bio::Graphics::Glyph. No cap, those are the ones you wanna go read first. 📚

---

🦋 DESCRIPTION 🦋

Okay so this glyph draws arrows. That's the main character move. 💅

Depending on what options you pass, the arrows can be:

• labeled 👑
• oriented vertically or horizontally 🔄
• stuffed full of major and minor ticks so they work as a scale 📏

Versatile icon, honestly.

🎀 OPTIONS 🎀

These first ones are the standard options that every glyph has. Wanna know more? Go read Bio::Graphics::Glyph, it explains everything. 🫶

• -fgcolor — foreground color, default is black 🖤
• -outlinecolor — synonym for -fgcolor, same energy ✨
• -bgcolor — background color, default is turquoise 💎
• -fillcolor — synonym for -bgcolor 💎
• -linewidth — line width, default is 1
• -height — height of the glyph, default is 10
• -font — the glyph font, default is gdSmallFont 🔤
• -connector — connector type, default is 0 (false)
• -connector_color — connector color, default is black 🖤
• -label — whether to draw a label, default is 0 (false)
• -description — whether to draw a description, default is 0 (false)
• -hilite — highlight color, default is undef (no color, so nothing gets highlighted, tragic) 😭

---

And on top of all those common ones, this glyph ALSO recognizes these glow-up options 👇

• -tick — whether to draw major and minor ticks. Default is 0.
  • 0 = no ticks
  • 1 = major ticks
  • 2 = minor ticks
• -tickcolor — color to use for tick marks, default is fgcolor 🎨
• -tickwidth — line width to use for ticks, default is linewidth
• -parallel — whether to draw the arrow parallel to the sequence or perpendicular to it. Default is 1 (true).
• -northeast — force a north or east arrowhead (depending on orientation). Default is 1 (true).
• -east — synonym of the above, same thing, different name 💫
• -southwest — force a south or west arrowhead (depending on orientation). Default is 1 (true).
• -west — synonym of the above 💫
• -double — force-doubleheaded arrow. Default is 0 (false).
• -base — draw a vertical base at the non-arrowhead side. Default is 0 (false).
• -scale — reset the labels on the arrow to reflect an externally established scale. Default is 0 (false).
• -arrowstyle — "regular" to create a simple arrowhead. "filled" to create a thick filled arrowhead. Default is regular.
• -relative_coords — use relative coordinates for scale. Default is 0 (false).
• -relative_coords_offset — set the relative offset for scale. Default is 1.
• -label_intervals — put the numeric labels on the intervals between the ticks rather than on the ticks themselves. Default is 0 (false).
• -units — add units to the tick labels, e.g. bp. Default is none.
• -unit_divider — divide tick labels by the indicated amount prior to displaying (use this, for example, if you want to display in cR units). Default is 1.

---

The -parallel tea ☕

Set -parallel to 0 (false) if you wanna display a point-like feature — think a polymorphism — or if you just need to flag an important location. 📍

If the feature start == end, the glyph draws a single arrow at the designated location:

       ^
       |

Otherwise you get two arrows, one at the start and one at the end:

       ^              ^
       |              |

Two arrows, one location each, iconic. 🏹🏹

---

The -scale tea ☕

Pass in an externally established scale to reset the labels on the arrow. This is highkey useful for manually constructed images where the founding parameters of the panel are not 1-based.

Example time: a genetic map interval ranging from 0.1 – 0.3 can be constructed by first multiplying every value by 100. Then passing

arrow(-scale=>100);

will draw tick marks labelled appropriately to your external scale. Slay. 📐✨

---

💀 BUGS 💀

Please report them. (fr fr, just tell someone.) 🙏

---

🌈 SEE ALSO 🌈

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::DB::GFF, Bio::SeqI, Bio::SeqFeatureI, Bio::Das, GD

---

👑 AUTHOR 👑

Lincoln Stein <lstein@cshl.org>. 🫡

Copyright (c) 2001 Cold Spring Harbor Laboratory

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. 🧾

---

okay that's the whole page bestie, go forth and draw ur arrows 💖✨

perl v5.30.0 · 2019-11-25 · Bio::G...::arrow(3pm) — mwah, bye! 🎀🦋