org.jrobin.graph

Class RrdGraphDef

public class RrdGraphDef extends Object implements RrdGraphConstants

Class which should be used to define new JRobin graph. Once constructed and populated with data object of this class should be passed to the constructor of the 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.

Field Summary
protected FontlargeFont
protected FontsmallFont
Constructor Summary
RrdGraphDef()
Creates RrdGraphDef object and sets default time span (default ending time is 'now', default starting time is 'end-1day'.
Method Summary
voidarea(String srcName, Paint color, String legend)
Plots requested data in the form of the filled area starting from zero, using the color specified.
voidarea(String srcName, Paint color)
Plots requested data in the form of the filled area starting from zero, using the color specified.
voidcomment(String text)
Comment to be printed on the graph.
voiddatasource(String name, String rrdPath, String dsName, String consolFun)
Defines virtual datasource.
voiddatasource(String name, String rrdPath, String dsName, String consolFun, String backend)
Defines virtual datasource.
voiddatasource(String name, String rpnExpression)
Create a new virtual datasource by evaluating a mathematical expression, specified in Reverse Polish Notation (RPN).
voiddatasource(String name, String defName, String consolFun)
Creates a new (static) virtual datasource.
voiddatasource(String name, Plottable plottable)
Creates a new (plottable) datasource.
protected FontgetFontFromResourceName(String name)
FontgetLargeFont()
Get the default large font for graphing.
StringgetSignature()
Gets the signature string that runs along the right-side of the graph.
FontgetSmallFont()
Get the default small font for graphing.
voidgprint(String srcName, String consolFun, String format)
This method does basically the same thing as RrdGraphDef, but the result is printed on the graph itself, below the chart area.
voidhrule(double value, Paint color, String legend)
Draws a horizontal rule into the graph and optionally adds a legend
voidhrule(double value, Paint color, String legend, float width)
Draws a horizontal rule into the graph and optionally adds a legend
voidline(String srcName, Paint color, String legend, float width)
Plots requested data as a line, using the color and the line width specified.
voidline(String srcName, Paint color, String legend)
Plots requested data as a line, using the color specified.
voidprint(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.
voidsetAltAutoscale(boolean altAutoscale)
Computes Y range based on function absolute minimum and maximum values.
voidsetAltAutoscaleMax(boolean altAutoscaleMax)
Computes Y range based on function absolute minimum and maximum values.
voidsetAltYGrid(boolean altYGrid)
Places Y grid dynamically based on graph Y range.
voidsetAltYMrtg(boolean altYMrtg)
Use this method to request MRTG-like graph (false by default)
voidsetAntiAliasing(boolean antiAliasing)
Controls if the chart area of the image should be antialiased or not.
voidsetBackgroundImage(String backgroundImage)
Sets background image - currently, only PNG images can be used as background.
voidsetBase(double base)
Sets default base for magnitude scaling.
voidsetColor(int colorTag, Paint color)
Overrides the colors for the standard elements of the graph.
voidsetColor(String colorName, Paint color)
Overrides the colors for the standard elements of the graph by element name.
voidsetDrawXGrid(boolean drawXGrid)
Sets visibility of the X-axis grid.
voidsetDrawYGrid(boolean drawYGrid)
Sets visibility of the Y-axis grid.
voidsetEndTime(long time)
Sets the time when the graph should end.
voidsetFilename(String filename)
Sets the name of the graph to generate.
voidsetFirstDayOfWeek(int firstDayOfWeek)
Sets first day of the week.
voidsetForceRulesLegend(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.
voidsetHeight(int height)
Sets height of the drawing area within the graph.
voidsetImageFormat(String imageFormat)
Sets image format.
voidsetImageInfo(String imageInfo)
Creates additional image information.
voidsetImageQuality(float imageQuality)
Sets image quality.
voidsetInterlaced(boolean interlaced)
Creates interlaced GIF image (currently not supported, method is present only for RRDTool comaptibility).
voidsetLargeFont(Font largeFont)
Sets title font.
voidsetLazy(boolean lazy)
Creates graph only if the current graph is out of date or not existent.
voidsetLogarithmic(boolean logarithmic)
Sets logarithmic y-axis scaling.
voidsetMaxValue(double maxValue)
Defines the value normally located at the upper border of the graph.
voidsetMinValue(double minValue)
Sets the lower limit of a graph.
voidsetNoLegend(boolean noLegend)
Suppress generation of legend, only render the graph.
voidsetNoMinorGrid(boolean noMinorGrid)
Use this method to turn off minor grid lines (printed by default)
voidsetOnlyGraph(boolean onlyGraph)
Suppresses anything but the graph, works only for height < 64.
voidsetOverlayImage(String overlayImage)
Sets overlay image - currently, only PNG images can be used as overlay.
voidsetPoolUsed(boolean poolUsed)
Sets RrdDbPool usage policy (defaults to true).
voidsetRigid(boolean rigid)
Sets rigid boundaries mode.
voidsetShowSignature(boolean showSignature)
Shows or hides graph signature (gator) in the top right corner of the graph
voidsetSignature(String signature)
Sets the signature string that runs along the right-side of the graph.
voidsetSmallFont(Font smallFont)
Sets default font for graphing.
voidsetStartTime(long time)
Sets the time when the graph should begin.
voidsetStep(long step)
Suggests which time step should be used by JRobin while processing data from RRD files.
voidsetTimeAxis(int minorUnit, int minorUnitCount, int majorUnit, int majorUnitCount, int labelUnit, int labelUnitCount, int labelSpan, String simpleDateFormat)
Configures x-axis grid and labels.
voidsetTimeSpan(long startTime, long endTime)
Sets starting and ending time for the for the graph.
voidsetTimeSpan(long[] timestamps)
Sets starting and ending time for the for the graph.
voidsetTitle(String title)
Defines a title to be written into the graph.
voidsetUnit(String unit)
Sets unit to be displayed on y axis.
voidsetUnitsExponent(int unitsExponent)
Sets the 10**unitsExponent scaling of the y-axis values.
voidsetUnitsLength(int unitsLength)
Sets the character width on the left side of the graph for y-axis values.
voidsetValueAxis(double gridStep, int labelFactor)
Sets vertical axis grid and labels.
voidsetVerticalLabel(String verticalLabel)
Sets vertical label on the left side of the graph.
voidsetWidth(int width)
Sets width of the drawing area within the graph.
voidstack(String srcName, Paint color, String legend)
Does the same as RrdGraphDef, but the graph gets stacked on top of the previous LINE, AREA or STACK graph.
voidvrule(long timestamp, Paint color, String legend)
Draws a vertical rule into the graph and optionally adds a legend
voidvrule(long timestamp, Paint color, String legend, float width)
Draws a vertical rule into the graph and optionally adds a legend

Field Detail

largeFont

protected Font largeFont

smallFont

protected Font smallFont

Constructor Detail

RrdGraphDef

public RrdGraphDef()
Creates RrdGraphDef object and sets default time span (default ending time is 'now', default starting time is 'end-1day'.

Method Detail

area

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

Parameters: srcName Virtual source name. color Color of the filled area. legend Legend text.

area

public void area(String srcName, Paint color)
Plots requested data in the form of the filled area starting from zero, using the color specified.

Parameters: srcName Virtual source name. color Color of the filled area.

comment

public void comment(String text)
Comment to be printed on the graph.

Parameters: text Comment text

datasource

public void datasource(String name, String rrdPath, String dsName, String consolFun)
Defines virtual datasource. This datasource can then be used in other methods like RrdGraphDef or RrdGraphDef.

Parameters: name Source name rrdPath Path to RRD file dsName Datasource name in the specified RRD file consolFun Consolidation function (AVERAGE, MIN, MAX, LAST)

datasource

public void datasource(String name, String rrdPath, String dsName, String consolFun, String backend)
Defines virtual datasource. This datasource can then be used in other methods like RrdGraphDef or RrdGraphDef.

Parameters: name Source name rrdPath Path to RRD file dsName Datasource name in the specified RRD file consolFun Consolidation function (AVERAGE, MIN, MAX, LAST) backend Backend to be used while fetching data from a RRD file.

datasource

public void datasource(String name, String rpnExpression)
Create a new virtual datasource by evaluating a mathematical expression, specified in Reverse Polish Notation (RPN).

Parameters: name Source name rpnExpression RPN expression.

datasource

public void datasource(String name, String defName, String consolFun)
Creates a new (static) virtual datasource. The value of the datasource is constant. This value is evaluated by applying the given consolidation function to another virtual datasource.

Parameters: name Source name defName Other source name consolFun Consolidation function to be applied to other datasource.

datasource

public void datasource(String name, Plottable plottable)
Creates a new (plottable) datasource. Datasource values are obtained from the given plottable object.

Parameters: name Source name. plottable Plottable object.

getFontFromResourceName

protected Font getFontFromResourceName(String name)

getLargeFont

public Font getLargeFont()
Get the default large font for graphing.

Returns: the font

getSignature

public String getSignature()
Gets the signature string that runs along the right-side of the graph.

Returns: the signature string

getSmallFont

public Font getSmallFont()
Get the default small font for graphing.

Returns: the font

gprint

public void gprint(String srcName, String consolFun, String format)
This method does basically the same thing as RrdGraphDef, but the result is printed on the graph itself, below the chart area.

Parameters: srcName Virtual source name consolFun Consolidation function to be applied to the source format Format string (like "average = %10.3f %s")

hrule

public void hrule(double value, Paint color, String legend)
Draws a horizontal rule into the graph and optionally adds a legend

Parameters: value Position of the rule color Rule color legend Legend text. If null, legend text will be omitted.

hrule

public void hrule(double value, Paint color, String legend, float width)
Draws a horizontal rule into the graph and optionally adds a legend

Parameters: value Position of the rule color Rule color legend Legend text. If null, legend text will be omitted. width Rule width

line

public void line(String srcName, Paint color, String legend, float width)
Plots requested data as a line, using the color and the line width specified.

Parameters: srcName Virtual source name color Line color legend Legend text width Line width (default: 1.0F)

line

public void line(String srcName, Paint color, String legend)
Plots requested data as a line, using the color specified. Line width is assumed to be 1.0F.

Parameters: srcName Virtual source name color Line color legend Legend text

print

public 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. In the format string there should be a '%[l]f', '%[l]g' or '%[l]e' marker in the place where the number should be printed.

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.

Parameters: srcName Virtual source name consolFun Consolidation function to be applied to the source format Format string (like "average = %10.3f %s")

setAltAutoscale

public void setAltAutoscale(boolean altAutoscale)
Computes Y range based on function absolute minimum and maximum values. Default algorithm uses predefined set of ranges. This is good in many cases but it fails miserably when you need to graph something like 260 + 0.001 * sin(x). Default algorithm will use Y range from 250 to 300 and on the graph you will see almost straight line. With --alt-autoscale Y range will be from slightly less the 260 - 0.001 to slightly more then 260 + 0.001 and periodic behavior will be seen.

Parameters: altAutoscale true to request alternative autoscaling, false otherwise (default).

setAltAutoscaleMax

public void setAltAutoscaleMax(boolean altAutoscaleMax)
Computes Y range based on function absolute minimum and maximum values. Where setAltAutoscale(true) will modify both the absolute maximum AND minimum values, this option will only affect the maximum value. The minimum value, if not defined elsewhere, will be 0. This option can be useful when graphing router traffic when the WAN line uses compression, and thus the throughput may be higher than the WAN line speed.

Parameters: altAutoscaleMax true to request alternative autoscaling, false otherwise (default)

setAltYGrid

public void setAltYGrid(boolean altYGrid)
Places Y grid dynamically based on graph Y range. Algorithm ensures that you always have grid, that there are enough but not too many grid lines and the grid is metric. That is grid lines are placed every 1, 2, 5 or 10 units.

Parameters: altYGrid true, if Y grid should be calculated dynamically (defaults to false)

setAltYMrtg

public void setAltYMrtg(boolean altYMrtg)
Use this method to request MRTG-like graph (false by default)

Parameters: altYMrtg true, to create MRTG-like graph, false otherwise (default)

setAntiAliasing

public void setAntiAliasing(boolean antiAliasing)
Controls if the chart area of the image should be antialiased or not.

Parameters: antiAliasing use true to turn antialiasing on, false to turn it off (default)

setBackgroundImage

public void setBackgroundImage(String backgroundImage)
Sets background image - currently, only PNG images can be used as background.

Parameters: backgroundImage Path to background image

setBase

public void setBase(double base)
Sets default base for magnitude scaling. If you are graphing memory (and NOT network traffic) this switch should be set to 1024 so that 1Kb is 1024 byte. For traffic measurement, 1 kb/s is 1000 b/s.

Parameters: base Base value (defaults to 1000.0)

setColor

public void setColor(int colorTag, Paint color)
Overrides the colors for the standard elements of the graph. The colorTag must be one of the following constants defined in the 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.

Parameters: colorTag Color tag, as explained above. color Any color (paint) you like

Throws: RrdException Thrown if invalid colorTag is supplied.

setColor

public void setColor(String colorName, Paint color)
Overrides the colors for the standard elements of the graph by element name. See RrdGraphDef for full explanation.

Parameters: colorName One of the following strings: "BACK", "CANVAS", "SHADEA", "SHADEB", "GRID", "MGRID", "FONT", "FRAME", "ARROW" color Any color (paint) you like

Throws: RrdException Thrown if invalid element name is supplied.

setDrawXGrid

public void setDrawXGrid(boolean drawXGrid)
Sets visibility of the X-axis grid.

Parameters: drawXGrid True if X-axis grid should be created (default), false otherwise.

setDrawYGrid

public void setDrawYGrid(boolean drawYGrid)
Sets visibility of the Y-axis grid.

Parameters: drawYGrid True if Y-axis grid should be created (default), false otherwise.

setEndTime

public void setEndTime(long time)
Sets the time when the graph should end. Time in seconds since epoch (1970-01-01) is required. Negative numbers are relative to the current time.

Parameters: time Ending time for the graph in seconds since epoch

setFilename

public void setFilename(String filename)
Sets the name of the graph to generate. Since JRobin outputs GIFs, PNGs, and JPEGs it's recommended that the filename end in either .gif, .png or .jpg. JRobin does not enforce this, however. If the filename is set to '-' the image will be created only in memory (no file will be created). PNG and GIF formats are recommended but JPEGs should be avoided.

Parameters: filename Path to the image file

setFirstDayOfWeek

public void setFirstDayOfWeek(int firstDayOfWeek)
Sets first day of the week.

Parameters: firstDayOfWeek One of the following constants: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY

setForceRulesLegend

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

Parameters: forceRulesLegend true if rule legend should be always printed, false otherwise (default).

setHeight

public void setHeight(int height)
Sets height of the drawing area within the graph. This affects the total size of the image.

Parameters: height Height of the drawing area.

setImageFormat

public void setImageFormat(String imageFormat)
Sets image format.

Parameters: imageFormat "PNG", "GIF" or "JPG".

setImageInfo

public void setImageInfo(String imageInfo)
Creates additional image information. After the image has been created, the graph function uses imageInfo format string (printf-like) to create output similar to the RrdGraphDef 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'>");
 

Parameters: imageInfo Image info format. Use %s placeholder for filename, %d placeholder for image width and height.

setImageQuality

public void setImageQuality(float imageQuality)
Sets image quality. Relevant only for JPEG images.

Parameters: imageQuality (0F=worst, 1F=best).

setInterlaced

public void setInterlaced(boolean interlaced)
Creates interlaced GIF image (currently not supported, method is present only for RRDTool comaptibility).

Parameters: interlaced true, if GIF image should be interlaced.

setLargeFont

public void setLargeFont(Font largeFont)
Sets title font.

Parameters: largeFont Font to be used for graph title.

setLazy

public void setLazy(boolean lazy)
Creates graph only if the current graph is out of date or not existent.

Parameters: lazy true, if graph should be 'lazy', false otherwise (defualt)

setLogarithmic

public void setLogarithmic(boolean logarithmic)
Sets logarithmic y-axis scaling.

Parameters: logarithmic true, for logarithmic scaling, false otherwise (default).

setMaxValue

public void setMaxValue(double maxValue)
Defines the value normally located at the upper border of the graph. If the graph contains higher values, the upper border will move upwards to accommodate these values as well.

If you want to define an upper-limit which will not move in any event you have to use RrdGraphDef method as well.

Parameters: maxValue Maximal value displayed on the graph.

setMinValue

public void setMinValue(double minValue)
Sets the lower limit of a graph. But rather, this is the maximum lower bound of a graph. For example, the value -100 will result in a graph that has a lower limit of -100 or less. Use this method to expand graphs down.

Parameters: minValue Minimal value displayed on the graph

setNoLegend

public void setNoLegend(boolean noLegend)
Suppress generation of legend, only render the graph.

Parameters: noLegend true if graph legend should be omitted. False otherwise (default).

setNoMinorGrid

public void setNoMinorGrid(boolean noMinorGrid)
Use this method to turn off minor grid lines (printed by default)

Parameters: noMinorGrid true, to turn off, false to turn on (default)

setOnlyGraph

public void setOnlyGraph(boolean onlyGraph)
Suppresses anything but the graph, works only for height < 64.

Parameters: onlyGraph true if only graph should be created, false otherwise (default).

setOverlayImage

public void setOverlayImage(String overlayImage)
Sets overlay image - currently, only PNG images can be used as overlay. Overlay image is printed on the top of the image, once it is completely created.

Parameters: overlayImage Path to overlay image

setPoolUsed

public void setPoolUsed(boolean poolUsed)
Sets RrdDbPool usage policy (defaults to true). If set to true, RrdDbPool will be used to access individual RRD files. If set to false, RRD files will be accessed directly.

Parameters: poolUsed true, if RrdDbPool class should be used. False otherwise.

setRigid

public void setRigid(boolean rigid)
Sets rigid boundaries mode. Normally JRObin will automatically expand the lower and upper limit if the graph contains a value outside the valid range. With the true argument you can disable this behavior.

Parameters: rigid true if uper and lower limits should not be expanded to accomodate values outside of the specified range. False otherwise (default).

setShowSignature

public void setShowSignature(boolean showSignature)
Shows or hides graph signature (gator) in the top right corner of the graph

Parameters: showSignature true, if signature should be seen (default), false otherwise

setSignature

public void setSignature(String signature)
Sets the signature string that runs along the right-side of the graph. Defaults to "Created with JRobin".

Parameters: signature the string to print

setSmallFont

public void setSmallFont(Font smallFont)
Sets default font for graphing. Note that JRobin will behave unpredictably if proportional font is selected.

Parameters: smallFont Default font for graphing. Use only monospaced fonts.

setStartTime

public void setStartTime(long time)
Sets the time when the graph should begin. Time in seconds since epoch (1970-01-01) is required. Negative numbers are relative to the current time.

Parameters: time Starting time for the graph in seconds since epoch

setStep

public void setStep(long step)
Suggests which time step should be used by JRobin while processing data from RRD files.

Parameters: step Desired time step (don't use this method if you don't know what you're doing).

setTimeAxis

public void setTimeAxis(int minorUnit, int minorUnitCount, int majorUnit, int majorUnitCount, int labelUnit, int labelUnitCount, int labelSpan, String simpleDateFormat)
Configures x-axis grid and labels. The x-axis label is quite complex to configure. So if you don't have very special needs, you can rely on the autoconfiguration to get this right.

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.

Parameters: 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 precision simpleDateFormat Date format (SimpleDateFormat pattern of strftime-like pattern)

setTimeSpan

public void setTimeSpan(long startTime, long endTime)
Sets starting and ending time for the for the graph. Timestamps in seconds since epoch are required. Negative numbers are relative to the current time.

Parameters: startTime Starting time in seconds since epoch endTime Ending time in seconds since epoch

setTimeSpan

public void setTimeSpan(long[] timestamps)
Sets starting and ending time for the for the graph. Timestamps in seconds since epoch are required.

Parameters: 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.

setTitle

public void setTitle(String title)
Defines a title to be written into the graph.

Parameters: title Graph title.

setUnit

public void setUnit(String unit)
Sets unit to be displayed on y axis. It is wise to use only short units on graph, however.

Parameters: unit Unit description

setUnitsExponent

public void setUnitsExponent(int unitsExponent)
Sets the 10**unitsExponent scaling of the y-axis values. Normally values will be scaled to the appropriate units (k, M, etc.). However you may wish to display units always in k (Kilo, 10e3) even if the data is in the M (Mega, 10e6) range for instance. Value should be an integer which is a multiple of 3 between -18 and 18, inclu- sive. It is the exponent on the units you which to use. For example, use 3 to display the y-axis values in k (Kilo, 10e3, thou- sands), use -6 to display the y-axis values in u (Micro, 10e-6, millionths). Use a value of 0 to prevent any scaling of the y-axis values.

Parameters: unitsExponent

setUnitsLength

public void setUnitsLength(int unitsLength)
Sets the character width on the left side of the graph for y-axis values.

Parameters: unitsLength Number of characters on the left side of the graphs reserved for vertical axis labels.

setValueAxis

public void setValueAxis(double gridStep, int labelFactor)
Sets vertical axis grid and labels. Makes vertical grid lines appear at gridStep interval. Every labelFactor*gridStep, a major grid line is printed, along with label showing the value of the grid line.

Parameters: gridStep Minor grid step labelFactor Specifies how many minor minor grid steps will appear between labels (major grid lines)

setVerticalLabel

public void setVerticalLabel(String verticalLabel)
Sets vertical label on the left side of the graph. This is normally used to specify the units used.

Parameters: verticalLabel Vertical axis label

setWidth

public void setWidth(int width)
Sets width of the drawing area within the graph. This affects the total size of the image.

Parameters: width Width of the drawing area.

stack

public void stack(String srcName, Paint color, String legend)
Does the same as RrdGraphDef, 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.

Parameters: srcName Virtual source name color Stacked graph color legend Legend text

Throws: RrdException Thrown if this STACK has no previously defined AREA, STACK or LINE graph bellow it.

vrule

public void vrule(long timestamp, Paint color, String legend)
Draws a vertical rule into the graph and optionally adds a legend

Parameters: timestamp Position of the rule (seconds since epoch) color Rule color legend Legend text. Use null to omit the text.

vrule

public void vrule(long timestamp, Paint color, String legend, float width)
Draws a vertical rule into the graph and optionally adds a legend

Parameters: timestamp Position of the rule (seconds since epoch) color Rule color legend Legend text. Use null to omit the text. width Rule width