I am working on an application that, depending on what a customer has paid for, they will and won't see certain sections of data at certain points in time.
Imagine a dataset where there are 6 series and, lets say, about 100 samples. For three of the series, the middle 40 samples aren't shown, because the user isn't authorised to see them, but the other series are displayed as normal during this time.
Now, trying to put this into an XYPlot using a BasicTimeSeries, I have tried two things thus far. The first thing I did was just to leave out the samples that weren't to be shown. Unfortunately, this draws a line from the last sample before the gap to the first sample after the gap. This infers there is data being shown when there isn't, so we can't do that.
The second thing I did was to create a new series every time there's a gap. This looks great on the graph - exactly how I wanted. Unfortunately, the legend now shows these series more than once, and apparently this is also unacceptable to the client.
So, I either need a way to stop a single series from drawing a line when there's a gap (or to just not draw a line between any two points) or a way to edit or create my own legend so that, when I create more than one series for what is really only one series of data, it will only show up once in the legend.
Any help appreciated.
Graham.
Showing a gap in a BasicTimeSeries
-
Graham Lea
Re: Showing a gap in a BasicTimeSeries
I've managed to solve the problem by making a mod to StandardLegend so that it will only print unique labels. Ideally, it should probably have an attribute specifying whether to do this or not (uniqueNamesOnly?) but I don't unfortunately don't have the time to make such an enhancement.
In the interests of LGPL, my changes are below, though we do not plan to redistribute the modified version except with our own (single-client) system.
I'm working with version 0.7.3.
The changes haven't been tested with a vertical legend.
All changes were to this function:
protected Rectangle2D draw(Graphics2D g2, Rectangle2D available, boolean horizontal, boolean inverted)
============================
Diff
============================
40a41,53
> *
> * ----------------------------------
> * Changes by Forge Research Pty Ltd
> * ----------------------------------
> * [September 30, 2002]
> * The method:
> *
> * protected Rectangle2D
> * draw(Graphics2D g2, Rectangle2D available, boolean horizontal,
> * boolean inverted)
> *
> * has been changed by Forge Research Pty Ltd to only print labels in the legend
> * for series that have a unique name.
48a62,63
> import java.util.HashSet;
>
257a273,274
> HashSet usedLabels = new HashSet(legendItemLabels.length);
>
269a287,288
> if (usedLabels.contains(legendItemLabels))
> continue;
278a298
> usedLabels.add(legendItemLabels);
305a326,328
> if (usedLabels.contains(legendItemLabels))
> continue;
> usedLabels.add(legendItemLabels);
336a360,361
> if (items == null)
> continue;
============================
Full Source
============================
/* =======================================
* JFreeChart : a Java Chart Class Library
* =======================================
*
* Project Info: http://www.jrefinery.com/jfreechart;
* Project Lead: David Gilbert (david.gilbert@jrefinery.com);
*
* (C) Copyright 2000-2002, by Simba Management Limited and Contributors.
*
* This library is free software; you can redistribute it and/or modify it under the terms
* of the GNU Lesser General Public License as published by the Free Software Foundation;
* either version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License along with this
* library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
* Boston, MA 02111-1307, USA.
*
* -------------------
* StandardLegend.java
* -------------------
* (C) Copyright 2000-2002, by Simba Management Limited and Contributors.
*
* Original Author: David Gilbert (for Simba Management Limited);
* Contributor(s): Andrzej Porebski;
*
* $Id: StandardLegend.java,v 1.11 2002/01/29 13:56:21 mungady Exp $
*
* Changes (from 20-Jun-2001)
* --------------------------
* 20-Jun-2001 : Modifications submitted by Andrzej Porebski for legend placement;
* 18-Sep-2001 : Updated header and fixed DOS encoding problem (DG);
* 16-Oct-2001 : Moved data source classes to com.jrefinery.data.* (DG);
* 19-Oct-2001 : Moved some methods [getSeriesPaint(...) etc.] from JFreeChart to Plot (DG);
* 22-Jan-2002 : Fixed bug correlating legend labels with pie data (DG);
* 06-Feb-2002 : Worked on bug-fix for legends in small areas (DG);
*
*
* ----------------------------------
* Changes by Forge Research Pty Ltd
* ----------------------------------
* [September 30, 2002]
* The method:
*
* protected Rectangle2D
* draw(Graphics2D g2, Rectangle2D available, boolean horizontal,
* boolean inverted)
*
* has been changed by Forge Research Pty Ltd to only print labels in the legend
* for series that have a unique name.
*/
package com.jrefinery.chart;
import java.awt.*;
import java.awt.event.*;
import java.awt.font.*;
import java.awt.geom.*;
import java.util.HashSet;
import javax.swing.*;
import com.jrefinery.data.*;
import com.jrefinery.chart.event.*;
/**
* A chart legend shows the names and visual representations of the series that are plotted in a
* chart. In the current implementation, the legend is shown to the right of the plot area.
* In future implementations, there is likely to more flexibility regarding the placement relative
* to the chart.
*/
public class StandardLegend extends Legend {
/** Default font. */
public static final Font DEFAULT_FONT = new Font("SansSerif", Font.PLAIN, 10);
/** The pen/brush used to draw the outline of the legend. */
protected Stroke outlineStroke;
/** The color used to draw the outline of the legend. */
protected Paint outlinePaint;
/** The color used to draw the background of the legend. */
protected Paint backgroundPaint;
/** The blank space inside the legend box. */
protected Spacer innerGap;
/** The font used to display the legend item names. */
protected Font itemFont;
/** The color used to display the legend item names. */
protected Paint itemPaint;
/**
* Constructs a new legend with default settings.
* @param chart The chart that the legend belongs to.
*/
public StandardLegend(JFreeChart chart) {
this(chart,
3,
new Spacer(Spacer.ABSOLUTE, 2, 2, 2, 2),
Color.white, new BasicStroke(), Color.gray,
DEFAULT_FONT, Color.black);
}
/**
* Constructs a new legend.
* @param chart The chart that the legend belongs to.
* @param outerGap The gap around the outside of the legend.
* @param innerGap The gap inside the legend.
* @param backgroundPaint The background color.
* @param outlineStroke The pen/brush used to draw the outline.
* @param outlinePaint The color used to draw the outline.
* @param seriesFont The font used to draw the legend items.
* @param seriesPaint The color used to draw the legend items.
*/
public StandardLegend(JFreeChart chart,
int outerGap, Spacer innerGap,
Paint backgroundPaint,
Stroke outlineStroke, Paint outlinePaint,
Font itemFont, Paint itemPaint) {
super(chart, outerGap);
this.innerGap = innerGap;
this.backgroundPaint = backgroundPaint;
this.outlineStroke = outlineStroke;
this.outlinePaint = outlinePaint;
this.itemFont = itemFont;
this.itemPaint = itemPaint;
// create the legend item collection...
}
/**
* Returns the background color for the legend.
* @return The background color for the legend.
*/
public Paint getBackgroundPaint() {
return this.backgroundPaint;
}
/**
* Sets the background color of the legend.
* <P>
* Registered listeners are notified that the legend has changed.
* @param paint The new background color.
*/
public void setBackgroundPaint(Paint paint) {
this.backgroundPaint = paint;
notifyListeners(new LegendChangeEvent(this));
}
/**
* Returns the outline pen/brush.
* @return The outline pen/brush.
*/
public Stroke getOutlineStroke() {
return this.outlineStroke;
}
/**
* Sets the outline pen/brush.
* <P>
* Registered listeners are notified that the legend has changed.
* @param stroke The new outline pen/brush.
*/
public void setOutlineStroke(Stroke stroke) {
this.outlineStroke = stroke;
notifyListeners(new LegendChangeEvent(this));
}
/**
* Returns the outline color.
* @return The outline color.
*/
public Paint getOutlinePaint() {
return this.outlinePaint;
}
/**
* Sets the outline color.
* <P>
* Registered listeners are notified that the legend has changed.
* @param stroke The new outline color.
*/
public void setOutlinePaint(Paint paint) {
this.outlinePaint = paint;
notifyListeners(new LegendChangeEvent(this));
}
/**
* Returns the series label font.
* @return The series label font.
*/
public Font getItemFont() {
return this.itemFont;
}
/**
* Sets the series label font.
* <P>
* Registered listeners are notified that the legend has changed.
* @param font The new series label font.
*/
public void setItemFont(Font font) {
this.itemFont = font;
notifyListeners(new LegendChangeEvent(this));
}
/**
* Returns the series label color.
* @return The series label color.
*/
public Paint getItemPaint() {
return this.itemPaint;
}
/**
* Sets the series label color.
* <P>
* Registered listeners are notified that the legend has changed.
* @param paint The new series label color.
*/
public void setItemPaint(Paint paint) {
this.itemPaint = paint;
notifyListeners(new LegendChangeEvent(this));
}
/**
* Draws the legend on a Java 2D graphics device (such as the screen or a printer).
* @param g2 The graphics device.
* @param available The area within which the legend, and afterwards the plot, should be drawn.
* @return The area used by the legend.
*/
public Rectangle2D draw(Graphics2D g2, Rectangle2D available) {
return draw(g2, available, (_anchor & HORIZONTAL)!=0, (_anchor & INVERTED)!=0);
}
/**
* Draws the legend.
* @param graphics The graphics device.
* @param available The area available for drawing the chart.
* @param horizontal A flag indicating whether the legend items are laid out horizontally.
* @param inverted ???
* @return ???
*/
protected Rectangle2D draw(Graphics2D g2, Rectangle2D available,
boolean horizontal, boolean inverted) {
// find out how many series in dataset, but watch for null...
Dataset data = chart.getDataset();
String[] legendItemLabels = chart.getLegendItemLabels();
if (legendItemLabels!=null) {
Rectangle2D legendArea = new Rectangle2D.Double();
// the translation point for the origin of the drawing system
Point2D translation = new Point2D.Double();
// Create buffer for individual rectangles within the legend
LegendItem[] items = new LegendItem[legendItemLabels.length];
g2.setFont(itemFont);
HashSet usedLabels = new HashSet(legendItemLabels.length);
// Compute individual rectangles in the legend, translation point as well
// as the bounding box for the legend.
if (horizontal) {
double xstart = available.getX()+outerGap;
double xlimit = available.getX()+available.getWidth()-2*outerGap-1;
double maxRowWidth = 0;
double xoffset = 0;
double rowHeight = 0;
double totalHeight = 0;
boolean startingNewRow = true;
for (int i=0; i<legendItemLabels.length; i++) {
if (usedLabels.contains(legendItemLabels))
continue;
items = createLegendItem(g2, legendItemLabels, xoffset, totalHeight);
if ((!startingNewRow) && (items.getX()+items.getWidth()+xstart>xlimit)) {
maxRowWidth=Math.max(maxRowWidth, xoffset);
xoffset = 0;
totalHeight += rowHeight;
i--;
startingNewRow=true;
}
else {
usedLabels.add(legendItemLabels[i]);
rowHeight = Math.max(rowHeight, items[i].getHeight());
xoffset += items[i].getWidth();
startingNewRow=false;
}
}
maxRowWidth=Math.max(maxRowWidth, xoffset);
totalHeight += rowHeight;
// Create the bounding box
legendArea = new Rectangle2D.Double(0, 0, maxRowWidth, totalHeight);
// The yloc point is the variable part of the translation point
// for horizontal legends. xloc is constant.
double yloc = (inverted) ?
available.getY() + available.getHeight() - totalHeight - outerGap :
available.getY() + outerGap;
double xloc = available.getX() + available.getWidth()/2 - maxRowWidth/2;
// Create the translation point
translation = new Point2D.Double(xloc,yloc);
}
else { // vertical...
double totalHeight = 0;
double maxWidth = 0;
g2.setFont(itemFont);
for (int i = 0; i < items.length; i++) {
if (usedLabels.contains(legendItemLabels[i]))
continue;
usedLabels.add(legendItemLabels[i]);
items[i] = createLegendItem(g2, legendItemLabels[i], 0, totalHeight);
totalHeight +=items[i].getHeight();
maxWidth = Math.max(maxWidth, items[i].getWidth());
}
// Create the bounding box
legendArea = new Rectangle2D.Float(0, 0, (float)maxWidth, (float)totalHeight);
// The xloc point is the variable part of the translation point
// for vertical legends. yloc is constant.
double xloc = (inverted) ?
available.getMaxX()-maxWidth-outerGap:
available.getX()+outerGap;
double yloc = available.getY()+(available.getHeight()/2)-(totalHeight/2);
// Create the translation point
translation = new Point2D.Double(xloc, yloc);
}
// Move the origin of the drawing to the appropriate location
g2.translate(translation.getX(), translation.getY());
// Draw the legend's bounding box
g2.setPaint(backgroundPaint);
g2.fill(legendArea);
g2.setPaint(outlinePaint);
g2.setStroke(outlineStroke);
g2.draw(legendArea);
// Draw individual series elements
for (int i=0; i<items.length; i++) {
if (items[i] == null)
continue;
g2.setPaint(chart.getPlot().getSeriesPaint(i));
g2.fill(items[i].getMarker());
g2.setPaint(itemPaint);
g2.drawString(items[i].label,
(float)items[i].labelPosition.getX(),
(float)items[i].labelPosition.getY());
}
// translate the origin back to what it was prior to drawing the legend
g2.translate(-translation.getX(),-translation.getY());
if (horizontal) {
// The remaining drawing area bounding box will have the same x origin,
// width and height independent of the anchor's location. The variable
// is the y coordinate. If the anchor is SOUTH, the y coordinate is simply
// the original y coordinate of the available area. If it is NORTH, we
// adjust original y by the total height of the legend and the initial gap.
double yloc = (inverted) ? available.getY() :
available.getY()+legendArea.getHeight()+outerGap;
// return the remaining available drawing area
return new Rectangle2D.Double(available.getX(), yloc, available.getWidth(),
available.getHeight()-legendArea.getHeight()-2*outerGap);
}
else {
// The remaining drawing area bounding box will have the same y origin,
// width and height independent of the anchor's location. The variable
// is the x coordinate. If the anchor is EAST, the x coordinate is simply
// the original x coordinate of the available area. If it is WEST, we
// adjust original x by the total width of the legend and the initial gap.
double xloc = (inverted) ? available.getX() :
available.getX()+legendArea.getWidth()+2*outerGap;
// return the remaining available drawing area
return new Rectangle2D.Double(xloc, available.getY(),
available.getWidth()-legendArea.getWidth()-2 * outerGap,
available.getHeight());
}
}
else {
return available;
}
}
/**
* Returns a box that will be positioned next to the name of the specified series within the
* legend area. The box will be square and 65% of the height of a line.
*/
private Rectangle2D getLegendBox(int series, int seriesCount, float textHeight,
Rectangle2D innerLegendArea) {
int innerGap = 2; // added to make this compile
float boxHeightAndWidth = textHeight*0.70f;
float xx = (float)innerLegendArea.getX()+innerGap+0.15f*textHeight;
float yy = (float)innerLegendArea.getY()+innerGap+(series+0.15f)*textHeight;
return new Rectangle2D.Float(xx, yy, boxHeightAndWidth, boxHeightAndWidth);
}
/**
ÿ ÿ * Returns a rectangle surrounding a individual entry in the legend.
ÿ ÿ * <P>
* The marker box for each entry will be positioned next to the name of the specified series
* within the legend area. The marker box will be square and 70% of the height of current
* font.
ÿ ÿ * @param graphics The graphics context (supplies font metrics etc.).
ÿ ÿ * @param label The series name.
ÿ ÿ * @param x The upper left x coordinate for the bounding box.
ÿ ÿ * @param y The upper left y coordinate for the bounding box.
ÿ ÿ* @return A LegendItem encapsulating all necessary info for drawing.
ÿ ÿ*/
private LegendItem createLegendItem(Graphics graphics, String label, double x, double y) {
int innerGap = 2;
FontMetrics fm = graphics.getFontMetrics();
LineMetrics lm = fm.getLineMetrics(label, graphics);
float textHeight = lm.getHeight();
LegendItem item = new LegendItem(label);
float xloc = (float)(x+innerGap+1.15f*textHeight);
float yloc = (float)(y+innerGap+(textHeight-lm.getLeading()-lm.getDescent()));
item.labelPosition = new Point2D.Float(xloc, yloc);
float boxDim = textHeight*0.70f;
xloc = (float)(x+innerGap+0.15f*textHeight);
yloc = (float)(y+innerGap+0.15f*textHeight);
item.setMarker(new Rectangle2D.Float(xloc, yloc, boxDim, boxDim));
float width = (float)(item.labelPosition.getX()-x+
fm.getStringBounds(label,graphics).getWidth()+0.5*textHeight);
float height = (float)(2*innerGap+textHeight);
item.setBounds(x, y, width, height);
return item;
}
}
In the interests of LGPL, my changes are below, though we do not plan to redistribute the modified version except with our own (single-client) system.
I'm working with version 0.7.3.
The changes haven't been tested with a vertical legend.
All changes were to this function:
protected Rectangle2D draw(Graphics2D g2, Rectangle2D available, boolean horizontal, boolean inverted)
============================
Diff
============================
40a41,53
> *
> * ----------------------------------
> * Changes by Forge Research Pty Ltd
> * ----------------------------------
> * [September 30, 2002]
> * The method:
> *
> * protected Rectangle2D
> * draw(Graphics2D g2, Rectangle2D available, boolean horizontal,
> * boolean inverted)
> *
> * has been changed by Forge Research Pty Ltd to only print labels in the legend
> * for series that have a unique name.
48a62,63
> import java.util.HashSet;
>
257a273,274
> HashSet usedLabels = new HashSet(legendItemLabels.length);
>
269a287,288
> if (usedLabels.contains(legendItemLabels))
> continue;
278a298
> usedLabels.add(legendItemLabels);
305a326,328
> if (usedLabels.contains(legendItemLabels))
> continue;
> usedLabels.add(legendItemLabels);
336a360,361
> if (items == null)
> continue;
============================
Full Source
============================
/* =======================================
* JFreeChart : a Java Chart Class Library
* =======================================
*
* Project Info: http://www.jrefinery.com/jfreechart;
* Project Lead: David Gilbert (david.gilbert@jrefinery.com);
*
* (C) Copyright 2000-2002, by Simba Management Limited and Contributors.
*
* This library is free software; you can redistribute it and/or modify it under the terms
* of the GNU Lesser General Public License as published by the Free Software Foundation;
* either version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License along with this
* library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
* Boston, MA 02111-1307, USA.
*
* -------------------
* StandardLegend.java
* -------------------
* (C) Copyright 2000-2002, by Simba Management Limited and Contributors.
*
* Original Author: David Gilbert (for Simba Management Limited);
* Contributor(s): Andrzej Porebski;
*
* $Id: StandardLegend.java,v 1.11 2002/01/29 13:56:21 mungady Exp $
*
* Changes (from 20-Jun-2001)
* --------------------------
* 20-Jun-2001 : Modifications submitted by Andrzej Porebski for legend placement;
* 18-Sep-2001 : Updated header and fixed DOS encoding problem (DG);
* 16-Oct-2001 : Moved data source classes to com.jrefinery.data.* (DG);
* 19-Oct-2001 : Moved some methods [getSeriesPaint(...) etc.] from JFreeChart to Plot (DG);
* 22-Jan-2002 : Fixed bug correlating legend labels with pie data (DG);
* 06-Feb-2002 : Worked on bug-fix for legends in small areas (DG);
*
*
* ----------------------------------
* Changes by Forge Research Pty Ltd
* ----------------------------------
* [September 30, 2002]
* The method:
*
* protected Rectangle2D
* draw(Graphics2D g2, Rectangle2D available, boolean horizontal,
* boolean inverted)
*
* has been changed by Forge Research Pty Ltd to only print labels in the legend
* for series that have a unique name.
*/
package com.jrefinery.chart;
import java.awt.*;
import java.awt.event.*;
import java.awt.font.*;
import java.awt.geom.*;
import java.util.HashSet;
import javax.swing.*;
import com.jrefinery.data.*;
import com.jrefinery.chart.event.*;
/**
* A chart legend shows the names and visual representations of the series that are plotted in a
* chart. In the current implementation, the legend is shown to the right of the plot area.
* In future implementations, there is likely to more flexibility regarding the placement relative
* to the chart.
*/
public class StandardLegend extends Legend {
/** Default font. */
public static final Font DEFAULT_FONT = new Font("SansSerif", Font.PLAIN, 10);
/** The pen/brush used to draw the outline of the legend. */
protected Stroke outlineStroke;
/** The color used to draw the outline of the legend. */
protected Paint outlinePaint;
/** The color used to draw the background of the legend. */
protected Paint backgroundPaint;
/** The blank space inside the legend box. */
protected Spacer innerGap;
/** The font used to display the legend item names. */
protected Font itemFont;
/** The color used to display the legend item names. */
protected Paint itemPaint;
/**
* Constructs a new legend with default settings.
* @param chart The chart that the legend belongs to.
*/
public StandardLegend(JFreeChart chart) {
this(chart,
3,
new Spacer(Spacer.ABSOLUTE, 2, 2, 2, 2),
Color.white, new BasicStroke(), Color.gray,
DEFAULT_FONT, Color.black);
}
/**
* Constructs a new legend.
* @param chart The chart that the legend belongs to.
* @param outerGap The gap around the outside of the legend.
* @param innerGap The gap inside the legend.
* @param backgroundPaint The background color.
* @param outlineStroke The pen/brush used to draw the outline.
* @param outlinePaint The color used to draw the outline.
* @param seriesFont The font used to draw the legend items.
* @param seriesPaint The color used to draw the legend items.
*/
public StandardLegend(JFreeChart chart,
int outerGap, Spacer innerGap,
Paint backgroundPaint,
Stroke outlineStroke, Paint outlinePaint,
Font itemFont, Paint itemPaint) {
super(chart, outerGap);
this.innerGap = innerGap;
this.backgroundPaint = backgroundPaint;
this.outlineStroke = outlineStroke;
this.outlinePaint = outlinePaint;
this.itemFont = itemFont;
this.itemPaint = itemPaint;
// create the legend item collection...
}
/**
* Returns the background color for the legend.
* @return The background color for the legend.
*/
public Paint getBackgroundPaint() {
return this.backgroundPaint;
}
/**
* Sets the background color of the legend.
* <P>
* Registered listeners are notified that the legend has changed.
* @param paint The new background color.
*/
public void setBackgroundPaint(Paint paint) {
this.backgroundPaint = paint;
notifyListeners(new LegendChangeEvent(this));
}
/**
* Returns the outline pen/brush.
* @return The outline pen/brush.
*/
public Stroke getOutlineStroke() {
return this.outlineStroke;
}
/**
* Sets the outline pen/brush.
* <P>
* Registered listeners are notified that the legend has changed.
* @param stroke The new outline pen/brush.
*/
public void setOutlineStroke(Stroke stroke) {
this.outlineStroke = stroke;
notifyListeners(new LegendChangeEvent(this));
}
/**
* Returns the outline color.
* @return The outline color.
*/
public Paint getOutlinePaint() {
return this.outlinePaint;
}
/**
* Sets the outline color.
* <P>
* Registered listeners are notified that the legend has changed.
* @param stroke The new outline color.
*/
public void setOutlinePaint(Paint paint) {
this.outlinePaint = paint;
notifyListeners(new LegendChangeEvent(this));
}
/**
* Returns the series label font.
* @return The series label font.
*/
public Font getItemFont() {
return this.itemFont;
}
/**
* Sets the series label font.
* <P>
* Registered listeners are notified that the legend has changed.
* @param font The new series label font.
*/
public void setItemFont(Font font) {
this.itemFont = font;
notifyListeners(new LegendChangeEvent(this));
}
/**
* Returns the series label color.
* @return The series label color.
*/
public Paint getItemPaint() {
return this.itemPaint;
}
/**
* Sets the series label color.
* <P>
* Registered listeners are notified that the legend has changed.
* @param paint The new series label color.
*/
public void setItemPaint(Paint paint) {
this.itemPaint = paint;
notifyListeners(new LegendChangeEvent(this));
}
/**
* Draws the legend on a Java 2D graphics device (such as the screen or a printer).
* @param g2 The graphics device.
* @param available The area within which the legend, and afterwards the plot, should be drawn.
* @return The area used by the legend.
*/
public Rectangle2D draw(Graphics2D g2, Rectangle2D available) {
return draw(g2, available, (_anchor & HORIZONTAL)!=0, (_anchor & INVERTED)!=0);
}
/**
* Draws the legend.
* @param graphics The graphics device.
* @param available The area available for drawing the chart.
* @param horizontal A flag indicating whether the legend items are laid out horizontally.
* @param inverted ???
* @return ???
*/
protected Rectangle2D draw(Graphics2D g2, Rectangle2D available,
boolean horizontal, boolean inverted) {
// find out how many series in dataset, but watch for null...
Dataset data = chart.getDataset();
String[] legendItemLabels = chart.getLegendItemLabels();
if (legendItemLabels!=null) {
Rectangle2D legendArea = new Rectangle2D.Double();
// the translation point for the origin of the drawing system
Point2D translation = new Point2D.Double();
// Create buffer for individual rectangles within the legend
LegendItem[] items = new LegendItem[legendItemLabels.length];
g2.setFont(itemFont);
HashSet usedLabels = new HashSet(legendItemLabels.length);
// Compute individual rectangles in the legend, translation point as well
// as the bounding box for the legend.
if (horizontal) {
double xstart = available.getX()+outerGap;
double xlimit = available.getX()+available.getWidth()-2*outerGap-1;
double maxRowWidth = 0;
double xoffset = 0;
double rowHeight = 0;
double totalHeight = 0;
boolean startingNewRow = true;
for (int i=0; i<legendItemLabels.length; i++) {
if (usedLabels.contains(legendItemLabels))
continue;
items = createLegendItem(g2, legendItemLabels, xoffset, totalHeight);
if ((!startingNewRow) && (items.getX()+items.getWidth()+xstart>xlimit)) {
maxRowWidth=Math.max(maxRowWidth, xoffset);
xoffset = 0;
totalHeight += rowHeight;
i--;
startingNewRow=true;
}
else {
usedLabels.add(legendItemLabels[i]);
rowHeight = Math.max(rowHeight, items[i].getHeight());
xoffset += items[i].getWidth();
startingNewRow=false;
}
}
maxRowWidth=Math.max(maxRowWidth, xoffset);
totalHeight += rowHeight;
// Create the bounding box
legendArea = new Rectangle2D.Double(0, 0, maxRowWidth, totalHeight);
// The yloc point is the variable part of the translation point
// for horizontal legends. xloc is constant.
double yloc = (inverted) ?
available.getY() + available.getHeight() - totalHeight - outerGap :
available.getY() + outerGap;
double xloc = available.getX() + available.getWidth()/2 - maxRowWidth/2;
// Create the translation point
translation = new Point2D.Double(xloc,yloc);
}
else { // vertical...
double totalHeight = 0;
double maxWidth = 0;
g2.setFont(itemFont);
for (int i = 0; i < items.length; i++) {
if (usedLabels.contains(legendItemLabels[i]))
continue;
usedLabels.add(legendItemLabels[i]);
items[i] = createLegendItem(g2, legendItemLabels[i], 0, totalHeight);
totalHeight +=items[i].getHeight();
maxWidth = Math.max(maxWidth, items[i].getWidth());
}
// Create the bounding box
legendArea = new Rectangle2D.Float(0, 0, (float)maxWidth, (float)totalHeight);
// The xloc point is the variable part of the translation point
// for vertical legends. yloc is constant.
double xloc = (inverted) ?
available.getMaxX()-maxWidth-outerGap:
available.getX()+outerGap;
double yloc = available.getY()+(available.getHeight()/2)-(totalHeight/2);
// Create the translation point
translation = new Point2D.Double(xloc, yloc);
}
// Move the origin of the drawing to the appropriate location
g2.translate(translation.getX(), translation.getY());
// Draw the legend's bounding box
g2.setPaint(backgroundPaint);
g2.fill(legendArea);
g2.setPaint(outlinePaint);
g2.setStroke(outlineStroke);
g2.draw(legendArea);
// Draw individual series elements
for (int i=0; i<items.length; i++) {
if (items[i] == null)
continue;
g2.setPaint(chart.getPlot().getSeriesPaint(i));
g2.fill(items[i].getMarker());
g2.setPaint(itemPaint);
g2.drawString(items[i].label,
(float)items[i].labelPosition.getX(),
(float)items[i].labelPosition.getY());
}
// translate the origin back to what it was prior to drawing the legend
g2.translate(-translation.getX(),-translation.getY());
if (horizontal) {
// The remaining drawing area bounding box will have the same x origin,
// width and height independent of the anchor's location. The variable
// is the y coordinate. If the anchor is SOUTH, the y coordinate is simply
// the original y coordinate of the available area. If it is NORTH, we
// adjust original y by the total height of the legend and the initial gap.
double yloc = (inverted) ? available.getY() :
available.getY()+legendArea.getHeight()+outerGap;
// return the remaining available drawing area
return new Rectangle2D.Double(available.getX(), yloc, available.getWidth(),
available.getHeight()-legendArea.getHeight()-2*outerGap);
}
else {
// The remaining drawing area bounding box will have the same y origin,
// width and height independent of the anchor's location. The variable
// is the x coordinate. If the anchor is EAST, the x coordinate is simply
// the original x coordinate of the available area. If it is WEST, we
// adjust original x by the total width of the legend and the initial gap.
double xloc = (inverted) ? available.getX() :
available.getX()+legendArea.getWidth()+2*outerGap;
// return the remaining available drawing area
return new Rectangle2D.Double(xloc, available.getY(),
available.getWidth()-legendArea.getWidth()-2 * outerGap,
available.getHeight());
}
}
else {
return available;
}
}
/**
* Returns a box that will be positioned next to the name of the specified series within the
* legend area. The box will be square and 65% of the height of a line.
*/
private Rectangle2D getLegendBox(int series, int seriesCount, float textHeight,
Rectangle2D innerLegendArea) {
int innerGap = 2; // added to make this compile
float boxHeightAndWidth = textHeight*0.70f;
float xx = (float)innerLegendArea.getX()+innerGap+0.15f*textHeight;
float yy = (float)innerLegendArea.getY()+innerGap+(series+0.15f)*textHeight;
return new Rectangle2D.Float(xx, yy, boxHeightAndWidth, boxHeightAndWidth);
}
/**
ÿ ÿ * Returns a rectangle surrounding a individual entry in the legend.
ÿ ÿ * <P>
* The marker box for each entry will be positioned next to the name of the specified series
* within the legend area. The marker box will be square and 70% of the height of current
* font.
ÿ ÿ * @param graphics The graphics context (supplies font metrics etc.).
ÿ ÿ * @param label The series name.
ÿ ÿ * @param x The upper left x coordinate for the bounding box.
ÿ ÿ * @param y The upper left y coordinate for the bounding box.
ÿ ÿ* @return A LegendItem encapsulating all necessary info for drawing.
ÿ ÿ*/
private LegendItem createLegendItem(Graphics graphics, String label, double x, double y) {
int innerGap = 2;
FontMetrics fm = graphics.getFontMetrics();
LineMetrics lm = fm.getLineMetrics(label, graphics);
float textHeight = lm.getHeight();
LegendItem item = new LegendItem(label);
float xloc = (float)(x+innerGap+1.15f*textHeight);
float yloc = (float)(y+innerGap+(textHeight-lm.getLeading()-lm.getDescent()));
item.labelPosition = new Point2D.Float(xloc, yloc);
float boxDim = textHeight*0.70f;
xloc = (float)(x+innerGap+0.15f*textHeight);
yloc = (float)(y+innerGap+0.15f*textHeight);
item.setMarker(new Rectangle2D.Float(xloc, yloc, boxDim, boxDim));
float width = (float)(item.labelPosition.getX()-x+
fm.getStringBounds(label,graphics).getWidth()+0.5*textHeight);
float height = (float)(2*innerGap+textHeight);
item.setBounds(x, y, width, height);
return item;
}
}
-
David Gilbert
Re: Showing a gap in a BasicTimeSeries
Hi Graham,
Thanks for the code. I'm thinking about some options for suppressing certain legend items (to go along with some changes I have already made to the legend mechanism), so I will look through what you have done.
But the easy solution for you is to add a null data value anywhere between the two data values that you don't want to have connected by a line. There's an example in the TimeSeriesDemo2 application:
series.add(new Quarter(2, 2002), null);
Regards,
DG.
Thanks for the code. I'm thinking about some options for suppressing certain legend items (to go along with some changes I have already made to the legend mechanism), so I will look through what you have done.
But the easy solution for you is to add a null data value anywhere between the two data values that you don't want to have connected by a line. There's an example in the TimeSeriesDemo2 application:
series.add(new Quarter(2, 2002), null);
Regards,
DG.