java.lang.Object
org.rrd4j.graph.RrdGraph
- All Implemented Interfaces:
RrdGraphConstants
Class which actually creates Rrd4j graphs (does the hard work).
Nested Class Summary
Nested classes/interfaces inherited from interface RrdGraphConstants
RrdGraphConstants.FontConstructor, RrdGraphConstants.FontTagModifier and TypeInterfaceDescriptionstatic classFont constructor, to use embedded fonts.static enumAllowed font tag names which can be used inRrdGraphDef.setFont(org.rrd4j.graph.RrdGraphConstants.FontTag, java.awt.Font)methodField Summary
FieldsModifier and TypeFieldDescription(package private) final RrdGraphDefThe definition describing what this graph plots.(package private) final ImageParametersThe dimensions and text layout of the rendered image.private final RrdGraphInfoMetadata about the graph, such as its value range and time bounds.Fields inherited from interface RrdGraphConstants
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, GRID_STROKE, HH_MM, HOUR, IN_MEMORY_IMAGE, LEGEND_BOX, LEGEND_BOX_SPACE, LEGEND_INTERSPACING, LEGEND_LEADING, LEGEND_LEADING_SMALL, MINUTE, MONDAY, MONTH, PADDING_BOTTOM, PADDING_LEFT, PADDING_LEGEND, PADDING_PLOT, PADDING_RIGHT, PADDING_TITLE, PADDING_TOP, PADDING_VLABEL, PROPERTYFONTBOLD, PROPERTYFONTBOLDURL, PROPERTYFONTPLAIN, PROPERTYFONTPLAINURL, PROPERTYFONTSPROPERTIES, PROPERTYFONTSURL, SATURDAY, SECOND, SERIES_DOT, SUNDAY, THURSDAY, TICK_STROKE, TUESDAY, WEDNESDAY, WEEK, YEARModifier and TypeFieldDescriptionstatic final ColorAn transparent colorstatic final intIndex of the arrow color.static final intIndex of the background color.static final intIndex of the canvas color.static final intIndex of the font color.static final intIndex of the frame color.static final intIndex of the minor grid color.static final intIndex of the major grid color.static final intIndex of the top-left graph shade color.static final intIndex of the bottom-right graph shade color.static final intIndex of the x-axis color.static final intIndex of the yaxis color.static final intConstant to represent daystatic final ColorDefault arrow colorstatic final ColorDefault graph background colorstatic final doubleDefault value basestatic final ColorDefault graph canvas colorstatic final StringDefault graph ending timestatic final ColorDefault font colorstatic final ColorDefault frame colorstatic final ColorDefault minor grid colorstatic final intDefault graph heightstatic final StringDefault image formatstatic final floatDefault image quality, used only for jpeg graphsstatic final FontDefault graph large fontstatic final ColorDefault major grid colorstatic final ColorDefault top-left graph shade colorstatic final ColorDefault bottom-right graph shade colorstatic final FontDefault graph small fontstatic final StringDefault graph starting timestatic final intDefault units lengthstatic final intDefault graph widthstatic final ColorDefault x-axis colorstatic final ColorDefault x-axis colorstatic final intDefault first day of the week (obtained from the default locale)static final RrdGraphConstants.FontTagAxis font tagstatic final RrdGraphConstants.FontTagDefault font tagstatic final RrdGraphConstants.FontTagLegend font tagstatic final RrdGraphConstants.FontTagTitle font tagstatic final RrdGraphConstants.FontTagUnit font tagstatic final RrdGraphConstants.FontTagWatermark font tagstatic final intConstant to represent Fridaystatic final FontFont for the Gatorstatic final StrokeStroke used to draw gridstatic final StringHH:mm time formatstatic final intConstant to represent hourstatic final StringConstant to represent in-memory image namestatic final doubleUsed internallystatic final doubleUsed internallystatic final intUsed internallystatic final doubleUsed internallystatic final doubleUsed internallystatic final intConstant to represent minutestatic final intConstant to represent Mondaystatic final intConstant to represent monthstatic final intUsed internallystatic final intUsed internallystatic final doubleUsed internallystatic final intUsed internallystatic final intUsed internallystatic final intUsed internallystatic final intUsed internallystatic final intUsed internallystatic final StringThe name of the bold font, used to define theRrdGraphConstants.DEFAULT_LARGE_FONT.static final StringA URL to the bold font, used to define theRrdGraphConstants.DEFAULT_LARGE_FONT.static final StringThe name of the plain font, used to define theRrdGraphConstants.DEFAULT_SMALL_FONTand theRrdGraphConstants.GATOR_FONT.static final StringA URL to the plain font, used to define theRrdGraphConstants.DEFAULT_SMALL_FONTand theRrdGraphConstants.GATOR_FONT.static final StringThe file that contains font configuration searched in the class path.static final StringA possible URL to a configuration file.static final intConstant to represent Saturdaystatic final intConstant to represent secondstatic final floatInk length of one dot in a series line, in device pixels.static final intConstant to represent Sundaystatic final intConstant to represent Thursdaystatic final StrokeStroke used to draw ticksstatic final intConstant to represent Tuesdaystatic final intConstant to represent Wednesdaystatic final intConstant to represent weekstatic final intConstant to represent yearConstructor Summary
ModifierConstructorDescriptionRrdGraph(RrdGraphDef gdef) Creates graph from the correspondingRrdGraphDefobject.privateRrdGraph(RrdGraphDef gdef, java.util.function.Supplier<ImageWorker> worker) Builds the image for a graph definition.RrdGraph(RrdGraphDef gdef, ImageWriter writer, ImageWriteParam param) Creates graph from the correspondingRrdGraphDefobject.RrdGraph(RrdGraphDef gdef, ImageWorker worker) Create graph from a custom image workerMethod Summary
Modifier and TypeMethodDescriptionprivate static ImageWorkerGenerate image workerprivate static ImageWorkergenerateImageWorker(RrdGraphDef gdef, ImageWriter writer, ImageWriteParam param) Creates the worker that renders the graph.Returns complete graph information in a single object.voidRenders this graph onto graphing device
Field Details
gdef
The definition describing what this graph plots.im
The dimensions and text layout of the rendered image.info
Metadata about the graph, such as its value range and time bounds.
Constructor Details
RrdGraph
Creates graph from the correspondingRrdGraphDefobject.- Parameters:
gdef- the graph definition to render- Throws:
IOException- Thrown in case of I/O error
RrdGraph
Create graph from a custom image worker- Parameters:
gdef- the graph definition to renderworker- the image worker painting the graph, replacing the default one- Throws:
IOException- Thrown in case of I/O error
RrdGraph
Creates graph from the correspondingRrdGraphDefobject.The graph will be created using customs
ImageWriterandImageWriteParamgiven.The ImageWriter type and ImageWriteParam settings have priority other the RrdGraphDef settings.
- Parameters:
gdef- the graph definition to renderwriter- the ImageWriter that encodes the graphparam- the encoder settings applied by that writer- Throws:
IOException- Thrown in case of I/O error
RrdGraph
private RrdGraph(RrdGraphDef gdef, java.util.function.Supplier<ImageWorker> worker) throws IOException Builds the image for a graph definition.- Parameters:
gdef- the graph definitionworker- supplies the image worker- Throws:
IOException- if the image cannot be rendered
Method Details
generateImageWorker
private static ImageWorker generateImageWorker(RrdGraphDef gdef, ImageWriter writer, ImageWriteParam param) Creates the worker that renders the graph.- Parameters:
gdef- the graph definitionwriter- the image writer to render withparam- the writer parameters, or null- Returns:
- the worker to render with
generateImageWorker
Generate image worker- Parameters:
gdef- the graph definition the worker renders- Returns:
- the image worker for the definition
getRrdGraphInfo
Returns complete graph information in a single object.- Returns:
- Graph information (width, height, filename, image bytes, etc...)
render
Renders this graph onto graphing device- Parameters:
g- Graphics to paint the already-rendered image onto