Class RrdGraphDef
- All Implemented Interfaces:
DataHolder
,RrdGraphConstants
Class which should be used to define new Rrd4j 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.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
Implementations of this class can be used to generate image than can be layered on graph.Nested classes/interfaces inherited from interface org.rrd4j.graph.RrdGraphConstants
RrdGraphConstants.FontConstructor, RrdGraphConstants.FontTag
-
Field Summary
Modifier and TypeFieldDescription(package private) boolean
(package private) boolean
(package private) boolean
(package private) boolean
(package private) boolean
(package private) boolean
(package private) RrdGraphDef.ImageSource
(package private) double
(package private) RrdGraphDef.ImageSource
(package private) final List<CommentText>
(package private) DownSampler
(package private) boolean
(package private) boolean
(package private) long
(package private) String
(package private) int
(package private) Font[]
(package private) boolean
(package private) Stroke
(package private) int
(package private) String
(package private) String
(package private) float
(package private) boolean
(package private) boolean
(package private) Locale
(package private) boolean
(package private) double
(package private) double
(package private) boolean
(package private) boolean
(package private) boolean
(package private) RrdGraphDef.ImageSource
(package private) final List<PlotElement>
(package private) boolean
(package private) boolean
(package private) boolean
(package private) String
(package private) long
(package private) long
(package private) boolean
(package private) Stroke
(package private) TimeAxisSetting
(package private) TimeLabelFormat
(package private) String
(package private) TimeZone
(package private) String
(package private) int
(package private) int
(package private) ValueAxisSetting
(package private) String
(package private) int
Fields inherited from interface org.rrd4j.core.DataHolder
DEFAULT_POOL_USAGE_POLICY
Fields inherited from interface org.rrd4j.graph.RrdGraphConstants
ALIGN_CENTER_MARKER, ALIGN_JUSTIFIED_MARKER, ALIGN_LEFT_MARKER, ALIGN_LEFTNONL_MARKER, ALIGN_RIGHT_MARKER, BLIND_COLOR, COLOR_ARROW, COLOR_BACK, COLOR_CANVAS, COLOR_FONT, COLOR_FRAME, COLOR_GRID, COLOR_MGRID, COLOR_SHADEA, COLOR_SHADEB, COLOR_XAXIS, COLOR_YAXIS, DAY, DEFAULT_ARROW_COLOR, DEFAULT_BACK_COLOR, DEFAULT_BASE, DEFAULT_CANVAS_COLOR, DEFAULT_END, DEFAULT_FONT_COLOR, DEFAULT_FRAME_COLOR, DEFAULT_GRID_COLOR, DEFAULT_HEIGHT, DEFAULT_IMAGE_FORMAT, DEFAULT_IMAGE_QUALITY, DEFAULT_LARGE_FONT, DEFAULT_MGRID_COLOR, DEFAULT_SHADEA_COLOR, DEFAULT_SHADEB_COLOR, DEFAULT_SMALL_FONT, DEFAULT_START, DEFAULT_UNITS_LENGTH, DEFAULT_WIDTH, DEFAULT_XAXIS_COLOR, DEFAULT_YAXIS_COLOR, FIRST_DAY_OF_WEEK, FONTTAG_AXIS, FONTTAG_DEFAULT, FONTTAG_LEGEND, FONTTAG_TITLE, FONTTAG_UNIT, FONTTAG_WATERMARK, FRIDAY, GATOR_FONT, GLUE_MARKER, GRID_STROKE, HH_MM, HOUR, IN_MEMORY_IMAGE, LEGEND_BOX, LEGEND_BOX_SPACE, LEGEND_INTERSPACING, LEGEND_LEADING, LEGEND_LEADING_SMALL, MINUTE, MONDAY, MONTH, NO_JUSTIFICATION_MARKER, PADDING_BOTTOM, PADDING_LEFT, PADDING_LEGEND, PADDING_PLOT, PADDING_RIGHT, PADDING_TITLE, PADDING_TOP, PADDING_VLABEL, PROPERTYFONTBOLD, PROPERTYFONTBOLDURL, PROPERTYFONTPLAIN, PROPERTYFONTPLAINURL, PROPERTYFONTSPROPERTIES, PROPERTYFONTSURL, SATURDAY, SECOND, SUNDAY, THURSDAY, TICK_STROKE, TUESDAY, VERTICAL_SPACING_MARKER, WEDNESDAY, WEEK, YEAR
-
Constructor Summary
ConstructorDescriptionDeprecated.Uses default value that will be probably overriden.RrdGraphDef
(long t1, long t2) Creates RrdGraphDef object.RrdGraphDef
(java.time.temporal.TemporalAmount d) Creates new DataProcessor object for the given time duration. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Add a area like any other but with a constant value, it can be stacked like any other areavoid
Plots requested data in the form of the filled area starting from zero, using the color specified.void
Plots requested data in the form of the filled area starting from zero, using the color specified.void
Plots requested data in the form of the filled area starting from zero, using the color specified.void
Comment to be printed on the graph.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 rrdPath, String dsName, ConsolFun consolFun) Defines virtual datasource.void
Deprecated.void
datasource
(String name, String rrdPath, String dsName, ConsolFun consolFun, RrdBackendFactory backend) Defines virtual datasource.void
datasource
(String name, String defName, ConsolFun consolFun) Deprecated.UseVariable
based method instead.void
datasource
(String name, String dsName, FetchData fetchData) Creates a new 'fetched' datasource.void
datasource
(String name, String defName, Variable var) Creates a datasource that performs a variable calculation on an another named datasource to yield a single combined timestamp/value.void
datasource
(String name, URI rrdUri, String dsName, ConsolFun consolFun) Defines virtual datasource.void
datasource
(String name, URI rrdUri, String dsName, ConsolFun consolFun, RrdBackendFactory backend) Defines virtual datasource.void
datasource
(String name, FetchData fetchData) Creates a new 'fetched' datasource.void
datasource
(String name, IPlottable plottable) Creates a new (plottable) datasource.(package private) Paint
getColor
(ElementsNames element) long
Returns ending timestamp.getPool()
Gets the signature string that runs along the right-side of the graph.long
Returns starting timestamp.long
getStep()
Returns the time step used for timestamp interval.void
Read the value of a variable (VDEF) and prints the value by using the given format string.void
Read the value of a variable (VDEF) and prints the the value or the time stamp, according to the strftime flag by using the given format string.void
Deprecated.UseVariable
based method instead.void
Draws a horizontal rule into the graph.void
Draws a horizontal rule into the graph and optionally adds a legend.void
Draws a horizontal rule into the graph and optionally adds a legend.void
hrule
(double value, Paint color, String legend, BasicStroke stroke) Draws a horizontal rule into the graph and optionally adds a legend.void
Draws a horizontal span into the graph.void
Draws a horizontal span into the graph and optionally adds a legend.boolean
Returns boolean value representingRrdDbPool
usage policy.void
Define a line like any other but with constant value, it can be stackedvoid
line
(double value, Paint color, BasicStroke stroke, boolean stack) Define a line like any other but with constant value, it can be stackedvoid
Plots requested data as a line, using the color specified.void
Plots requested data as a line, using the color and the line width specified.void
Plots requested data as a line, using the color specified.void
Plots requested data as a line, using the color and the line width specified.void
Plots requested data as a line, using the color and the line width specified.void
line
(String srcName, Paint color, String legend, BasicStroke stroke, boolean stack) Plots requested data as a line, using the color and theBasicStroke
specified.void
percentile
(String name, String defName) Deprecated.UseVariable
based method instead.void
percentile
(String name, String defName, double percent) Deprecated.UseVariable
based method instead.void
Read the value of a variable (VDEF) and prints the value by using the given format string.void
Read the value of a variable (VDEF) and prints the the value or the time stamp, according to the strftime flag by using the given format string.void
Deprecated.UseVariable
based method instead.(package private) int
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
setAltAutoscaleMin
(boolean altAutoscaleMin) 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.void
setBackgroundImage
(URL backgroundImageUrl) Sets background image.void
setBackgroundImage
(RrdGraphDef.ImageSource backgroundImage) Sets background image.void
setBase
(double base) Sets default base for magnitude scaling.void
setCanvasImage
(String canvasImage) Sets canvas background image.void
setCanvasImage
(URL canvasUrl) Sets canvas background image.void
setCanvasImage
(RrdGraphDef.ImageSource canvasImageSource) Sets canvas background image.void
Deprecated.void
Deprecated.void
setColor
(ElementsNames colorTag, Paint color) Overrides the colors for the standard elements of the graph.void
setDownsampler
(DownSampler downsampler) Allows to set a downsampler, used to improved the visual representation of graph.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
Sets font.void
Sets font.void
Sets font.void
setFont
(RrdGraphConstants.FontTag fontTag, Font font) Sets font to be used for a specific font tag.void
setFont
(RrdGraphConstants.FontTag fontTag, Font font, boolean setAll) Sets font.void
setFont
(RrdGraphConstants.FontTag fontTag, Font font, boolean setAll, boolean keepSizes) Sets font.void
setFontSet
(boolean rrdtool) This method reset the font set to it's default values.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
setGridStroke
(Stroke gridStroke) Set the Stroke used to draw gridvoid
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 or progressive mode image.void
setLargeFont
(Font largeFont) Deprecated.UseRrdGraphConstants.FontTag
based method instead.void
setLazy
(boolean lazy) Creates graph only if the current graph is out of date or not existent.void
Set the locale used for the legend.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.void
setOverlayImage
(URL overlayImage) Sets overlay image.void
setOverlayImage
(RrdGraphDef.ImageSource overlayImageSource) Sets overlay image.void
Defines theRrdDbPool
to use.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 graphvoid
setSignature
(String signature) Sets the signature string that runs along the right-side of the graph.void
setSmallFont
(Font smallFont) Deprecated.UseRrdGraphConstants.FontTag
based method instead.void
setStartTime
(long time) Sets the time when the graph should begin.void
setStep
(long step) Suggests which time step should be used by Rrd4j while processing data from RRD files.void
setTextAntiAliasing
(boolean textAntiAliasing) Controls if the text should be antialiased or not.void
setTickStroke
(Stroke tickStroke) Set the stroke used to draw ticksvoid
setTimeAxis
(int minorUnit, int minorUnitCount, int majorUnit, int majorUnitCount, int labelUnit, int labelUnitCount, int labelSpan, String simpleDateFormat) Configures x-axis grid and labels.void
setTimeAxis
(int minorUnit, int minorUnitCount, int majorUnit, int majorUnitCount, int labelUnit, int labelUnitCount, int labelSpan, TimeLabelFormat format) It configure the x-axis grid in the same way thansetTimeAxis(int, int, int, int, int, int, int, String)
, but it allows to use aTimeLabelFormat
to format the date label.void
setTimeLabelFormat
(TimeLabelFormat format) This allows to keep the default major and minor grid unit, but with changing only the label formatting, using aTimeLabelFormat
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
setTimeZone
(TimeZone tz) Set the time zone used for the legend.void
Defines a title to be written into the graph.void
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
void
Does the same asline(String, java.awt.Paint)
, but the graph gets stacked on top of the previous LINE, AREA or STACK graph.void
Does the same asline(String, java.awt.Paint, String)
, but the graph gets stacked on top of the previous LINE, AREA or STACK graph.void
Draws a vertical rule into the graph.void
Draws a vertical rule into the graph and optionally adds a legendvoid
Draws a vertical rule into the graph and optionally adds a legendvoid
vrule
(long timestamp, Paint color, String legend, BasicStroke stroke) Draws a vertical rule into the graph and optionally adds a legendvoid
Draws a vertical span into the graph.void
Draws a vertical span into the graph and optionally adds a legend.
-
Field Details
-
poolUsed
boolean poolUsed -
antiAliasing
boolean antiAliasing -
textAntiAliasing
boolean textAntiAliasing -
filename
String filename -
startTime
long startTime -
endTime
long endTime -
timeAxisSetting
TimeAxisSetting timeAxisSetting -
timeLabelFormat
TimeLabelFormat timeLabelFormat -
valueAxisSetting
ValueAxisSetting valueAxisSetting -
altYGrid
boolean altYGrid -
noMinorGrid
boolean noMinorGrid -
altYMrtg
boolean altYMrtg -
altAutoscale
boolean altAutoscale -
altAutoscaleMin
boolean altAutoscaleMin -
altAutoscaleMax
boolean altAutoscaleMax -
unitsExponent
int unitsExponent -
unitsLength
int unitsLength -
verticalLabel
String verticalLabel -
width
int width -
height
int height -
interlaced
boolean interlaced -
imageInfo
String imageInfo -
imageFormat
String imageFormat -
imageQuality
float imageQuality -
backgroundImage
RrdGraphDef.ImageSource backgroundImage -
canvasImage
RrdGraphDef.ImageSource canvasImage -
overlayImage
RrdGraphDef.ImageSource overlayImage -
unit
String unit -
lazy
boolean lazy -
minValue
double minValue -
maxValue
double maxValue -
rigid
boolean rigid -
base
double base -
logarithmic
boolean logarithmic -
noLegend
boolean noLegend -
onlyGraph
boolean onlyGraph -
forceRulesLegend
boolean forceRulesLegend -
title
String title -
step
long step -
fonts
Font[] fonts -
drawXGrid
boolean drawXGrid -
drawYGrid
boolean drawYGrid -
firstDayOfWeek
int firstDayOfWeek -
locale
Locale locale -
tz
TimeZone tz -
signature
String signature -
showSignature
boolean showSignature -
gridStroke
Stroke gridStroke -
tickStroke
Stroke tickStroke -
downsampler
DownSampler downsampler -
sources
-
comments
-
plotElements
-
-
Constructor Details
-
RrdGraphDef
Deprecated.Uses default value that will be probably overriden.Creates RrdGraphDef object and sets default time span (default ending time is 'now', default starting time is 'end-1day'. -
RrdGraphDef
public RrdGraphDef(long t1, long t2) Creates RrdGraphDef object.- Since:
- 3.7
-
RrdGraphDef
public RrdGraphDef(java.time.temporal.TemporalAmount d) Creates new DataProcessor object for the given time duration. The given duration will be substracted from current time.- Parameters:
d
- duration to substract.- Since:
- 3.7
-
-
Method Details
-
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.- Specified by:
setStartTime
in interfaceDataHolder
- Parameters:
time
- Starting time for the graph in seconds since epoch
-
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.- Specified by:
setEndTime
in interfaceDataHolder
- Parameters:
time
- Ending time for the graph in seconds since epoch
-
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.- Specified by:
setTimeSpan
in interfaceDataHolder
- Parameters:
startTime
- Starting time in seconds since epochendTime
- 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.
-
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.- Specified by:
setPoolUsed
in interfaceDataHolder
- Parameters:
poolUsed
- true, if RrdDbPool class should be used. False otherwise.
-
isPoolUsed
public boolean isPoolUsed()Description copied from interface:DataHolder
Returns boolean value representingRrdDbPool
usage policy.- Specified by:
isPoolUsed
in interfaceDataHolder
- Returns:
- true, if the pool will be used internally to fetch data from RRD files, false otherwise.
- Since:
- 3.7
-
getPool
- Specified by:
getPool
in interfaceDataHolder
- Since:
- 3.7
-
setPool
Description copied from interface:DataHolder
Defines theRrdDbPool
to use. If not defined, but {DataHolder.setPoolUsed(boolean)
set to true, the defaultRrdDbPool.getInstance()
will be used.- Specified by:
setPool
in interfaceDataHolder
- Parameters:
pool
- an optional pool to use.- Since:
- 3.7
-
setFilename
Sets the name of the graph to generate. Since Rrd4j outputs GIFs, PNGs, and JPEGs it's recommended that the filename end in either .gif, .png or .jpg. Rrd4j 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
-
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 inRrdGraphConstants
: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)
-
setTimeAxis
public void setTimeAxis(int minorUnit, int minorUnitCount, int majorUnit, int majorUnitCount, int labelUnit, int labelUnitCount, int labelSpan, TimeLabelFormat format) It configure the x-axis grid in the same way thansetTimeAxis(int, int, int, int, int, int, int, String)
, but it allows to use aTimeLabelFormat
to format the date label.- Parameters:
minorUnit
-minorUnitCount
-majorUnit
-majorUnitCount
-labelUnit
-labelUnitCount
-labelSpan
-format
-
-
setTimeLabelFormat
This allows to keep the default major and minor grid unit, but with changing only the label formatting, using aTimeLabelFormat
- Parameters:
format
- a custom dynamic time label format
-
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 steplabelFactor
- Specifies how many minor minor grid steps will appear between labels (major grid lines)
-
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)
-
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)
-
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)
-
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).
-
setAltAutoscaleMin
public void setAltAutoscaleMin(boolean altAutoscaleMin) 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:
altAutoscaleMin
- 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)
-
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, inclusive. 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, thousands), use -6 to display the y-axis values in µ (Micro, 10e-6, millionths). Use a value of 0 to prevent any scaling of the y-axis values.- Parameters:
unitsExponent
- the 10**unitsExponent value for scaling y-axis values.
-
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.
-
setVerticalLabel
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.
-
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.
-
setInterlaced
public void setInterlaced(boolean interlaced) Creates interlaced or progressive mode image.- Parameters:
interlaced
- true, if GIF image should be interlaced.
-
setImageInfo
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
print(String, ConsolFun, 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'>");
- Parameters:
imageInfo
- Image info format. Use %s placeholder for filename, %d placeholder for image width and height.
-
setImageFormat
Sets image format. ImageIO is used to save the image, so any supported format by ImageIO can be used, and it can be extended using https://github.com/geosolutions-it/imageio-ext.- Parameters:
imageFormat
- Any value as return byImageIO.getReaderFormatNames()
-
setBackgroundImage
Sets background image. ImageIO is used to download, so any supported format by ImageIO can be used, and it can be extended using https://github.com/geosolutions-it/imageio-ext.- Parameters:
backgroundImage
- Path to background image
-
setBackgroundImage
Sets background image. ImageIO is used to download, so any supported format by ImageIO can be used, and it can be extended using https://github.com/geosolutions-it/imageio-ext.- Parameters:
backgroundImageUrl
- URL to background image
-
setBackgroundImage
Sets background image.- Parameters:
backgroundImage
- AnRrdGraphDef.ImageSource
that will provides aBufferedImage
-
setCanvasImage
Sets canvas background image. Canvas image is printed on canvas area, under canvas color and plot. ImageIO is used to download, so any supported format by ImageIO can be used, and it can be extended using https://github.com/geosolutions-it/imageio-ext.- Parameters:
canvasImage
- Path to canvas image
-
setCanvasImage
Sets canvas background image. Canvas image is printed on canvas area, under canvas color and plot. ImageIO is used to download, so any supported format by ImageIO can be used, and it can be extended using https://github.com/geosolutions-it/imageio-ext.- Parameters:
canvasUrl
- URL to canvas image
-
setCanvasImage
Sets canvas background image. Canvas image is printed on canvas area, under canvas color and plot.- Parameters:
canvasImageSource
- AnRrdGraphDef.ImageSource
that will provides aBufferedImage
-
setOverlayImage
Sets overlay image. Overlay image is printed on the top of the image, once it is completely created. ImageIO is used to download, so any supported format by ImageIO can be used, and it can be extended using https://github.com/geosolutions-it/imageio-ext.- Parameters:
overlayImage
- Path to overlay image
-
setOverlayImage
Sets overlay image. Overlay image is printed on the top of the image, once it is completely created. ImageIO is used to download, so any supported format by ImageIO can be used, and it can be extended using https://github.com/geosolutions-it/imageio-ext.- Parameters:
overlayImage
- URL to overlay image
-
setOverlayImage
Sets overlay image. Overlay image is printed on the top of the image, once it is completely created.- Parameters:
overlayImageSource
- AnRrdGraphDef.ImageSource
that will provides aBufferedImage
-
setUnit
Sets unit to be displayed on y axis. It is wise to use only short units on graph, however.- Parameters:
unit
- Unit description
-
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 (default)
-
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
-
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
setRigid(boolean)
method as well.- Parameters:
maxValue
- Maximal value displayed on the graph.
-
setRigid
public void setRigid(boolean rigid) Sets rigid boundaries mode. Normally Rrd4j will automatically expand the lower and upper limit if the graph contains a value outside the valid range. With thetrue
argument you can disable this behavior.- Parameters:
rigid
- true if upper and lower limits should not be expanded to accommodate values outside of the specified range. False otherwise (default).
-
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)
-
setLogarithmic
public void setLogarithmic(boolean logarithmic) Sets logarithmic y-axis scaling.- Parameters:
logarithmic
- true, for logarithmic scaling, false otherwise (default).
-
setColor
Deprecated.Overrides the colors for the standard elements of the graph. The colorTag must be one of the following constants defined in theRrdGraphConstants
:COLOR_BACK
ground,COLOR_CANVAS
,COLOR_XAXIS
,COLOR_SHADEA
left/top border,COLOR_SHADEB
right/bottom border,COLOR_GRID
,COLOR_MGRID
major grid,COLOR_FONT
,COLOR_FRAME
and axis of the graph orCOLOR_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
-
setColor
Overrides the colors for the standard elements of the graph.- Parameters:
colorTag
- The element to change color.color
- The color of the element.
-
setColor
Deprecated.Overrides the colors for the standard elements of the graph by element name. SeesetColor(int, java.awt.Paint)
for full explanation.- Parameters:
colorName
- One of the following strings: "BACK", "CANVAS", "SHADEA", "SHADEB", "GRID", "MGRID", "FONT", "FRAME", "ARROW", "XAXIS", "YAXIS"color
- Any color (paint) you like
-
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).
-
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).
-
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).
-
setTitle
Defines a title to be written into the graph.- Parameters:
title
- Graph title.
-
setStep
public void setStep(long step) Suggests which time step should be used by Rrd4j while processing data from RRD files.- Specified by:
setStep
in interfaceDataHolder
- Parameters:
step
- Desired time step (don't use this method if you don't know what you're doing).
-
setFontSet
public void setFontSet(boolean rrdtool) This method reset the font set to it's default values. With the flag rrdtool set to true, it's not the old default set that is used, but the one taken from rrdtool. So use false to keep compatibility with previous version and true for a graph matching rrdtool's- Parameters:
rrdtool
- true to use rrdtool font set
-
setSmallFont
Deprecated.UseRrdGraphConstants.FontTag
based method instead.Sets default font for graphing. Note that Rrd4j will behave unpredictably if proportional font is selected.- Parameters:
smallFont
- Default font for graphing. Use only monospaced fonts.
-
setLargeFont
Deprecated.UseRrdGraphConstants.FontTag
based method instead.Sets title font.- Parameters:
largeFont
- Font to be used for graph title.
-
setFont
Sets font to be used for a specific font tag. The fontTag must be one of the following constants defined in theRrdGraphConstants
: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.- Parameters:
fontTag
- Font tag, as explained above.font
- Font to be used for tag
-
setFont
Sets font.- Parameters:
fontTag
- Font tag, as explained above.font
- Font to be used for tagsetAll
- Boolean to flag whether to set all fonts if fontTag == FONTTAG_DEFAULT
-
setFont
public void setFont(RrdGraphConstants.FontTag fontTag, Font font, boolean setAll, boolean keepSizes) Sets font.- Parameters:
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.
-
setFont
Sets font.- Parameters:
fontTag
- Font tag as String, as explained insetFont(org.rrd4j.graph.RrdGraphConstants.FontTag, Font, boolean)
.font
- Font to be used for tag
-
setFont
Sets font.- Parameters:
fontTag
- Font tag as String, as explained insetFont(org.rrd4j.graph.RrdGraphConstants.FontTag, Font, boolean)
.font
- Font to be used for tagsetAll
- Boolean to flag whether to set all fonts if fontTag == FONTTAG_DEFAULT
-
setFont
Sets font.- Parameters:
fontTag
- Font tag as String, as explained insetFont(org.rrd4j.graph.RrdGraphConstants.FontTag, Font, boolean)
.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.
-
getFont
-
datasource
Defines virtual datasource. This datasource can then be used in other methods likedatasource(String, String)
orgprint(String, ConsolFun, String)
.- Specified by:
datasource
in interfaceDataHolder
- Parameters:
name
- Source namerrdPath
- Path to RRD filedsName
- Datasource name in the specified RRD fileconsolFun
- Consolidation function (AVERAGE, MIN, MAX, LAST)
-
datasource
Defines virtual datasource. This datasource can then be used in other methods likedatasource(String, String)
orgprint(String, ConsolFun, String)
.- Specified by:
datasource
in interfaceDataHolder
- Parameters:
name
- Source namerrdUri
- URI to RRD filedsName
- Datasource name in the specified RRD fileconsolFun
- Consolidation function (AVERAGE, MIN, MAX, LAST)- Since:
- 3.7
-
datasource
@Deprecated public void datasource(String name, String rrdPath, String dsName, ConsolFun consolFun, String backend) Deprecated.Defines virtual datasource. This datasource can then be used in other methods likedatasource(String, String)
orgprint(String, ConsolFun, String)
.- Parameters:
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.
-
datasource
public void datasource(String name, String rrdPath, String dsName, ConsolFun consolFun, RrdBackendFactory backend) Defines virtual datasource. This datasource can then be used in other methods likedatasource(String, String)
orgprint(String, ConsolFun, String)
.- Specified by:
datasource
in interfaceDataHolder
- Parameters:
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.
-
datasource
public void datasource(String name, URI rrdUri, String dsName, ConsolFun consolFun, RrdBackendFactory backend) Defines virtual datasource. This datasource can then be used in other methods likedatasource(String, String)
orgprint(String, ConsolFun, String)
.- Specified by:
datasource
in interfaceDataHolder
- Parameters:
name
- Source namerrdUri
- 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.- Since:
- 3.7
-
datasource
Create a new virtual datasource by evaluating a mathematical expression, specified in Reverse Polish Notation (RPN).- Specified by:
datasource
in interfaceDataHolder
- Parameters:
name
- Source namerpnExpression
- RPN expression.
-
datasource
Deprecated.UseVariable
based method instead.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 namedefName
- Other source nameconsolFun
- Consolidation function to be applied to other datasource.
-
datasource
Creates a datasource that performs a variable calculation on an another named datasource to yield a single combined timestamp/value. Requires that the other datasource has already been defined; otherwise, it'll end up with no data- Specified by:
datasource
in interfaceDataHolder
- Parameters:
name
- - the new virtual datasource namedefName
- - the datasource from which to extract the percentile. Must be a previously defined virtual datasourcevar
- - a new instance of a Variable used to do the calculation
-
datasource
Creates a new (plottable) datasource. Datasource values are obtained from the given plottable object.- Specified by:
datasource
in interfaceDataHolder
- Parameters:
name
- Source name.plottable
- Plottable object.- Since:
- 3.7
-
datasource
Creates a new 'fetched' datasource. Datasource values are obtained from the givenFetchData
object.- Specified by:
datasource
in interfaceDataHolder
- Parameters:
name
- Source name.fetchData
- FetchData object.
-
datasource
Creates a new 'fetched' datasource. Datasource values are obtained from the givenFetchData
object. Values will be extracted from the datasource dsName in the fetchData- Specified by:
datasource
in interfaceDataHolder
- Parameters:
name
- Source name.dsName
- Source name in fetchData.fetchData
- FetchData object.
-
percentile
Deprecated.UseVariable
based method instead.Create a new virtual datasource to get the 95th percentile value from another datasource- Parameters:
name
- Source name.defName
- Other source name.
-
percentile
Deprecated.UseVariable
based method instead.Create a new virtual datasource to get a percentile value from another datasource- Parameters:
name
- Source name.defName
- Other source name.percent
- The percent value.
-
print
Deprecated.UseVariable
based method instead.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 theobject
once the graph is created.- Parameters:
srcName
- Virtual source nameconsolFun
- Consolidation function to be applied to the sourceformat
- Format string (like "average = %10.3f %s")
-
print
Read the value of a variable (VDEF) and prints the value 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 theobject
once the graph is created.- Parameters:
srcName
- Virtual source nameformat
- Format string (like "average = %10.3f %s")
-
print
Read the value of a variable (VDEF) and prints the the value or the time stamp, according to the strftime flag by using the given format string. In 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 theobject
once the graph is created.- Parameters:
srcName
- Virtual source nameformat
- Format string (like "average = %10.3f %s")strftime
- use the timestamp from the variable (true) or the numerical value (false)
-
gprint
Deprecated.UseVariable
based method instead.This method does basically the same thing asprint(String, ConsolFun, String)
, 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")
-
gprint
Read the value of a variable (VDEF) and prints the value 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 added to the graph as a legend- Parameters:
srcName
- Virtual source nameformat
- Format string (like "average = %10.3f %s")
-
gprint
Read the value of a variable (VDEF) and prints the the value or the time stamp, according to the strftime flag by using the given format string. In 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 added to the graph as a legend.
- Parameters:
srcName
- Virtual source nameformat
- Format string (like "average = %10.3f %s")strftime
- use the timestamp from the variable (true) or the numerical value (false)
-
comment
Comment to be printed on the graph.- Parameters:
text
- Comment text
-
hrule
Draws a horizontal rule into the graph.- Parameters:
value
- Position of the rulecolor
- Rule color
-
hrule
Draws a horizontal rule into the graph and optionally adds a legend.- Parameters:
value
- Position of the rulecolor
- Rule colorlegend
- Legend text. If null, legend text will be omitted.
-
hrule
Draws a horizontal rule into the graph and optionally adds a legend.- Parameters:
value
- Position of the rulecolor
- Rule colorlegend
- Legend text. If null, legend text will be omitted.width
- Rule width
-
hrule
Draws a horizontal rule into the graph and optionally adds a legend.- Parameters:
value
- Position of the rulecolor
- Rule colorlegend
- Legend text. If null, legend text will be omitted.stroke
- Rule stroke
-
vrule
Draws a vertical rule into the graph.- Parameters:
timestamp
- Position of the rule (seconds since epoch)color
- Rule color
-
vrule
Draws a vertical rule into the graph and optionally adds a legend- Parameters:
timestamp
- Position of the rule (seconds since epoch)color
- Rule colorlegend
- Legend text. Use null to omit the text.
-
vrule
Draws a vertical rule into the graph and optionally adds a legend- Parameters:
timestamp
- Position of the rule (seconds since epoch)color
- Rule colorlegend
- Legend text. Use null to omit the text.width
- Rule width
-
vrule
Draws a vertical rule into the graph and optionally adds a legend- Parameters:
timestamp
- Position of the rule (seconds since epoch)color
- Rule colorlegend
- Legend text. Use null to omit the text.stroke
- Rule stroke
-
hspan
Draws a horizontal span into the graph.- Parameters:
start
- Starting value of the spanend
- Ending value of the spancolor
- Rule color
-
hspan
Draws a horizontal span into the graph and optionally adds a legend.- Parameters:
start
- Starting value of the spanend
- Ending value of the spancolor
- Rule colorlegend
- Legend text. Use null to omit the text.
-
vspan
Draws a vertical span into the graph.- Parameters:
start
- Start time for the span (seconds since epoch)end
- End time for the span (seconds since epoch)color
- Rule color
-
vspan
Draws a vertical span into the graph and optionally adds a legend.- Parameters:
start
- Start time for the span (seconds since epoch)end
- End time for the span (seconds since epoch)color
- Rule colorlegend
- Legend text. Use null to omit the text.
-
line
Plots requested data as a line, using the color specified. Line width is assumed to be 1.0F.- Parameters:
srcName
- Virtual source namecolor
- Line color
-
line
Plots requested data as a line, using the color specified. Line width is assumed to be 1.0F.- Parameters:
srcName
- Virtual source namecolor
- Line colorlegend
- Legend text
-
line
Plots requested data as a line, using the color and the line width specified.- Parameters:
srcName
- Virtual source namecolor
- Line colorwidth
- Line width (default: 1.0F)
-
line
Plots requested data as a line, using the color and the line width specified.- Parameters:
srcName
- Virtual source namecolor
- Line colorlegend
- Legend textwidth
- Line width (default: 1.0F)
-
line
Plots requested data as a line, using the color and the line width specified.- Parameters:
srcName
- Virtual source namecolor
- Line color.legend
- Legend text.width
- Line width (default: 1.0F).stack
- true if it will be stacked.
-
line
Plots requested data as a line, using the color and theBasicStroke
specified.- Parameters:
srcName
- Virtual source namecolor
- Line color.legend
- Legend text.stroke
- Line stroke to use.stack
- true if it will be stacked.
-
line
Define a line like any other but with constant value, it can be stacked- Parameters:
value
- Line position.color
- Line color.width
- Line width (default: 1.0F).stack
- true if it will be stacked.
-
line
Define a line like any other but with constant value, it can be stacked- Parameters:
value
- Line position.color
- Line color.stroke
- Line stroke to use.stack
- true if it will be stacked.
-
area
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.
-
area
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
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.stack
- true if it will be stacked.
-
area
Add a area like any other but with a constant value, it can be stacked like any other area- Parameters:
value
- Area positioncolor
- Color of the filled area.stack
- true if it will be stacked.
-
stack
Does the same as
line(String, java.awt.Paint)
, 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, Rrd4j will not draw any graphics ... *UNKNOWN* is not zero.
- Parameters:
srcName
- Virtual source namecolor
- Stacked graph color- Throws:
IllegalArgumentException
- Thrown if this STACK has no previously defined AREA, STACK or LINE graph bellow it.
-
stack
Does the same as
Note, that when you STACK onto *UNKNOWN* data, Rrd4j will not draw any graphics ... *UNKNOWN* is not zero.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.- Parameters:
srcName
- Virtual source namecolor
- Stacked graph colorlegend
- Legend text- Throws:
IllegalArgumentException
- Thrown if this STACK has no previously defined AREA, STACK or LINE graph bellow it.
-
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.
-
setImageQuality
public void setImageQuality(float imageQuality) Sets image quality. Relevant only for JPEG images.- Parameters:
imageQuality
- (0F=worst, 1F=best).
-
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)
-
setTextAntiAliasing
public void setTextAntiAliasing(boolean textAntiAliasing) Controls if the text should be antialiased or not.- Parameters:
textAntiAliasing
- use true to turn text-antialiasing on, false to turn it off (default)
-
setSignature
Sets the signature string that runs along the right-side of the graph. Defaults to "Generated by RRD4J".- Parameters:
signature
- the string to print
-
getSignature
Gets the signature string that runs along the right-side of the graph.- Returns:
- the signature string
-
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
-
setFirstDayOfWeek
public void setFirstDayOfWeek(int firstDayOfWeek) Sets first day of the week. -
setLocale
Set the locale used for the legend.It overides the firstDayOfWeek
- Parameters:
locale
- the locale to set
-
setTimeZone
Set the time zone used for the legend.- Specified by:
setTimeZone
in interfaceDataHolder
- Parameters:
tz
- the time zone to set
-
getTimeZone
- Specified by:
getTimeZone
in interfaceDataHolder
- Since:
- 3.7
-
setGridStroke
Set the Stroke used to draw grid- Parameters:
gridStroke
- aStroke
object.
-
setTickStroke
Set the stroke used to draw ticks- Parameters:
tickStroke
- aStroke
object.
-
setDownsampler
Allows to set a downsampler, used to improved the visual representation of graph.More details can be found on Sveinn Steinarsson's thesis
- Parameters:
downsampler
- The downsampler that will be used
-
printStatementCount
int printStatementCount() -
shouldPlot
boolean shouldPlot() -
getColor
-
getEndTime
public long getEndTime()Description copied from interface:DataHolder
Returns ending timestamp.- Specified by:
getEndTime
in interfaceDataHolder
- Returns:
- Ending timestamp in seconds
- Since:
- 3.7
-
getStartTime
public long getStartTime()Description copied from interface:DataHolder
Returns starting timestamp.- Specified by:
getStartTime
in interfaceDataHolder
- Returns:
- Starting timestamp in seconds
- Since:
- 3.7
-
getStep
public long getStep()Description copied from interface:DataHolder
Returns the time step used for timestamp interval.- Specified by:
getStep
in interfaceDataHolder
- Returns:
- Step used for data processing.
- Since:
- 3.7
-