Class CategoryPlot
- All Implemented Interfaces:
Serializable
,Cloneable
,EventListener
,AxisChangeListener
,RendererChangeListener
,ValueAxisPlot
,DatasetChangeListener
,org.jfree.util.PublicCloneable
- Direct Known Subclasses:
CombinedDomainCategoryPlot
,CombinedRangeCategoryPlot
public class CategoryPlot extends Plot implements ValueAxisPlot, RendererChangeListener, Cloneable, org.jfree.util.PublicCloneable, Serializable
CategoryDataset
and
renders each data item using a CategoryItemRenderer
.- See Also:
- Serialized Form
-
Field Summary
Fields Modifier and Type Field Description static boolean
DEFAULT_DOMAIN_GRIDLINES_VISIBLE
The default visibility of the grid lines plotted against the domain axis.static Paint
DEFAULT_GRIDLINE_PAINT
The default grid line paint.static Stroke
DEFAULT_GRIDLINE_STROKE
The default grid line stroke.static boolean
DEFAULT_RANGE_GRIDLINES_VISIBLE
The default visibility of the grid lines plotted against the range axis.static Font
DEFAULT_VALUE_LABEL_FONT
The default value label font.Fields inherited from class org.jfree.chart.plot.Plot
DEFAULT_BACKGROUND_ALPHA, DEFAULT_BACKGROUND_PAINT, DEFAULT_FOREGROUND_ALPHA, DEFAULT_INSETS, DEFAULT_OUTLINE_PAINT, DEFAULT_OUTLINE_STROKE, MINIMUM_HEIGHT_TO_DRAW, MINIMUM_WIDTH_TO_DRAW, ZERO
-
Constructor Summary
Constructors Constructor Description CategoryPlot()
Default constructor.CategoryPlot(CategoryDataset dataset, CategoryAxis domainAxis, ValueAxis rangeAxis, CategoryItemRenderer renderer)
Creates a new plot. -
Method Summary
Modifier and Type Method Description void
addAnnotation(CategoryAnnotation annotation)
Adds an annotation to the plot.void
addRangeMarker(int index, Marker marker, org.jfree.ui.Layer layer)
Adds a marker for display by a particular renderer.void
addRangeMarker(Marker marker)
Adds a marker for display (in the foreground) against the range axis and sends aPlotChangeEvent
to all registered listeners.void
addRangeMarker(Marker marker, org.jfree.ui.Layer layer)
Adds a marker for display against the range axis and sends aPlotChangeEvent
to all registered listeners.void
clearDomainAxes()
Clears the domain axes from the plot and sends aPlotChangeEvent
to all registered listeners.void
clearRangeAxes()
Clears the range axes from the plot and sends aPlotChangeEvent
to all registered listeners.void
clearRangeMarkers()
Clears all the range markers for the plot and sends aPlotChangeEvent
to all registered listeners.void
clearRangeMarkers(int index)
Clears all the range markers for the specified renderer.Object
clone()
Returns a clone of the plot.void
configureDomainAxes()
Configures the domain axes.void
configureRangeAxes()
Configures the range axes.void
datasetChanged(DatasetChangeEvent event)
Receives notification of a change to the plot's dataset.void
draw(Graphics2D g2, Rectangle2D plotArea, PlotState parentState, PlotRenderingInfo state)
Draws the plot on a Java 2D graphics device (such as the screen or a printer).boolean
equals(Object object)
Tests the plot for equality with an arbitrary object.double
getAnchorValue()
Returns the anchor value.List
getAnnotations()
Returns the list of annotations.org.jfree.ui.Spacer
getAxisOffset()
Returns the axis offset.List
getCategories()
Returns a list of the categories for the plot.org.jfree.util.SortOrder
getColumnRenderingOrder()
Returns the order in which the columns are rendered.Range
getDataRange(ValueAxis axis)
Returns the range of data values that will be plotted against the range axis.CategoryDataset
getDataset()
Returns the primary dataset for the plot.CategoryDataset
getDataset(int index)
Returns a dataset.DatasetRenderingOrder
getDatasetRenderingOrder()
Returns the dataset rendering order.CategoryAxis
getDomainAxis()
Returns the domain axis for the plot.CategoryAxis
getDomainAxis(int index)
Returns a domain axis.org.jfree.ui.RectangleEdge
getDomainAxisEdge()
Returns the domain axis edge.org.jfree.ui.RectangleEdge
getDomainAxisEdge(int index)
Returns the edge for a domain axis.CategoryAxis
getDomainAxisForDataset(int index)
Returns the domain axis for a dataset.AxisLocation
getDomainAxisLocation()
Returns the domain axis location.AxisLocation
getDomainAxisLocation(int index)
Returns the location for a domain axis.Paint
getDomainGridlinePaint()
Returns the paint used to draw grid-lines against the domain axis.CategoryAnchor
getDomainGridlinePosition()
Returns the position used for the domain gridlines.Stroke
getDomainGridlineStroke()
Returns the stroke used to draw grid-lines against the domain axis.boolean
getDrawSharedDomainAxis()
Returns the flag that controls whether or not the shared domain axis is drawn for each subplot.AxisSpace
getFixedDomainAxisSpace()
Returns the fixed domain axis space.LegendItemCollection
getFixedLegendItems()
Returns the fixed legend items, if any.AxisSpace
getFixedRangeAxisSpace()
Returns the fixed range axis space.LegendItemCollection
getLegendItems()
Returns the legend items for the plot.PlotOrientation
getOrientation()
Returns the orientation of the plot.String
getPlotType()
Returns a string describing the type of plot.ValueAxis
getRangeAxis()
Returns the range axis for the plot.ValueAxis
getRangeAxis(int index)
Returns a range axis.org.jfree.ui.RectangleEdge
getRangeAxisEdge()
Returns the edge where the primary range axis is located.org.jfree.ui.RectangleEdge
getRangeAxisEdge(int index)
Returns the edge for a range axis.ValueAxis
getRangeAxisForDataset(int index)
Returns the range axis for a dataset.AxisLocation
getRangeAxisLocation()
Returns the range axis location.AxisLocation
getRangeAxisLocation(int index)
Returns the location for a range axis.Paint
getRangeCrosshairPaint()
Returns the range crosshair color.Stroke
getRangeCrosshairStroke()
Returns the pen-style (Stroke
) used to draw the crosshair (if visible).double
getRangeCrosshairValue()
Returns the range crosshair value.Paint
getRangeGridlinePaint()
Returns the paint used to draw the grid-lines against the range axis.Stroke
getRangeGridlineStroke()
Returns the stroke used to draw the grid-lines against the range axis.Collection
getRangeMarkers(int index, org.jfree.ui.Layer layer)
Returns a collection of range markers for a particular renderer and layer.Collection
getRangeMarkers(org.jfree.ui.Layer layer)
Returns the list of range markers (read only) for the specified layer.CategoryItemRenderer
getRenderer()
Returns a reference to the renderer for the plot.CategoryItemRenderer
getRenderer(int index)
Returns a renderer.CategoryItemRenderer
getRendererForDataset(CategoryDataset d)
Returns the renderer for the specified dataset.org.jfree.util.SortOrder
getRowRenderingOrder()
Returns the order in which the rows should be rendered.int
getWeight()
Returns the weight for this plot when it is used as a subplot within a combined plot.void
handleClick(int x, int y, PlotRenderingInfo info)
Handles a 'click' on the plot by updating the anchor value.boolean
isDomainGridlinesVisible()
Returns the flag that controls whether the domain grid-lines are visible.boolean
isRangeCrosshairLockedOnData()
Returns a flag indicating whether or not the crosshair should "lock-on" to actual data values.boolean
isRangeCrosshairVisible()
Returns a flag indicating whether or not the range crosshair is visible.boolean
isRangeGridlinesVisible()
Returns the flag that controls whether the range grid-lines are visible.void
mapDatasetToDomainAxis(int index, int axisIndex)
Maps a dataset to a particular domain axis.void
mapDatasetToRangeAxis(int index, int axisIndex)
Maps a dataset to a particular range axis.boolean
render(Graphics2D g2, Rectangle2D dataArea, int index, PlotRenderingInfo info)
Draws a representation of a dataset within the dataArea region using the appropriate renderer.void
rendererChanged(RendererChangeEvent event)
Receives notification of a renderer change event.void
setAnchorValue(double value)
Sets the anchor value.void
setAnchorValue(double value, boolean notify)
Sets the anchor value.void
setAxisOffset(org.jfree.ui.Spacer offset)
Sets the axis offsets (gap between the data area and the axes).void
setCategoryBackgroundPaint(Color color)
void
setCategoryBackgroundPaintA(int index, Color color)
void
setCategoryBackgroundPaintC(int index, Color color)
void
setColumnRenderingOrder(org.jfree.util.SortOrder order)
Sets the order in which the columns should be rendered.void
setDataset(int index, CategoryDataset dataset)
Sets a dataset for the plot.void
setDataset(CategoryDataset dataset)
Sets the dataset for the plot, replacing the existing dataset, if there is one.void
setDatasetRenderingOrder(DatasetRenderingOrder order)
Sets the rendering order and sends aPlotChangeEvent
to all registered listeners.void
setDomainAxis(int index, CategoryAxis axis)
Sets a domain axis.void
setDomainAxis(CategoryAxis axis)
Sets the domain axis for the plot and sends aPlotChangeEvent
to all registered listeners.void
setDomainAxisLocation(int index, AxisLocation location)
Sets the location for a domain axis and sends aPlotChangeEvent
to all registered listeners.void
setDomainAxisLocation(AxisLocation location)
Sets the location of the domain axis and sends aPlotChangeEvent
to all registered listeners.void
setDomainAxisLocation(AxisLocation location, boolean notify)
Sets the location of the domain axis.void
setDomainGridlinePaint(Paint paint)
Sets the paint used to draw the grid-lines (if any) against the domain axis.void
setDomainGridlinePosition(CategoryAnchor position)
Sets the position used for the domain gridlines.void
setDomainGridlineStroke(Stroke stroke)
Sets the stroke used to draw grid-lines against the domain axis.void
setDomainGridlinesVisible(boolean visible)
Sets the flag that controls whether or not grid-lines are drawn against the domain axis.void
setDrawSharedDomainAxis(boolean draw)
Sets the flag that controls whether the shared domain axis is drawn when this plot is being used as a subplot.void
setFixedDomainAxisSpace(AxisSpace space)
Sets the fixed domain axis space.void
setFixedLegendItems(LegendItemCollection items)
Sets the fixed legend items for the plot.void
setFixedRangeAxisSpace(AxisSpace space)
Sets the fixed range axis space.void
setOrientation(PlotOrientation orientation)
Sets the orientation for the plot and sends aPlotChangeEvent
to all registered listeners.void
setRangeAxis(int index, ValueAxis axis)
Sets a range axis.void
setRangeAxis(ValueAxis axis)
Sets the range axis for the plot and sends aPlotChangeEvent
to all registered listeners.void
setRangeAxisLocation(int index, AxisLocation location)
Sets the location for a range axis and sends aPlotChangeEvent
to all registered listeners.void
setRangeAxisLocation(int index, AxisLocation location, boolean notify)
Sets the location for a range axis and sends aPlotChangeEvent
to all registered listeners.void
setRangeAxisLocation(AxisLocation location)
Sets the location of the range axis and sends aPlotChangeEvent
to all registered listeners.void
setRangeAxisLocation(AxisLocation location, boolean notify)
Sets the location of the range axis and, if requested, sends aPlotChangeEvent
to all registered listeners.void
setRangeCrosshairLockedOnData(boolean flag)
Sets the flag indicating whether or not the range crosshair should "lock-on" to actual data values.void
setRangeCrosshairPaint(Paint paint)
Sets the Paint used to color the crosshairs (if visible) and notifies registered listeners that the axis has been modified.void
setRangeCrosshairStroke(Stroke stroke)
Sets the pen-style (Stroke
) used to draw the crosshairs (if visible).void
setRangeCrosshairValue(double value)
Sets the domain crosshair value.void
setRangeCrosshairValue(double value, boolean notify)
Sets the range crosshair value.void
setRangeCrosshairVisible(boolean flag)
Sets the flag indicating whether or not the range crosshair is visible.void
setRangeGridlinePaint(Paint paint)
Sets the paint used to draw the grid lines against the range axis.void
setRangeGridlineStroke(Stroke stroke)
Sets the stroke used to draw the grid-lines against the range axis.void
setRangeGridlinesVisible(boolean visible)
Sets the flag that controls whether or not grid-lines are drawn against the range axis.void
setRenderer(int index, CategoryItemRenderer renderer)
Sets the renderer at the specified index and sends aPlotChangeEvent
to all registered listeners.void
setRenderer(int index, CategoryItemRenderer renderer, boolean notify)
Sets a renderer.void
setRenderer(CategoryItemRenderer renderer)
Sets the renderer at index 0 (sometimes referred to as the "primary" renderer) and sends aPlotChangeEvent
to all registered listeners.void
setRenderer(CategoryItemRenderer renderer, boolean notify)
Sets the renderer at index 0 (sometimes referred to as the "primary" renderer) and, if requested, sends aPlotChangeEvent
to all registered listeners.void
setRowRenderingOrder(org.jfree.util.SortOrder order)
Sets the order in which the rows should be rendered.void
setSkipLabels(int skipValue)
void
setWeight(int weight)
Sets the weight for the plot.void
zoom(double percent)
Zooms (in or out) on the plot's value axis.void
zoomHorizontalAxes(double factor)
Multiplies the range on the horizontal axis/axes by the specified factor.void
zoomHorizontalAxes(double lowerPercent, double upperPercent)
Zooms in on the horizontal axes.void
zoomVerticalAxes(double factor)
Multiplies the range on the vertical axis/axes by the specified factor.void
zoomVerticalAxes(double lowerPercent, double upperPercent)
Zooms in on the vertical axes.Methods inherited from class org.jfree.chart.plot.Plot
addChangeListener, axisChanged, draw, drawBackground, drawOutline, getBackgroundAlpha, getBackgroundImage, getBackgroundImageAlignment, getBackgroundPaint, getDataAreaRatio, getDatasetGroup, getDrawingSupplier, getForegroundAlpha, getInsets, getNoDataMessage, getNoDataMessageFont, getNoDataMessagePaint, getOutlinePaint, getOutlineStroke, getParent, getRootPlot, isPlotShowing, isSubplot, notifyListeners, removeChangeListener, resolveDomainAxisLocation, resolveRangeAxisLocation, setBackgroundAlpha, setBackgroundImage, setBackgroundImageAlignment, setBackgroundPaint, setDataAreaRatio, setDrawingSupplier, setForegroundAlpha, setInsets, setInsets, setNoDataMessage, setNoDataMessageFont, setNoDataMessagePaint, setOutlinePaint, setOutlineStroke, setParent, setPlotShowing
-
Field Details
-
DEFAULT_DOMAIN_GRIDLINES_VISIBLE
public static final boolean DEFAULT_DOMAIN_GRIDLINES_VISIBLEThe default visibility of the grid lines plotted against the domain axis.- See Also:
- Constant Field Values
-
DEFAULT_RANGE_GRIDLINES_VISIBLE
public static final boolean DEFAULT_RANGE_GRIDLINES_VISIBLEThe default visibility of the grid lines plotted against the range axis.- See Also:
- Constant Field Values
-
DEFAULT_GRIDLINE_STROKE
The default grid line stroke. -
DEFAULT_GRIDLINE_PAINT
The default grid line paint. -
DEFAULT_VALUE_LABEL_FONT
The default value label font.
-
-
Constructor Details
-
CategoryPlot
public CategoryPlot()Default constructor. -
CategoryPlot
public CategoryPlot(CategoryDataset dataset, CategoryAxis domainAxis, ValueAxis rangeAxis, CategoryItemRenderer renderer)Creates a new plot.- Parameters:
dataset
- the dataset (null
permitted).domainAxis
- the domain axis (null
permitted).rangeAxis
- the range axis (null
permitted).renderer
- the item renderer (null
permitted).
-
-
Method Details
-
getPlotType
Returns a string describing the type of plot.- Specified by:
getPlotType
in classPlot
- Returns:
- The type.
-
getOrientation
Returns the orientation of the plot.- Returns:
- The orientation of the plot.
-
setOrientation
Sets the orientation for the plot and sends aPlotChangeEvent
to all registered listeners.- Parameters:
orientation
- the orientation (null
not permitted).
-
getAxisOffset
public org.jfree.ui.Spacer getAxisOffset()Returns the axis offset.- Returns:
- the axis offset.
-
setAxisOffset
public void setAxisOffset(org.jfree.ui.Spacer offset)Sets the axis offsets (gap between the data area and the axes).- Parameters:
offset
- the offset.
-
getDomainAxis
Returns the domain axis for the plot. If the domain axis for this plot isnull
, then the method will return the parent plot's domain axis (if there is a parent plot).- Returns:
- The domain axis (
null
permitted).
-
getDomainAxis
Returns a domain axis.- Parameters:
index
- the axis index.- Returns:
- The axis (
null
possible).
-
setDomainAxis
Sets the domain axis for the plot and sends aPlotChangeEvent
to all registered listeners.- Parameters:
axis
- the axis (null
permitted).
-
setDomainAxis
Sets a domain axis.- Parameters:
index
- the axis index.axis
- the axis.
-
getDomainAxisLocation
Returns the domain axis location.- Returns:
- The location (never
null
).
-
getDomainAxisLocation
Returns the location for a domain axis.- Parameters:
index
- the axis index.- Returns:
- The location.
-
setDomainAxisLocation
Sets the location of the domain axis and sends aPlotChangeEvent
to all registered listeners.- Parameters:
location
- the axis location (null
not permitted).
-
setDomainAxisLocation
Sets the location of the domain axis.- Parameters:
location
- the axis location (null
not permitted).notify
- a flag that controls whether listeners are notified.
-
setDomainAxisLocation
Sets the location for a domain axis and sends aPlotChangeEvent
to all registered listeners.- Parameters:
index
- the axis index.location
- the location.
-
getDomainAxisEdge
public org.jfree.ui.RectangleEdge getDomainAxisEdge()Returns the domain axis edge. This is derived from the axis location and the plot orientation.- Returns:
- the edge (never
null
).
-
getDomainAxisEdge
public org.jfree.ui.RectangleEdge getDomainAxisEdge(int index)Returns the edge for a domain axis.- Parameters:
index
- the axis index.- Returns:
- The edge (never
null
).
-
clearDomainAxes
public void clearDomainAxes()Clears the domain axes from the plot and sends aPlotChangeEvent
to all registered listeners. -
configureDomainAxes
public void configureDomainAxes()Configures the domain axes. -
getRangeAxis
Returns the range axis for the plot. If the range axis for this plot is null, then the method will return the parent plot's range axis (if there is a parent plot).- Returns:
- The range axis (possibly
null
).
-
getRangeAxis
Returns a range axis.- Parameters:
index
- the axis index.- Returns:
- The axis (
null
possible).
-
setRangeAxis
Sets the range axis for the plot and sends aPlotChangeEvent
to all registered listeners.- Parameters:
axis
- the axis (null
permitted).
-
setRangeAxis
Sets a range axis.- Parameters:
index
- the axis index.axis
- the axis.
-
getRangeAxisLocation
Returns the range axis location.- Returns:
- the location (never
null
).
-
getRangeAxisLocation
Returns the location for a range axis.- Parameters:
index
- the axis index.- Returns:
- The location.
-
setRangeAxisLocation
Sets the location of the range axis and sends aPlotChangeEvent
to all registered listeners.- Parameters:
location
- the location (null
not permitted).
-
setRangeAxisLocation
Sets the location of the range axis and, if requested, sends aPlotChangeEvent
to all registered listeners.- Parameters:
location
- the location (null
not permitted).notify
- notify listeners?
-
setRangeAxisLocation
Sets the location for a range axis and sends aPlotChangeEvent
to all registered listeners.- Parameters:
index
- the axis index.location
- the location.
-
setRangeAxisLocation
Sets the location for a range axis and sends aPlotChangeEvent
to all registered listeners.- Parameters:
index
- the axis index.location
- the location.notify
- notify listeners?
-
getRangeAxisEdge
public org.jfree.ui.RectangleEdge getRangeAxisEdge()Returns the edge where the primary range axis is located.- Returns:
- The edge (never
null
).
-
getRangeAxisEdge
public org.jfree.ui.RectangleEdge getRangeAxisEdge(int index)Returns the edge for a range axis.- Parameters:
index
- the axis index.- Returns:
- The edge.
-
clearRangeAxes
public void clearRangeAxes()Clears the range axes from the plot and sends aPlotChangeEvent
to all registered listeners. -
configureRangeAxes
public void configureRangeAxes()Configures the range axes. -
getDataset
Returns the primary dataset for the plot.- Returns:
- The primary dataset (possibly
null
).
-
getDataset
Returns a dataset.- Parameters:
index
- the dataset index.- Returns:
- The dataset (possibly
null
).
-
setDataset
Sets the dataset for the plot, replacing the existing dataset, if there is one. This method also calls thedatasetChanged(DatasetChangeEvent)
method, which adjusts the axis ranges if necessary and sends aPlotChangeEvent
to all registered listeners.- Parameters:
dataset
- the dataset (null
permitted).
-
setDataset
Sets a dataset for the plot.- Parameters:
index
- the dataset index.dataset
- the dataset (null
permitted).
-
mapDatasetToDomainAxis
public void mapDatasetToDomainAxis(int index, int axisIndex)Maps a dataset to a particular domain axis.- Parameters:
index
- the dataset index (zero-based).axisIndex
- the axis index (zero-based).
-
getDomainAxisForDataset
Returns the domain axis for a dataset. You can change the axis for a dataset using the mapDatasetToDomainAxis() method.- Parameters:
index
- the dataset index.- Returns:
- The domain axis.
-
mapDatasetToRangeAxis
public void mapDatasetToRangeAxis(int index, int axisIndex)Maps a dataset to a particular range axis.- Parameters:
index
- the dataset index (zero-based).axisIndex
- the axis index (zero-based).
-
getRangeAxisForDataset
Returns the range axis for a dataset. You can change the axis for a dataset using the mapDatasetToRangeAxis() method.- Parameters:
index
- the dataset index.- Returns:
- The range axis.
-
getRenderer
Returns a reference to the renderer for the plot.- Returns:
- The renderer.
-
getRenderer
Returns a renderer.- Parameters:
index
- the renderer index.- Returns:
- The renderer (possibly
null
).
-
setRenderer
Sets the renderer at index 0 (sometimes referred to as the "primary" renderer) and sends aPlotChangeEvent
to all registered listeners.- Parameters:
renderer
- the renderer (null
permitted.
-
setRenderer
Sets the renderer at index 0 (sometimes referred to as the "primary" renderer) and, if requested, sends aPlotChangeEvent
to all registered listeners.You can set the renderer to
null
, but this is not recommended because:- no data will be displayed;
- the plot background will not be painted;
- Parameters:
renderer
- the renderer (null
permitted).notify
- notify listeners?
-
setRenderer
Sets the renderer at the specified index and sends aPlotChangeEvent
to all registered listeners.- Parameters:
index
- the index.renderer
- the renderer (null
permitted).
-
setRenderer
Sets a renderer. APlotChangeEvent
is sent to all registered listeners.- Parameters:
index
- the index.renderer
- the renderer (null
permitted).notify
- notify listeners?
-
getRendererForDataset
Returns the renderer for the specified dataset.- Parameters:
d
- the dataset (null
permitted).- Returns:
- the renderer (possibly
null
).
-
getDatasetRenderingOrder
Returns the dataset rendering order.- Returns:
- The order (never
null
).
-
setDatasetRenderingOrder
Sets the rendering order and sends aPlotChangeEvent
to all registered listeners. By default, the plot renders the primary dataset last (so that the primary dataset overlays the secondary datasets). You can reverse this if you want to.- Parameters:
order
- the rendering order (null
not permitted).
-
getColumnRenderingOrder
public org.jfree.util.SortOrder getColumnRenderingOrder()Returns the order in which the columns are rendered.- Returns:
- The order.
-
setColumnRenderingOrder
public void setColumnRenderingOrder(org.jfree.util.SortOrder order)Sets the order in which the columns should be rendered.- Parameters:
order
- the order.
-
getRowRenderingOrder
public org.jfree.util.SortOrder getRowRenderingOrder()Returns the order in which the rows should be rendered.- Returns:
- the order (never
null
).
-
setRowRenderingOrder
public void setRowRenderingOrder(org.jfree.util.SortOrder order)Sets the order in which the rows should be rendered.- Parameters:
order
- the order (null
not allowed).
-
isDomainGridlinesVisible
public boolean isDomainGridlinesVisible()Returns the flag that controls whether the domain grid-lines are visible.- Returns:
- the
true
orfalse
.
-
setDomainGridlinesVisible
public void setDomainGridlinesVisible(boolean visible)Sets the flag that controls whether or not grid-lines are drawn against the domain axis.If the flag value changes, a
PlotChangeEvent
is sent to all registered listeners.- Parameters:
visible
- the new value of the flag.
-
getDomainGridlinePosition
Returns the position used for the domain gridlines.- Returns:
- The gridline position.
-
setDomainGridlinePosition
Sets the position used for the domain gridlines.- Parameters:
position
- the position.
-
getDomainGridlineStroke
Returns the stroke used to draw grid-lines against the domain axis.- Returns:
- the stroke.
-
setDomainGridlineStroke
Sets the stroke used to draw grid-lines against the domain axis. APlotChangeEvent
is sent to all registered listeners.- Parameters:
stroke
- the stroke.
-
getDomainGridlinePaint
Returns the paint used to draw grid-lines against the domain axis.- Returns:
- the paint.
-
setDomainGridlinePaint
Sets the paint used to draw the grid-lines (if any) against the domain axis. APlotChangeEvent
is sent to all registered listeners.- Parameters:
paint
- the paint.
-
isRangeGridlinesVisible
public boolean isRangeGridlinesVisible()Returns the flag that controls whether the range grid-lines are visible.- Returns:
- the flag.
-
setRangeGridlinesVisible
public void setRangeGridlinesVisible(boolean visible)Sets the flag that controls whether or not grid-lines are drawn against the range axis. If the flag changes value, aPlotChangeEvent
is sent to all registered listeners.- Parameters:
visible
- the new value of the flag.
-
getRangeGridlineStroke
Returns the stroke used to draw the grid-lines against the range axis.- Returns:
- the stroke.
-
setRangeGridlineStroke
Sets the stroke used to draw the grid-lines against the range axis. APlotChangeEvent
is sent to all registered listeners.- Parameters:
stroke
- the stroke.
-
getRangeGridlinePaint
Returns the paint used to draw the grid-lines against the range axis.- Returns:
- the paint.
-
setRangeGridlinePaint
Sets the paint used to draw the grid lines against the range axis. APlotChangeEvent
is sent to all registered listeners.- Parameters:
paint
- the paint.
-
getFixedLegendItems
Returns the fixed legend items, if any.- Returns:
- The legend items (possibly
null
).
-
setFixedLegendItems
Sets the fixed legend items for the plot. Leave this set tonull
if you prefer the legend items to be created automatically.- Parameters:
items
- the legend items (null
permitted).
-
getLegendItems
Returns the legend items for the plot. By default, this method creates a legend item for each series in each of the datasets. You can change this behaviour by overriding this method.- Overrides:
getLegendItems
in classPlot
- Returns:
- The legend items.
-
handleClick
Handles a 'click' on the plot by updating the anchor value.- Overrides:
handleClick
in classPlot
- Parameters:
x
- x-coordinate of the click (in Java2D space).y
- y-coordinate of the click (in Java2D space).info
- information about the plot's dimensions.
-
zoom
public void zoom(double percent)Zooms (in or out) on the plot's value axis.If the value 0.0 is passed in as the zoom percent, the auto-range calculation for the axis is restored (which sets the range to include the minimum and maximum data values, thus displaying all the data).
-
datasetChanged
Receives notification of a change to the plot's dataset.The range axis bounds will be recalculated if necessary.
- Specified by:
datasetChanged
in interfaceDatasetChangeListener
- Overrides:
datasetChanged
in classPlot
- Parameters:
event
- information about the event (not used here).
-
rendererChanged
Receives notification of a renderer change event.- Specified by:
rendererChanged
in interfaceRendererChangeListener
- Parameters:
event
- the event.
-
addRangeMarker
Adds a marker for display (in the foreground) against the range axis and sends aPlotChangeEvent
to all registered listeners. Typically a marker will be drawn by the renderer as a line perpendicular to the range axis, however this is entirely up to the renderer.- Parameters:
marker
- the marker (null
not permitted).
-
addRangeMarker
Adds a marker for display against the range axis and sends aPlotChangeEvent
to all registered listeners. Typically a marker will be drawn by the renderer as a line perpendicular to the range axis, however this is entirely up to the renderer.- Parameters:
marker
- the marker (null
not permitted).layer
- the layer (foreground or background) (null
not permitted).
-
addRangeMarker
Adds a marker for display by a particular renderer.Typically a marker will be drawn by the renderer as a line perpendicular to a range axis, however this is entirely up to the renderer.
- Parameters:
index
- the renderer index.marker
- the marker.layer
- the layer.
-
clearRangeMarkers
public void clearRangeMarkers()Clears all the range markers for the plot and sends aPlotChangeEvent
to all registered listeners. -
getRangeMarkers
Returns the list of range markers (read only) for the specified layer.- Parameters:
layer
- the layer (foreground or background).- Returns:
- The list of range markers.
-
getRangeMarkers
Returns a collection of range markers for a particular renderer and layer.- Parameters:
index
- the renderer index.layer
- the layer.- Returns:
- A collection of markers (possibly
null
).
-
clearRangeMarkers
public void clearRangeMarkers(int index)Clears all the range markers for the specified renderer.- Parameters:
index
- the renderer index.
-
isRangeCrosshairVisible
public boolean isRangeCrosshairVisible()Returns a flag indicating whether or not the range crosshair is visible.- Returns:
- the flag.
-
setRangeCrosshairVisible
public void setRangeCrosshairVisible(boolean flag)Sets the flag indicating whether or not the range crosshair is visible.- Parameters:
flag
- the new value of the flag.
-
isRangeCrosshairLockedOnData
public boolean isRangeCrosshairLockedOnData()Returns a flag indicating whether or not the crosshair should "lock-on" to actual data values.- Returns:
- the flag.
-
setRangeCrosshairLockedOnData
public void setRangeCrosshairLockedOnData(boolean flag)Sets the flag indicating whether or not the range crosshair should "lock-on" to actual data values.- Parameters:
flag
- the flag.
-
getRangeCrosshairValue
public double getRangeCrosshairValue()Returns the range crosshair value.- Returns:
- The value.
-
setRangeCrosshairValue
public void setRangeCrosshairValue(double value)Sets the domain crosshair value.Registered listeners are notified that the plot has been modified, but only if the crosshair is visible.
- Parameters:
value
- the new value.
-
setRangeCrosshairValue
public void setRangeCrosshairValue(double value, boolean notify)Sets the range crosshair value.Registered listeners are notified that the axis has been modified, but only if the crosshair is visible.
- Parameters:
value
- the new value.notify
- a flag that controls whether or not listeners are notified.
-
getRangeCrosshairStroke
Returns the pen-style (Stroke
) used to draw the crosshair (if visible).- Returns:
- the crosshair stroke.
-
setRangeCrosshairStroke
Sets the pen-style (Stroke
) used to draw the crosshairs (if visible). APlotChangeEvent
is sent to all registered listeners.- Parameters:
stroke
- the new crosshair stroke.
-
getRangeCrosshairPaint
Returns the range crosshair color.- Returns:
- the crosshair color.
-
setRangeCrosshairPaint
Sets the Paint used to color the crosshairs (if visible) and notifies registered listeners that the axis has been modified.- Parameters:
paint
- the new crosshair paint.
-
getAnnotations
Returns the list of annotations.- Returns:
- The list of annotations.
-
addAnnotation
Adds an annotation to the plot.- Parameters:
annotation
- the annotation.
-
draw
public void draw(Graphics2D g2, Rectangle2D plotArea, PlotState parentState, PlotRenderingInfo state)Draws the plot on a Java 2D graphics device (such as the screen or a printer).At your option, you may supply an instance of
PlotRenderingInfo
. If you do, it will be populated with information about the drawing, including various plot dimensions and tooltip info. -
render
Draws a representation of a dataset within the dataArea region using the appropriate renderer.- Parameters:
g2
- the graphics device.dataArea
- the region in which the data is to be drawn.index
- the dataset and renderer index.info
- an optional object for collection dimension information.- Returns:
- A boolean that indicates whether or not real data was found.
-
setSkipLabels
public void setSkipLabels(int skipValue) -
setCategoryBackgroundPaintA
-
setCategoryBackgroundPaint
-
setCategoryBackgroundPaintC
-
getDataRange
Returns the range of data values that will be plotted against the range axis. If the dataset isnull
, this method returnsnull
.- Specified by:
getDataRange
in interfaceValueAxisPlot
- Parameters:
axis
- the axis.- Returns:
- The data range.
-
getWeight
public int getWeight()Returns the weight for this plot when it is used as a subplot within a combined plot.- Returns:
- the weight.
-
setWeight
public void setWeight(int weight)Sets the weight for the plot.- Parameters:
weight
- the weight.
-
getFixedDomainAxisSpace
Returns the fixed domain axis space.- Returns:
- The fixed domain axis space (possibly
null
).
-
setFixedDomainAxisSpace
Sets the fixed domain axis space.- Parameters:
space
- the space.
-
getFixedRangeAxisSpace
Returns the fixed range axis space.- Returns:
- The fixed range axis space.
-
setFixedRangeAxisSpace
Sets the fixed range axis space.- Parameters:
space
- the space.
-
getCategories
Returns a list of the categories for the plot.- Returns:
- A list of the categories for the plot.
-
zoomHorizontalAxes
public void zoomHorizontalAxes(double factor)Multiplies the range on the horizontal axis/axes by the specified factor.- Specified by:
zoomHorizontalAxes
in interfaceValueAxisPlot
- Parameters:
factor
- the zoom factor.
-
zoomHorizontalAxes
public void zoomHorizontalAxes(double lowerPercent, double upperPercent)Zooms in on the horizontal axes.- Specified by:
zoomHorizontalAxes
in interfaceValueAxisPlot
- Parameters:
lowerPercent
- the lower bound.upperPercent
- the upper bound.
-
zoomVerticalAxes
public void zoomVerticalAxes(double factor)Multiplies the range on the vertical axis/axes by the specified factor.- Specified by:
zoomVerticalAxes
in interfaceValueAxisPlot
- Parameters:
factor
- the zoom factor.
-
zoomVerticalAxes
public void zoomVerticalAxes(double lowerPercent, double upperPercent)Zooms in on the vertical axes.- Specified by:
zoomVerticalAxes
in interfaceValueAxisPlot
- Parameters:
lowerPercent
- the lower bound.upperPercent
- the upper bound.
-
getAnchorValue
public double getAnchorValue()Returns the anchor value.- Returns:
- The anchor value.
-
setAnchorValue
public void setAnchorValue(double value)Sets the anchor value.- Parameters:
value
- the anchor value.
-
setAnchorValue
public void setAnchorValue(double value, boolean notify)Sets the anchor value.- Parameters:
value
- the value.notify
- notify listeners?
-
equals
Tests the plot for equality with an arbitrary object. -
clone
Returns a clone of the plot.- Specified by:
clone
in interfaceorg.jfree.util.PublicCloneable
- Overrides:
clone
in classPlot
- Returns:
- A clone.
- Throws:
CloneNotSupportedException
- if the cloning is not supported.
-