public class RrdGraphDef extends Object implements RrdGraphConstants
RrdGraph
class which
will actually create the graph.
The text printed below the actual graph can be formated by appending special escaped characters at the end of a text. When ever such a character occurs, all pending text is pushed onto the graph according to the character specified.
Valid markers are: \j for justified, \l for left aligned, \r for right aligned and \c for centered.
Normally there are two space characters inserted between every two items printed into the graph. The space following a string can be suppressed by putting a \g at the end of the string. The \g also squashes any space inside the string if it is at the very end of the string. This can be used in connection with %s to suppress empty unit strings.
A special case is COMMENT:\s this inserts some additional vertical space before placing the next row of legends.
When text has to be formated without special instructions from your side, RRDTool will automatically justify the text as soon as one string goes over the right edge. If you want to prevent the justification without forcing a newline, you can use the special tag \J at the end of the string to disable the auto justification.
Modifier and Type | Field and Description |
---|---|
(package private) boolean |
altAutoscale |
(package private) boolean |
altAutoscaleMax |
(package private) boolean |
altYGrid |
(package private) boolean |
altYMrtg |
(package private) boolean |
antiAliasing |
(package private) String |
backgroundImage |
(package private) double |
base |
(package private) Paint[] |
colors |
(package private) List<CommentText> |
comments |
(package private) boolean |
drawXGrid |
(package private) boolean |
drawYGrid |
(package private) long |
endTime |
(package private) String |
filename |
(package private) int |
firstDayOfWeek |
(package private) File |
fontDir |
(package private) Font[] |
fonts |
(package private) boolean |
forceRulesLegend |
(package private) int |
height |
(package private) String |
imageFormat |
(package private) String |
imageInfo |
(package private) float |
imageQuality |
(package private) boolean |
interlaced |
(package private) boolean |
lazy |
(package private) boolean |
logarithmic |
(package private) double |
maxValue |
(package private) double |
minValue |
(package private) boolean |
noLegend |
(package private) boolean |
noMinorGrid |
(package private) boolean |
onlyGraph |
(package private) String |
overlayImage |
(package private) List<PlotElement> |
plotElements |
(package private) boolean |
poolUsed |
(package private) boolean |
rigid |
(package private) boolean |
showSignature |
(package private) String |
signature |
(package private) List<Source> |
sources |
(package private) long |
startTime |
(package private) long |
step |
(package private) TimeAxisSetting |
timeAxisSetting |
(package private) String |
title |
(package private) String |
unit |
(package private) int |
unitsExponent |
(package private) int |
unitsLength |
(package private) ValueAxisSetting |
valueAxisSetting |
(package private) String |
verticalLabel |
(package private) int |
width |
ALIGN_CENTER_MARKER, ALIGN_JUSTIFIED_MARKER, ALIGN_LEFT_MARKER, ALIGN_RIGHT_MARKER, COLOR_ARROW, COLOR_BACK, COLOR_CANVAS, COLOR_FONT, COLOR_FRAME, COLOR_GRID, COLOR_MGRID, COLOR_NAMES, COLOR_SHADEA, COLOR_SHADEB, DAY, DEFAULT_ARROW_COLOR, DEFAULT_BACK_COLOR, DEFAULT_BASE, DEFAULT_CANVAS_COLOR, DEFAULT_END, DEFAULT_FONT_COLOR, DEFAULT_FONT_NAME, DEFAULT_FRAME_COLOR, DEFAULT_GRID_COLOR, DEFAULT_HEIGHT, DEFAULT_IMAGE_FORMAT, DEFAULT_IMAGE_QUALITY, DEFAULT_MGRID_COLOR, DEFAULT_MONOSPACE_FONT_FILE, DEFAULT_PROPORTIONAL_FONT_FILE, DEFAULT_SHADEA_COLOR, DEFAULT_SHADEB_COLOR, DEFAULT_START, DEFAULT_UNITS_LENGTH, DEFAULT_WIDTH, FIRST_DAY_OF_WEEK, FONTTAG_AXIS, FONTTAG_DEFAULT, FONTTAG_LEGEND, FONTTAG_NAMES, FONTTAG_TITLE, FONTTAG_UNIT, FONTTAG_WATERMARK, FRIDAY, GLUE_MARKER, GRID_STROKE, HOUR, IN_MEMORY_IMAGE, LEGEND_BOX, LEGEND_BOX_SPACE, LEGEND_INTERSPACING, LEGEND_LEADING, LEGEND_LEADING_SMALL, MARKERS, MINUTE, MONDAY, MONTH, NO_JUSTIFICATION_MARKER, PADDING_BOTTOM, PADDING_LEFT, PADDING_LEGEND, PADDING_PLOT, PADDING_RIGHT, PADDING_TITLE, PADDING_TOP, PADDING_VLABEL, SATURDAY, SECOND, SUNDAY, THURSDAY, TICK_STROKE, TUESDAY, VERTICAL_SPACING_MARKER, WEDNESDAY, WEEK, YEAR
Constructor and Description |
---|
RrdGraphDef()
Creates RrdGraphDef object and sets default time span (default ending time is 'now',
default starting time is 'end-1day'.
|
Modifier and Type | Method and Description |
---|---|
void |
area(String srcName,
Paint color)
Plots requested data in the form of the filled area starting from zero,
using the color specified.
|
void |
area(String srcName,
Paint color,
String legend)
Plots requested data in the form of the filled area starting from zero,
using the color specified.
|
void |
comment(String text)
Comment to be printed on the graph.
|
void |
datasource(String name,
Plottable plottable)
Creates a new (plottable) datasource.
|
void |
datasource(String name,
String rpnExpression)
Create a new virtual datasource by evaluating a mathematical
expression, specified in Reverse Polish Notation (RPN).
|
void |
datasource(String name,
String sourceName,
double percentile)
Creates a new static virtual datasource that performs a percentile calculation on an
another named datasource to yield a single value.
|
void |
datasource(String name,
String sourceName,
double percentile,
boolean includenan)
Creates a new static virtual datasource that performs a percentile calculation on an
another named datasource to yield a single value.
|
void |
datasource(String name,
String defName,
String consolFun)
Creates a new (static) virtual datasource.
|
void |
datasource(String name,
String rrdPath,
String dsName,
String consolFun)
Defines virtual datasource.
|
void |
datasource(String name,
String rrdPath,
String dsName,
String consolFun,
String backend)
Defines virtual datasource.
|
Font |
getFont(int tag) |
protected Font |
getFontFromResourceName(String name) |
Font |
getLargeFont()
Get the default large font for graphing.
|
String |
getSignature()
Gets the signature string that runs along the right-side of the graph.
|
Font |
getSmallFont()
Get the default small font for graphing.
|
void |
gprint(String srcName,
String consolFun,
String format)
This method does basically the same thing as
print(String, String, String) ,
but the result is printed on the graph itself, below the chart area. |
void |
hrule(double value,
Paint color,
String legend)
Draws a horizontal rule into the graph and optionally adds a legend
|
void |
hrule(double value,
Paint color,
String legend,
float width)
Draws a horizontal rule into the graph and optionally adds a legend
|
void |
line(String srcName,
Paint color,
String legend)
Plots requested data as a line, using the color specified.
|
void |
line(String srcName,
Paint color,
String legend,
float width)
Plots requested data as a line, using the color and the line width specified.
|
void |
print(String srcName,
String consolFun,
String format)
Calculates the chosen consolidation function CF over the given datasource
and creates the result by using the given format string.
|
(package private) int |
printStatementCount() |
void |
setAltAutoscale(boolean altAutoscale)
Computes Y range based on function absolute minimum and maximum
values.
|
void |
setAltAutoscaleMax(boolean altAutoscaleMax)
Computes Y range based on function absolute minimum and maximum
values.
|
void |
setAltYGrid(boolean altYGrid)
Places Y grid dynamically based on graph Y range.
|
void |
setAltYMrtg(boolean altYMrtg)
Use this method to request MRTG-like graph (false by default)
|
void |
setAntiAliasing(boolean antiAliasing)
Controls if the chart area of the image should be antialiased or not.
|
void |
setBackgroundImage(String backgroundImage)
Sets background image - currently, only PNG images can be used as background.
|
void |
setBase(double base)
Sets default base for magnitude scaling.
|
void |
setColor(int colorTag,
Paint color)
Overrides the colors for the standard elements of the graph.
|
void |
setColor(String colorName,
Paint color)
Overrides the colors for the standard elements of the graph by element name.
|
void |
setDrawXGrid(boolean drawXGrid)
Sets visibility of the X-axis grid.
|
void |
setDrawYGrid(boolean drawYGrid)
Sets visibility of the Y-axis grid.
|
void |
setEndTime(long time)
Sets the time when the graph should end.
|
void |
setFilename(String filename)
Sets the name of the graph to generate.
|
void |
setFirstDayOfWeek(int firstDayOfWeek)
Sets first day of the week.
|
void |
setFont(int fontTag,
Font font)
Sets font to be used for a specific font tag.
|
void |
setFont(int fontTag,
Font font,
boolean setAll)
Sets font.
|
void |
setFont(int fontTag,
Font font,
boolean setAll,
boolean keepSizes)
Sets font.
|
void |
setFont(String fontTag,
Font font)
Sets font.
|
void |
setFont(String fontTag,
Font font,
boolean setAll)
Sets font.
|
void |
setFont(String fontTag,
Font font,
boolean setAll,
boolean keepSizes)
Sets font.
|
void |
setForceRulesLegend(boolean forceRulesLegend)
Force the generation of HRULE and VRULE legend even if those HRULE
or VRULE will not be drawn because out of graph boundaries.
|
void |
setHeight(int height)
Sets height of the drawing area within the graph.
|
void |
setImageFormat(String imageFormat)
Sets image format.
|
void |
setImageInfo(String imageInfo)
Creates additional image information.
|
void |
setImageQuality(float imageQuality)
Sets image quality.
|
void |
setInterlaced(boolean interlaced)
Creates interlaced GIF image (currently not supported,
method is present only for RRDTool comaptibility).
|
void |
setLargeFont(Font largeFont)
Sets title font.
|
void |
setLazy(boolean lazy)
Creates graph only if the current graph is out of date or not existent.
|
void |
setLogarithmic(boolean logarithmic)
Sets logarithmic y-axis scaling.
|
void |
setMaxValue(double maxValue)
Defines the value normally located at the upper border of the
graph.
|
void |
setMinValue(double minValue)
Sets the lower limit of a graph.
|
void |
setNoLegend(boolean noLegend)
Suppress generation of legend, only render the graph.
|
void |
setNoMinorGrid(boolean noMinorGrid)
Use this method to turn off minor grid lines (printed by default)
|
void |
setOnlyGraph(boolean onlyGraph)
Suppresses anything but the graph, works only for height < 64.
|
void |
setOverlayImage(String overlayImage)
Sets overlay image - currently, only PNG images can be used as overlay.
|
void |
setPoolUsed(boolean poolUsed)
Sets RrdDbPool usage policy (defaults to true).
|
void |
setRigid(boolean rigid)
Sets rigid boundaries mode.
|
void |
setShowSignature(boolean showSignature)
Shows or hides graph signature (gator) in the top right corner of the graph
|
void |
setSignature(String signature)
Sets the signature string that runs along the right-side of the graph.
|
void |
setSmallFont(Font smallFont)
Sets default font for graphing.
|
void |
setStartTime(long time)
Sets the time when the graph should begin.
|
void |
setStep(long step)
Suggests which time step should be used by JRobin while processing data from RRD files.
|
void |
setTimeAxis(int minorUnit,
int minorUnitCount,
int majorUnit,
int majorUnitCount,
int labelUnit,
int labelUnitCount,
int labelSpan,
String simpleDateFormat)
Configures x-axis grid and labels.
|
void |
setTimeSpan(long[] timestamps)
Sets starting and ending time for the for the graph.
|
void |
setTimeSpan(long startTime,
long endTime)
Sets starting and ending time for the for the graph.
|
void |
setTitle(String title)
Defines a title to be written into the graph.
|
void |
setUnit(String unit)
Sets unit to be displayed on y axis.
|
void |
setUnitsExponent(int unitsExponent)
Sets the 10**unitsExponent scaling of the y-axis values.
|
void |
setUnitsLength(int unitsLength)
Sets the character width on the left side of the graph for
y-axis values.
|
void |
setValueAxis(double gridStep,
int labelFactor)
Sets vertical axis grid and labels.
|
void |
setVerticalLabel(String verticalLabel)
Sets vertical label on the left side of the graph.
|
void |
setWidth(int width)
Sets width of the drawing area within the graph.
|
(package private) boolean |
shouldPlot() |
void |
stack(String srcName,
Paint color,
String legend)
Does the same as
line(String, java.awt.Paint, String) ,
but the graph gets stacked on top of the
previous LINE, AREA or STACK graph. |
void |
vrule(long timestamp,
Paint color,
String legend)
Draws a vertical rule into the graph and optionally adds a legend
|
void |
vrule(long timestamp,
Paint color,
String legend,
float width)
Draws a vertical rule into the graph and optionally adds a legend
|
boolean poolUsed
boolean antiAliasing
String filename
long startTime
long endTime
TimeAxisSetting timeAxisSetting
ValueAxisSetting valueAxisSetting
boolean altYGrid
boolean noMinorGrid
boolean altYMrtg
boolean altAutoscale
boolean altAutoscaleMax
int unitsExponent
int unitsLength
String verticalLabel
int width
int height
boolean interlaced
String imageInfo
String imageFormat
float imageQuality
String backgroundImage
String overlayImage
String unit
String signature
boolean lazy
double minValue
double maxValue
boolean rigid
double base
boolean logarithmic
Paint[] colors
boolean noLegend
boolean onlyGraph
boolean forceRulesLegend
String title
long step
Font[] fonts
boolean drawXGrid
boolean drawYGrid
int firstDayOfWeek
boolean showSignature
File fontDir
List<CommentText> comments
List<PlotElement> plotElements
public RrdGraphDef()
public void setSignature(String signature)
signature
- the string to printpublic String getSignature()
public void setStartTime(long time)
time
- Starting time for the graph in seconds since epochpublic void setEndTime(long time)
time
- Ending time for the graph in seconds since epochpublic void setTimeSpan(long startTime, long endTime)
startTime
- Starting time in seconds since epochendTime
- Ending time in seconds since epochpublic void setTimeSpan(long[] timestamps)
timestamps
- Array of timestamps. The first array item will be chosen for the starting
timestamp. The last array item will be chosen for the ending timestamp.public void setPoolUsed(boolean poolUsed)
RrdDbPool
will be used to
access individual RRD files. If set to false, RRD files will be accessed directly.poolUsed
- true, if RrdDbPool class should be used. False otherwise.public void setFilename(String filename)
filename
- Path to the image filepublic void setTimeAxis(int minorUnit, int minorUnitCount, int majorUnit, int majorUnitCount, int labelUnit, int labelUnitCount, int labelSpan, String simpleDateFormat)
Otherwise, you have to configure three elements making up the x-axis labels and grid. The base grid, the major grid and the labels. The configuration is based on the idea that you first specify a well known amount of time and then say how many times it has to pass between each minor/major grid line or label. For the label you have to define two additional items: The precision of the label in seconds and the format used to generate the text of the label.
For example, if you wanted a graph with a base grid every 10 minutes and a major one every hour, with labels every hour you would use the following x-axis definition.
setTimeAxis(RrdGraphConstants.MINUTE, 10, RrdGraphConstants.HOUR, 1, RrdGraphConstants.HOUR, 1, 0, "%H:%M")
The precision in this example is 0 because the %X format is exact. If the label was the name of the day, we would have had a precision of 24 hours, because when you say something like 'Monday' you mean the whole day and not Monday morning 00:00. Thus the label should be positioned at noon. By defining a precision of 24 hours or rather 86400 seconds, you make sure that this happens.
minorUnit
- Minor grid unit. Minor grid, major grid and label units
can be one of the following constants defined in
RrdGraphConstants
: SECOND
,
MINUTE
, HOUR
,
DAY
, WEEK
,
MONTH
, YEAR
.minorUnitCount
- Number of minor grid units between minor grid lines.majorUnit
- Major grid unit.majorUnitCount
- Number of major grid units between major grid lines.labelUnit
- Label unit.labelUnitCount
- Number of label units between labels.labelSpan
- Label precisionsimpleDateFormat
- Date format (SimpleDateFormat pattern of strftime-like pattern)public void setValueAxis(double gridStep, int labelFactor)
gridStep
- Minor grid steplabelFactor
- Specifies how many minor minor grid steps will appear between labels
(major grid lines)public void setAltYGrid(boolean altYGrid)
altYGrid
- true, if Y grid should be calculated dynamically (defaults to false)public void setNoMinorGrid(boolean noMinorGrid)
noMinorGrid
- true, to turn off, false to turn on (default)public void setAltYMrtg(boolean altYMrtg)
altYMrtg
- true, to create MRTG-like graph, false otherwise (default)public void setAltAutoscale(boolean altAutoscale)
altAutoscale
- true to request alternative autoscaling, false otherwise
(default).public void setAltAutoscaleMax(boolean altAutoscaleMax)
altAutoscaleMax
- true to request alternative autoscaling, false
otherwise (default)public void setUnitsExponent(int unitsExponent)
unitsExponent
- the 10**unitsExponent value for scaling y-axis values.public void setUnitsLength(int unitsLength)
unitsLength
- Number of characters on the left side of the graphs
reserved for vertical axis labels.public void setVerticalLabel(String verticalLabel)
verticalLabel
- Vertical axis labelpublic void setWidth(int width)
width
- Width of the drawing area.public void setHeight(int height)
height
- Height of the drawing area.public void setInterlaced(boolean interlaced)
interlaced
- true, if GIF image should be interlaced.public void setImageInfo(String imageInfo)
print(String, String, String)
function.
The format string is supplied with the following parameters:
filename, xsize and ysize (in that particular order).
For example, in order to generate an IMG tag suitable for including the graph into a web page, the command would look like this:
setImageInfo("<IMG SRC='/img/%s' WIDTH='%d' HEIGHT='%d' ALT='Demo'>");
imageInfo
- Image info format. Use %s placeholder for filename, %d placeholder for
image width and height.public void setImageFormat(String imageFormat)
imageFormat
- "PNG", "GIF" or "JPG".public void setBackgroundImage(String backgroundImage)
backgroundImage
- Path to background imagepublic void setOverlayImage(String overlayImage)
overlayImage
- Path to overlay imagepublic void setUnit(String unit)
unit
- Unit descriptionpublic void setLazy(boolean lazy)
lazy
- true, if graph should be 'lazy', false otherwise (defualt)public void setMinValue(double minValue)
minValue
- Minimal value displayed on the graphpublic void setMaxValue(double maxValue)
If you want to define an upper-limit which will not move in any
event you have to use setRigid(boolean)
method as well.
maxValue
- Maximal value displayed on the graph.public void setRigid(boolean rigid)
true
argument you can disable this behavior.rigid
- true if uper and lower limits should not be expanded to accomodate
values outside of the specified range. False otherwise (default).public void setBase(double base)
base
- Base value (defaults to 1000.0)public void setLogarithmic(boolean logarithmic)
logarithmic
- true, for logarithmic scaling, false otherwise (default).public void setColor(int colorTag, Paint color) throws RrdException
RrdGraphConstants
:
COLOR_BACK
background,
COLOR_CANVAS
canvas,
COLOR_SHADEA
left/top border,
COLOR_SHADEB
right/bottom border,
COLOR_GRID
major grid,
COLOR_MGRID
minor grid,
COLOR_FONT
font,
COLOR_FRAME
axis of the graph,
COLOR_ARROW
arrow. This method can
be called multiple times to set several colors.colorTag
- Color tag, as explained above.color
- Any color (paint) you likeRrdException
- Thrown if invalid colorTag is supplied.public void setColor(String colorName, Paint color) throws RrdException
setColor(int, java.awt.Paint)
for full explanation.colorName
- One of the following strings: "BACK", "CANVAS", "SHADEA", "SHADEB",
"GRID", "MGRID", "FONT", "FRAME", "ARROW"color
- Any color (paint) you likeRrdException
- Thrown if invalid element name is supplied.public void setNoLegend(boolean noLegend)
noLegend
- true if graph legend should be omitted. False otherwise (default).public void setOnlyGraph(boolean onlyGraph)
onlyGraph
- true if only graph should be created, false otherwise (default).public void setForceRulesLegend(boolean forceRulesLegend)
forceRulesLegend
- true if rule legend should be always printed,
false otherwise (default).public void setTitle(String title)
title
- Graph title.public void setStep(long step)
step
- Desired time step (don't use this method if you don't know what you're doing).public Font getSmallFont()
public Font getLargeFont()
public void setSmallFont(Font smallFont) throws RrdException
smallFont
- Default font for graphing. Use only monospaced fonts.RrdException
- Thrown if invalid fontTag is supplied.public void setLargeFont(Font largeFont) throws RrdException
largeFont
- Font to be used for graph title.RrdException
- Thrown if invalid fontTag is supplied.public void setFont(int fontTag, Font font) throws RrdException
RrdGraphConstants
:
FONTTAG_DEFAULT
default font,,
FONTTAG_TITLE
title,
FONTTAG_AXIS
grid axis,,
FONTTAG_UNIT
vertical unit label,,
FONTTAG_LEGEND
legend,
FONTTAG_WATERMARK
watermark.
This method can be called multiple times to set several fonts.fontTag
- Font tag, as explained above.font
- Font to be used for tagRrdException
- Thrown if invalid fontTag is supplied.public void setFont(int fontTag, Font font, boolean setAll) throws RrdException
fontTag
- Font tag, as explained above.font
- Font to be used for tagsetAll
- Boolean to flag whether to set all fonts if fontTag == FONTTAG_DEFAULTRrdException
- Thrown if invalid fontTag is supplied.public void setFont(int fontTag, Font font, boolean setAll, boolean keepSizes)
fontTag
- Font tag, as explained above.font
- Font to be used for tagsetAll
- Boolean to flag whether to set all fonts if fontTag == FONTTAG_DEFAULTkeepSizes
- Boolean to flag whether to keep original font sizes if setting all fonts.public void setFont(String fontTag, Font font) throws RrdException
fontTag
- Font tag as String, as explained in setFont(int, java.awt.Font)
.font
- Font to be used for tagRrdException
- Thrown if invalid fontTag is supplied.public void setFont(String fontTag, Font font, boolean setAll) throws RrdException
fontTag
- Font tag as String, as explained in setFont(int, java.awt.Font)
.font
- Font to be used for tagsetAll
- Boolean to flag whether to set all fonts if fontTag == FONTTAG_DEFAULTRrdException
- Thrown if invalid fontTag is supplied.public void setFont(String fontTag, Font font, boolean setAll, boolean keepSizes) throws RrdException
fontTag
- Font tag as String, as explained in setFont(int, java.awt.Font)
.font
- Font to be used for tagsetAll
- Boolean to flag whether to set all fonts if fontTag == FONTTAG_DEFAULTkeepSizes
- Boolean to flag whether to keep original font sizes if setting all fonts.RrdException
- Thrown if invalid fontTag is supplied.public Font getFont(int tag)
public void datasource(String name, String rrdPath, String dsName, String consolFun)
datasource(String, String)
or
gprint(String, String, String)
.name
- Source namerrdPath
- Path to RRD filedsName
- Datasource name in the specified RRD fileconsolFun
- Consolidation function (AVERAGE, MIN, MAX, LAST)public void datasource(String name, String rrdPath, String dsName, String consolFun, String backend)
datasource(String, String)
or
gprint(String, String, String)
.name
- Source namerrdPath
- Path to RRD filedsName
- Datasource name in the specified RRD fileconsolFun
- Consolidation function (AVERAGE, MIN, MAX, LAST)backend
- Backend to be used while fetching data from a RRD file.public void datasource(String name, String rpnExpression)
name
- Source namerpnExpression
- RPN expression.public void datasource(String name, String defName, String consolFun)
name
- Source namedefName
- Other source nameconsolFun
- Consolidation function to be applied to other datasource.public void datasource(String name, Plottable plottable)
name
- Source name.plottable
- Plottable object.public void datasource(String name, String sourceName, double percentile)
Requires that the other datasource has already been defined otherwise it throws an exception (we need to look at the existing data source to extract the required data)
name
- - the new virtual datasource namesourceName
- - the datasource from which to extract the percentile. Must be a previously
defined virtula datasourcepercentile
- - the percentile to extract from the source datasourcepublic void datasource(String name, String sourceName, double percentile, boolean includenan)
Requires that the other datasource has already been defined otherwise it throws an exception (we need to look at the existing data source to extract the required data)
name
- - the new virtual datasource namesourceName
- - the datasource from which to extract the percentile. Must be a previously
defined virtula datasourcepercentile
- - the percentile to extract from the source datasourceincludenan
- - whether to include NaNs in the percentile calculations.public void print(String srcName, String consolFun, String format)
If an additional '%s' is found AFTER the marker, the value will be scaled and an appropriate SI magnitude unit will be printed in place of the '%s' marker. The scaling will take the '--base' argument into consideration!
If a '%S' is used instead of a '%s', then instead of calculating the appropriate SI magnitude unit for this value, the previously calculated SI magnitude unit will be used. This is useful if you want all the values in a print statement to have the same SI magnitude unit. If there was no previous SI magnitude calculation made, then '%S' behaves like a '%s', unless the value is 0, in which case it does not remember a SI magnitude unit and a SI magnitude unit will only be calculated when the next '%s' is seen or the next '%S' for a non-zero value.
Print results are collected in the RrdGraphInfo
object which is retrieved
from the object
once the graph is created.
srcName
- Virtual source nameconsolFun
- Consolidation function to be applied to the sourceformat
- Format string (like "average = %10.3f %s")public void gprint(String srcName, String consolFun, String format)
print(String, String, String)
,
but the result is printed on the graph itself, below the chart area.srcName
- Virtual source nameconsolFun
- Consolidation function to be applied to the sourceformat
- Format string (like "average = %10.3f %s")public void comment(String text)
text
- Comment textpublic void hrule(double value, Paint color, String legend)
value
- Position of the rulecolor
- Rule colorlegend
- Legend text. If null, legend text will be omitted.public void hrule(double value, Paint color, String legend, float width)
value
- Position of the rulecolor
- Rule colorlegend
- Legend text. If null, legend text will be omitted.width
- Rule widthpublic void vrule(long timestamp, Paint color, String legend)
timestamp
- Position of the rule (seconds since epoch)color
- Rule colorlegend
- Legend text. Use null to omit the text.public void vrule(long timestamp, Paint color, String legend, float width)
timestamp
- Position of the rule (seconds since epoch)color
- Rule colorlegend
- Legend text. Use null to omit the text.width
- Rule widthpublic void line(String srcName, Paint color, String legend, float width)
srcName
- Virtual source namecolor
- Line colorlegend
- Legend textwidth
- Line width (default: 1.0F)public void line(String srcName, Paint color, String legend)
srcName
- Virtual source namecolor
- Line colorlegend
- Legend textpublic void area(String srcName, Paint color, String legend)
srcName
- Virtual source name.color
- Color of the filled area.legend
- Legend text.public void area(String srcName, Paint color)
srcName
- Virtual source name.color
- Color of the filled area.public void stack(String srcName, Paint color, String legend) throws RrdException
line(String, java.awt.Paint, String)
,
but the graph gets stacked on top of the
previous LINE, AREA or STACK graph. Depending on the type of the
previous graph, the STACK will be either a LINE or an AREA. This
obviously implies that the first STACK must be preceded by an AREA
or LINE.
Note, that when you STACK onto *UNKNOWN* data, JRobin will not draw any graphics ... *UNKNOWN* is not zero.
srcName
- Virtual source namecolor
- Stacked graph colorlegend
- Legend textRrdException
- Thrown if this STACK has no previously defined AREA, STACK or LINE
graph bellow it.public void setDrawXGrid(boolean drawXGrid)
drawXGrid
- True if X-axis grid should be created (default), false otherwise.public void setDrawYGrid(boolean drawYGrid)
drawYGrid
- True if Y-axis grid should be created (default), false otherwise.public void setImageQuality(float imageQuality)
imageQuality
- (0F=worst, 1F=best).public void setAntiAliasing(boolean antiAliasing)
antiAliasing
- use true to turn antialiasing on, false to turn it off (default)public void setShowSignature(boolean showSignature)
showSignature
- true, if signature should be seen (default), false otherwisepublic void setFirstDayOfWeek(int firstDayOfWeek)
int printStatementCount()
boolean shouldPlot()