Bio::Graphics::Glyph::arrow3pm
The "arrow" glyph
Usage
See L<Bio::Graphics::Panel> and L<Bio::Graphics::Glyph>.
Overview
This glyph draws arrows. Depending on options, the arrows can be labeled, be oriented vertically or horizontally, or can contain major and minor ticks suitable for use as a scale.
Options
The following options are standard among all Glyphs. See Bio::Graphics::Glyph for a full explanation.
Option Description Default------ ----------- --------fgcolor Foreground color black-outlinecolor Synonym for -fgcolor-bgcolor Background color turquoise-fillcolor Synonym for -bgcolor-linewidth Line width 1-height Height of glyph 10-font Glyph font gdSmallFont-connector Connector type 0 (false)-connector_colorConnector color black-label Whether to draw a label 0 (false)-description Whether to draw a description 0 (false)-hilite Highlight color undef (no color)
In addition to the common options, the following glyph-specific options are recognized:
Option Description Default------ ----------- --------tick Whether to draw major 0and minor ticks.0 = no ticks1 = major ticks2 = minor ticks-tickcolor Color to use for tick marks fgcolor-tickwidth Line width to use for ticks linewidth-parallel Whether to draw the arrow 1 (true)parallel to the sequenceor perpendicular to it.-northeast Force a north or east 1 (true)arrowhead(dependingon orientation)-east synonym of above-southwest Force a south or west 1 (true)arrowhead(dependingon orientation)-west synonym of above-double force-doubleheaded arrow 0 (false)-base Draw a vertical base at the 0 (false)non-arrowhead side-scale Reset the labels on the arrow 0 (false)to reflect an externallyestablished scale.-arrowstyle "regular" to create a simple regulararrowhead. "filled" to createa thick filled arrowhead-relative_coordsuse relative coordinates 0 (false)for scale-relative_coords_offsetset the relative offset 1for scale-label_intervals 0 (false)Put the numeric labels on theintervals between the ticksrather than on the ticksthemselves.-units add units to the tick labels nonee.g. bp-unit_divider 1divide tick labels by theindicated amount prior todisplaying (use, for exampleif you want to display incR units)
Set -parallel to 0 (false) to display a point-like feature such as a polymorphism, or to indicate an important location. If the feature start == end, then the glyph will draw a single arrow at the designated location:
^|
Otherwise, there will be two arrows at the start and end:
^ ^| |
Scale: Pass in a externally established scale to reset the labels on the arrow. This is particularly useful for manually constructed images where the founding parameters of the panel are not 1-based. For example, a genetic map interval ranging from 0.1 - 0.3 can be constructed by first multiplying every value by 100. Passing
arrow(-scale=>100);
will draw tick marks labelled appropriately to your external scale.
Releases
10 releases since Debian 3.0 (Woody); the text changed 7 times.