- All Superinterfaces:
Axis3D
,ChartElement
- All Known Implementing Classes:
StandardCategoryAxis3D
An axis that displays categories and is used with a
CategoryPlot3D
for the row and column axes. Most of the methods in this interface are
intended to be called by the plot that the axis is assigned to, they won't
normally be called by external code.-
Method Summary
Modifier and TypeMethodDescriptionvoid
Configure the axis as a column axis for the specified plot.void
Configure the axis as a row axis for the specified plot.Returns a list of marker data instances for the markers that fall within the current axis range.Generates the tick data for the axis (assumes the axis is being used as the row axis).generateTickDataForRows
(CategoryDataset3D dataset) Generates the tick data for the axis (assumes the axis is being used as the row axis).double
getCategoryValue
(Comparable<?> category) Returns the numerical value along the axis that corresponds to the specified category.double
Returns the width of a single category in units corresponding to the current axis range.Returns the marker with the specified key, if there is one.boolean
Returnstrue
if this axis is being used as the column axis in a plot, andfalse
otherwise.boolean
Returnstrue
if this axis is being used as the row axis in a plot, andfalse
otherwise.Methods inherited from interface org.jfree.chart3d.axis.Axis3D
addChangeListener, draw, getLabelColor, getLabelFont, getRange, getTickLabelColor, getTickLabelFont, isInverted, isVisible, removeChangeListener, setInverted, setLabelColor, setLabelFont, setRange, setRange, setTickLabelColor, setTickLabelFont, setVisible, translateToWorld
Methods inherited from interface org.jfree.chart3d.ChartElement
receive
-
Method Details
-
isRowAxis
boolean isRowAxis()Returnstrue
if this axis is being used as the row axis in a plot, andfalse
otherwise.- Returns:
- A boolean.
- Since:
- 1.3
-
isColumnAxis
boolean isColumnAxis()Returnstrue
if this axis is being used as the column axis in a plot, andfalse
otherwise.- Returns:
- A boolean.
- Since:
- 1.3
-
configureAsRowAxis
Configure the axis as a row axis for the specified plot. Note that this method will be called by the plot, it will not normally be called by external code.- Parameters:
plot
- the plot (null
not permitted).
-
configureAsColumnAxis
Configure the axis as a column axis for the specified plot. Note that this method will be called by the plot, it will not normally be called by external code.- Parameters:
plot
- the plot (null
not permitted).
-
getCategoryWidth
double getCategoryWidth()Returns the width of a single category in units corresponding to the current axis range.- Returns:
- The width of a single category.
-
getCategoryValue
Returns the numerical value along the axis that corresponds to the specified category. If the category is unknown, this method will returnDouble.NaN
.- Parameters:
category
- the category (null
not permitted).- Returns:
- The axis value.
-
generateTickDataForRows
Generates the tick data for the axis (assumes the axis is being used as the row axis). The dataset is passed as an argument to provide the opportunity to incorporate dataset-specific info into tick labels (for example, a row label might show the total for that row in the dataset) ---whether or not this is used depends on the axis implementation.- Parameters:
dataset
- the dataset (null
not permitted).- Returns:
- The tick data.
- Since:
- 1.2
-
generateTickDataForColumns
Generates the tick data for the axis (assumes the axis is being used as the row axis). The dataset is passed as an argument to provide the opportunity to incorporate dataset-specific info into tick labels (for example, a row label might show the total for that row in the dataset) ---whether or not this is used depends on the axis implementation.- Parameters:
dataset
- the dataset (null
not permitted).- Returns:
- The tick data.
- Since:
- 1.2
-
generateMarkerData
Returns a list of marker data instances for the markers that fall within the current axis range.- Returns:
- A list of marker data.
-
getMarker
Returns the marker with the specified key, if there is one.- Parameters:
key
- the key (null
not permitted).- Returns:
- The marker (possibly
null
). - Since:
- 1.2
-