|
Chart Builder API (beta) | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.ord.media.chart.types.AxisDesc | +--oracle.ord.media.chart.types.TimeAxisDesc
TimeAxisDesc
objects are used to customize time axes,
and are normally supplied as arguments to setChartAttributes()
.
Users have control of all parameters inherited from AxisDesc
,
plus control over which time dimensions will be labeled.
In most cases, using the default settings will generate a visually
pleasing labeling of the time axis. However, in some cases,
users may wish to alter the minimum labeling dimension (using
setMinDimension()
) to avoid labeling
seconds or minutes, or alter the maximum labeling dimension (using
setMaxDimension()
) to avoid labeling
years.
Consider the following example, which sets the minimum (highest frequency)
dimension to be labeled to DAY
.
AxisChart myChart = new AxisChart(); ... TimeAxisDesc myTimeAxisDesc = new TimeAxisDesc(); myTimeAxisDesc.setMinDimension(TimeAxisDesc.DAY); myChart.setChartAttributes(myTimeAxisDesc);
AxisChart.setChartAttributes(TimeAxisDesc)
,
AxisDesc
Field Summary | |
static int |
DAY
Labeling constant for Days. |
static int |
DERIVED
Constant indicating that the dimension is derived by the system. |
static int |
HOUR
Labeling constant for Hours. |
static int |
MINUTE
Labeling constant for Minutes. |
static int |
MONTH
Labeling constant for Months. |
static int |
SECOND
Labeling constant for Seconds. |
static int |
YEAR
Labeling constant for Years. |
Constructor Summary | |
TimeAxisDesc()
|
Method Summary | |
int |
getField(int timeDimension)
Get the labeling convention for the specified time dimension. |
int |
getMaxDimension()
Return the maximum dimension. |
int |
getMinDimension()
Return the minimum dimension. |
int |
getMinLabelingLines()
Return the minimum number of lines used to label the X-axis. |
void |
setField(int timeDimension,
int field)
Set the labeling convention for the specified time dimension. |
void |
setMaxDimension(int timeDimension)
Set the maximum (lowest frequency) labeled dimension. |
void |
setMinDimension(int timeDimension)
Set the minimum (highest frequency) labeled dimension. |
void |
setMinLabelingLines(int numLabelingLines)
Set the minimum number of lines used to label the X-axis (for Strip charts). |
Methods inherited from class oracle.ord.media.chart.types.AxisDesc |
getColor, getDrawLabel, getFont, setColor, setDrawLabelOff, setFont |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int DERIVED
public static final int SECOND
public static final int MINUTE
public static final int HOUR
public static final int DAY
public static final int MONTH
public static final int YEAR
Constructor Detail |
public TimeAxisDesc()
Method Detail |
public void setMinDimension(int timeDimension) throws ChartException
timeDimension
- Valid values are TimeAxisDesc.SECOND
, TimeAxisDesc.MINUTE
, TimeAxisDesc.HOUR
, TimeAxisDesc.DAY
, TimeAxisDesc.MONTH
, or TimeAxisDesc.YEAR
.public void setMaxDimension(int timeDimension) throws ChartException
timeDimension
- Valid values are TimeAxisDesc.SECOND
, TimeAxisDesc.MINUTE
, TimeAxisDesc.HOUR
, TimeAxisDesc.DAY
, TimeAxisDesc.MONTH
, or TimeAxisDesc.YEAR
.public void setField(int timeDimension, int field) throws ChartException
Note: At this time, alternate labeling conventions are currently supported for only TimeAxisDesc.HOUR.
timeDimension
- The valid value is TimeAxisDesc.HOUR
.field
- Valid values are: Calendar.HOUR
, Calendar.HOUR_OF_DAY
public int getField(int timeDimension) throws ChartException
public int getMinDimension()
public int getMaxDimension()
public void setMinLabelingLines(int numLabelingLines)
public int getMinLabelingLines()
|
Chart Builder API (beta) | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |