NAME
BQAxes - BRTT Qt graphics extension for drawing X-Y axes
SYNOPSIS
$(QTNATIVELIBS) -lbqplot_native -lbanner -lbrttutil -lbumapdata $(DBLIBS) $(TRLIBS)
#include "BQ.h"
DESCRIPTION
BQAxes objects are used to display plot axes annotations including the axes
themselves plus tic marks, text labels for the axes,
units labels along the axes and plot grid lines.
This class inherits the BQConfigure class which is itself a subclass of the BUConfigure class
with extensions to process Qt colors and fonts. The configure methods are implemented
in the BUConfigure parent (see BUConfigure(3)).
INHERITS FROM
BQViewportItem,
BQConfigure
CONSTRUCTOR
BQAxes(BQViewport *master);
Where "master" is the BQViewport master for this object.
METHODS INHERITED FROM BQConfigure
-
void configure (Pf *params);
An Antelope parameter file object pointer that contains the BQAxes object
parameters. The parameters are described below.
-
void configure (...);
A variable argument list composed entirely of character string key-value pairs with
a single NULL terminating argument. This is an alternate method for specifying
the BQAxes object parameters. The parameters are described below.
METHODS INHERITED FROM BQViewportItem
-
void setLayer (QString name);
This will cause the BQAxes object to be put into the BQLayer object buffer with name name (see BQLayer(3)).
The BQLayer object will automatically be created if an object with name name does not exist.
OBJECT CONFIGURATION PARAMETERS
-
color_labels labelColor
Specifies a color to use for drawing the label fonts.
Can be specified in any of the forms documented in BQ_ParseColor(3).
These are the text labels for the axes.
This defaults to "black".
-
color_numbers numberColor
Specifies a color to use for drawing the tic number fonts.
Can be specified in any of the forms documented in BQ_ParseColor(3).
These are the tic mark numerical text labels for the axes.
This defaults to "black".
-
color_axes axesColor
Specifies a color to use for drawing the axes and tic mark lines.
Can be specified in any of the forms documented in BQ_ParseColor(3).
This defaults to "black".
-
color_time_axis timeAxisColor
Specifies a color to use for drawing the axis and tic mark lines for a time axis.
Can be specified in any of the forms documented in BQ_ParseColor(3).
This defaults to "black".
-
color_grids gridsColor
Specifies a color to use for drawing the major grid lines, both X and Y.
Can be specified in any of the forms documented in BQ_ParseColor(3).
This defaults to "gray".
-
color_grids_small gridsSmallColor
Specifies a color to use for drawing the minor grid lines, both X and Y.
Can be specified in any of the forms documented in BQ_ParseColor(3).
This defaults to NULL.
-
color_grids_x gridsXColor
Specifies a color to use for drawing the X major grid lines only.
Can be specified in any of the forms documented in BQ_ParseColor(3).
This defaults to "gray".
-
color_grids_x_small gridsXSmallColor
Specifies a color to use for drawing the X minor grid lines only
Can be specified in any of the forms documented in BQ_ParseColor(3).
This defaults to "lightgray".
-
color_grids_y gridsYColor
Specifies a color to use for drawing the Y major grid lines only.
Can be specified in any of the forms documented in BQ_ParseColor(3).
This defaults to "gray".
-
color_grids_y_small gridsYSmallColor
Specifies a color to use for drawing the Y minor minor grid lines only
Can be specified in any of the forms documented in BQ_ParseColor(3).
This defaults to "lightgray".
-
font_labels labelFont
Specifies a font to use for displaying the label strings.
Fonts are specified as "<family>[ <size>[ <weight>[ <italic?>]]]",
where <family> is a font family name, <size>size is a font size in integer points, <weight>
is an integer weight or can be one of Light, Normal, DemiBold, Bold or Black,
and <italic?> is a boolean (yes or no) to indicate if the font is in italics. System defaults
for <size>, <weight> and <italic?> are used if not specified.
This defaults to "Helvetica 16".
-
font_numbers numberFont
Specifies a font to use for displaying the numerical strings.
Fonts are specified as "<family>[ <size>[ <weight>[ <italic?>]]]",
where <family> is a font family name, <size>size is a font size in integer points, <weight>
is an integer weight or can be one of Light, Normal, DemiBold, Bold or Black,
and <italic?> is a boolean (yes or no) to indicate if the font is in italics. System defaults
for <size>, <weight> and <italic?> are used if not specified.
This defaults to "Helvetica 12".
-
font_numbers_superscripts superscriptFont
Specifies a font to use for displaying the exponent numerical strings
used in the display of logarithmic axis labels.
Fonts are specified as "<family>[ <size>[ <weight>[ <italic?>]]]",
where <family> is a font family name, <size>size is a font size in integer points, <weight>
is an integer weight or can be one of Light, Normal, DemiBold, Bold or Black,
and <italic?> is a boolean (yes or no) to indicate if the font is in italics. System defaults
for <size>, <weight> and <italic?> are used if not specified.
This defaults to "Helvetica 8".
-
linewidth_box boxLinewidth
Specifies the line width in integer pixels for the axes box.
A value of "-1" means the line will not be drawn.
This defaults to "1".
-
linewidth_time_axis timeAxisLinewidth
Specifies the line width in integer pixels for the time scale axis.
A value of "-1" means the line will not be drawn.
This defaults to "1".
-
linewidth_tics TicsLinewidth
Specifies the line width for the X and Y axis large increment tic lines in integer pixels.
A value of "-1" means the line will not be drawn.
This defaults to "1".
-
linewidth_tics_small TicsSmallLinewidth
Specifies the line width for the X and Y axis small increment tic lines in integer pixels.
A value of "-1" means the line will not be drawn.
This defaults to "1".
-
linewidth_tics_x TicsXLinewidth
Specifies the line width for the X-axis large increment tic lines in integer pixels.
A value of "-1" means the line will not be drawn.
This defaults to "1".
-
linewidth_tics_x_small TicsXSmallLinewidth
Specifies the line width for the X axis small increment tic lines in integer pixels.
A value of "-1" means the line will not be drawn.
This defaults to "1".
-
linewidth_tics_y TicsYLinewidth
Specifies the line width for the Y-axis large increment tic lines in integer pixels.
A value of "-1" means the line will not be drawn.
This defaults to "1".
-
linewidth_tics_y_small TicsYSmallLinewidth
Specifies the line width for the Y axis small increment tic lines in integer pixels.
A value of "-1" means the line will not be drawn.
This defaults to "1".
-
linewidth_grids GridsLinewidth
Specifies the line width for the X and Y axis major plot grid lines in integer pixels.
A value of "-1" means the line will not be drawn.
This defaults to "1".
-
linewidth_grids_small GridsSmallLinewidth
Specifies the line width for the X and Y axis minor plot grid lines in integer pixels.
A value of "-1" means the line will not be drawn.
This defaults to "-1".
-
linewidth_grids_x GridsXLinewidth
Specifies the line width for the X axis major plot grid lines in integer pixels.
A value of "-1" means the line will not be drawn.
This defaults to "1".
-
linewidth_grids_x_small GridsXSmallLinewidth
Specifies the line width for the X axis minor plot grid lines in integer pixels.
A value of "-1" means the line will not be drawn.
This defaults to "-1".
-
linewidth_grids_y GridsYLinewidth
Specifies the line width for the Y axis major plot grid lines in integer pixels.
A value of "-1" means the line will not be drawn.
This defaults to "1".
-
linewidth_grids_y_small GridsYSmallLinewidth
Specifies the line width for the Y axis minor plot grid lines in integer pixels.
A value of "-1" means the line will not be drawn.
This defaults to "-1".
-
length_tics ticLength
Specifies the length for the X and Y axis large increment tic lines in integer pixels.
This defaults to "10".
-
length_tics_small ticSmallLength
Specifies the length for the X and Y axis small increment tic lines in integer pixels.
This defaults to "5".
-
length_tics_x ticXLength
Specifies the length for the X axis large increment tic lines in integer pixels.
This defaults to "10".
-
length_tics_x_small ticXSmallLength
Specifies the length for the X axis small increment tic lines in integer pixels.
This defaults to "5".
-
length_tics_y ticYLength
Specifies the length for the Y axis large increment tic lines in integer pixels.
This defaults to "10".
-
length_tics_y_small ticYSmallLength
Specifies the length for the Y axis small increment tic lines in integer pixels.
This defaults to "5".
-
xvisible_tics {0|1}
Specifies if the X-axis tic marks are visible, "1", or
invisible, "0".
This defaults to "1".
-
yvisible_tics {0|1}
Specifies if the Y-axis axis tic marks are visible, "1", or
invisible, "0".
This defaults to "1".
-
xvisible_grids {0|1}
Specifies if the X-axis grid lines are visible, "1", or
invisible, "0".
This defaults to "1".
-
yvisible_grids {0|1}
Specifies if the Y-axis grid lines marks are visible, "1", or
invisible, "0".
This defaults to "1".
-
xincrement incrementXtic
Specifies an increment for the major tic marks on the X-axis
in world coordinate units. If this is set to "0.0", then
the major X-axis tic increments are determined automatically.
This defaults to "0.0".
-
xincrement_small smallincrementXtic
Specifies an increment for the minor tic marks on the X-axis
in world coordinate units. If this is set to "0.0", then
the minor X-axis tic increments are determined automatically.
This defaults to "0.0".
-
yincrement incrementYtic
Specifies an increment for the major tic marks on the Y-axis
in world coordinate units. If this is set to "0.0", then
the major Y-axis tic increments are determined automatically.
This defaults to "0.0".
-
yincrement_small smallincrementYtic
Specifies an increment for the minor tic marks on the Y-axis
in world coordinate units. If this is set to "0.0", then
the minor Y-axis tic increments are determined automatically.
This defaults to "0.0".
-
mindx minimumXtic
This is a minimum size hint for the X-axis major tic mark increment.
It is used to limit how small major tic intervals can be when
the xincrement option is set to "0.0". This is specified
in units of pixels.
This defaults to "200".
-
mindy minimumYtic
This is a minimum size hint for the Y-axis major tic mark increment.
It is used to limit how small major tic intervals can be when
the yincrement option is set to "0.0". This is specified
in units of pixels.
This defaults to "100".
-
xlabel labelXaxis
Specifies a label string that is displayed under the X-axis.
This defaults to "".
-
ylabel labelYaxis
Specifies a label string that is displayed to the left of the Y-axis.
Note that the Y-axis label is rotated 90 degrees counter clockwise.
This defaults to "".
-
xformat formatXaxis
This specifies a normal printf(3C)-style format string that
determines how the X-axis numerical tic labels are displayed.
If this is "auto", then the format is determined automatically.
If this is "none", then no X-axis numerical labeling will be done.
If this is "time", then X-axis numerical labeling will be done assuming
the X axis is an absolute time axis and the labels will be similar to those
in dbpick(1) and orbrtd(1). Note that the "time" format
disables the normal X-axis tic generation and instead draws optional grid time lines.
If the grid time lines are drawn using this format option, then they should not be drawn
for the X-axis using the BQGrid(3) object (this can be done with the X-axis
only by using the visibile_x and visibile_xsmall options).
This defaults to "auto".
-
yformat formatYaxis
This specifies a normal printf(3C)-style format string that
determines how the Y-axis numerical tic labels are displayed.
If this is "auto", then the format is determined automatically.
If this is "none", then no Y-axis numerical labeling will be done.
This defaults to "auto".
-
time_format timeFormat
Specifies a format string for labeling the X-axis time values.
This is only used when xformat is set to "time".
This string is in the style of the time format specifications used by epoch2str(3).
If this string is set to "", then a time label is not displayed.
This defaults to "%T".
-
date_format dateFormat
Specifies a format string for labeling the X-axis date values.
This is only used when xformat is set to "time".
This string is in the style of the time format specifications used by epoch2str(3).
If this string is set to "", then a date label is not displayed.
This defaults to "%G".
-
axis_style axisStyle
This specifies on which sides of the viewport window the axis lines
are to be drawn, with n for north (top), s for
south (bottom), e, for east (right), and w, for
west (left). The characters for each desired side are concatenated
together in the string.
This defaults to "nsew".
-
tic_style ticStyle
This specifies where and how tic marks will be drawn.
Each entry consists of two characters with the first character
specifying the viewport window side for drawing the tic marks, the
same as the n, s, e, w characters
in the axis_style argument, and the second character specifying one
of i, to draw the tic marks inside of the viewport
window, o, to draw the tic marks outside of the
viewport window, or c, to center the tic marks on the sides of
the viewport window. The characters for each desired side are concatenated
together in the string.
This defaults to "nisieiwi".
SEE ALSO
bqplot(3),
BQViewport(3),
BQLayer(3),
BQConfigure(3)
AUTHOR
Danny Harvey, BRTT