public interface IAxis
gethXAxis() gethYAxis() gethZAxis() getAxis(int index)Various properties for an axis can be set/get by using the handle obtained for that axis as described above.
Modifier and Type | Method and Description |
---|---|
boolean |
areTickersInward()
This function is used to check if the tickers are drawn inward for the given axis.
|
boolean |
areTickersVisible()
This function is used to check if the tickers are drawn for the given axis.
|
double |
getBaseForLog()
This function is used to return a base for logarithmic for that axis.
|
java.awt.Color |
getColor()
Retrieve the color used to draw the axis.
|
java.awt.Color |
getGridColor()
This function is used to get the grid color of the axis(2D) or wall(3D).
|
double |
getGridHeightRatio()
This function returns grid height ratio for 2D chart.
|
int |
getGridThickness()
This function returns the thickness value of the X/Y grid lines.
|
ILabel |
gethLabel()
This function is used to get a handle to ILabel, which is used to set properties associated
with the labels for the axis.
|
ITextString |
gethTitle()
This function is used to get a handle to ITextString, which is used to set properties
associated with the title for the axis.
|
IFormat |
getLabelFormat()
This function is used to get the label format for the given axis.
|
int |
getLabelRowCount()
This function returns the number of rows used to display the x labels.
|
int |
getLabelStep()
This function returns the step size for the label display.
|
int |
getLabelUnit()
This function is used to obtain the unit information of the label Label unit is associated
with the individual column not the axis.
|
boolean |
getLogSubTickersState()
This function is used to check if sub-tickers are drawn for that axis.
Log scale must be on and log base must be 10. |
int |
getMaxLabelAndTickerCount()
This function returns the max number of the label and ticker display.
|
java.lang.Number |
getMaxScale()
Returns the maximum scale value that was defined for this axis.
|
java.lang.Number |
getMinScale()
Returns the minimum scale value that was defined for this axis.
|
java.lang.Number |
getOffset()
Returns the offset of the x-axis origin from the 0th position.
|
java.lang.Object[] |
getOriginalTickerLabels(boolean formatedLabel)
This function is used to get the original ticker labels or formatted ticker labels.
|
java.lang.Number |
getScaleStep()
Retruns the scale step size(interval) for this axis.
|
int |
getThickness()
This function is used to get the axis line thickness for a 2D chart.
|
java.awt.Color |
getTickerColor()
This function is used to get the ticker color of the axis(2D) or wall(3D).
|
int |
getTickerLabelsCount()
This function is used to get the ticker labels count.
|
int |
getTickerStep()
This function is used to retrieve the ticker step size for the given axis.
|
boolean |
hasArrowhead()
This function is used to check if arrow heads are currently drawn on the axes of the chart.
|
boolean |
isAxisPaddingAdded()
This function is used to check if the axis padding is added or not.
|
boolean |
isDateTimeDisplay()
Returns if the value axis label are displayed in DateTimeFormat, as opposed to NumericFormat.
|
boolean |
isDisplayByWeek()
Returns the state of the x-axis label display in day of the week fashion.
|
boolean |
isDisplayLabelAsDate()
Checks if numeric inputs for this axis is being displayed in the DateTime format.
|
boolean |
isGridAlignedWithTicker()
This function is used to check if grid lines are aligned with tickers.
|
boolean |
isGridInFront()
This function is used to check if grid lines are in front of the chart.
|
boolean |
isGridVisible()
This function returns the drawing status of the axis/wall grid.
|
boolean |
isLabelOutsidePlotArea()
This function is used to check if the tickers and labels are drawn outside chart plot area.
|
boolean |
isLogScale()
This function is used to check if a logarithmic scale is plotted for that axis.
|
boolean |
isOriginAutomatic()
This function is used to check if the origin is calculated automatically or not
The axis being checked depends on the axis handle used.
|
boolean |
isScaleAutomatic()
This function is used to check if the scale min, max, and step sizes are calculated
automatically or not.
|
boolean |
isShowLogValue()
This function is used to check if a logarithmic value is shown for that axis.
|
boolean |
isSkipGridOffset()
This function returns the status of skipping gridline offset.
|
boolean |
isVisible()
Get the display status of the x, y, or z axis (2D) or xy, yz, xz wall (3D) for the chart.
|
void |
setArrowhead(boolean drawArrows)
This function is used to draw/hide arrow heads on the axes in the chart.
|
void |
setAxisPaddingAdded(boolean b)
This function is used to enable/ disable adding axis padding.
|
void |
setBaseForLog(double logBase)
This function is used to set a base for logarithmic for that axis.
|
void |
setColor(java.awt.Color c)
Set the color for all the axes.
|
void |
setDateTimeDisplay(boolean state)
Specifies if the value axis labels are displayed in the DateTimeFormat
|
void |
setDisplayByWeek(boolean state)
Sets the state of the x-axis label display in day of the week fashion.
|
void |
setDisplayLabelAsDate(boolean b)
Sets numeric inputs for this axis to be displayed in the DateTime format.
|
void |
setGridAlignedWithTicker(boolean b)
This function enables/disables the alignment between grid lines and tickers.
|
void |
setGridColor(java.awt.Color c)
This function sets the grid color of the axis or wall.
|
void |
setGridHeightRatio(double ratio)
This function sets the grid height ratio for 2D chart.
|
void |
setGridInFront(boolean b)
Bring the grid to the front.
|
void |
setGridThickness(int t)
This function sets the thickness of the x/y grid lines.
|
void |
setGridVisible(boolean b)
This function enables/disables the drawing of grid lines for the axis associated with this
object.
|
void |
setLabelFormat(IFormat format)
This function sets the label format for the given axis.
|
void |
setLabelOutsidePlotArea(boolean b)
This function is used to draw tickers and labels inside/outside chart plot area for the given
axis.
|
void |
setLabelRowCount(int numRows)
This function is used to set the number of rows used to display x-axis labels.
|
void |
setLabelStep(int size)
This function sets the label step size for the given axis.
|
void |
setLogScale(boolean b)
This function enables/disables log scale plotting for the given axis.
|
void |
setLogSubTickersState(boolean state)
This function enables/disables sub-tickers for that axis.
Log scale must be on and log base must be 10. |
void |
setMaxLabelAndTickerCount(int ct)
This function sets the max number of display label and ticker for the given axis.
|
void |
setMaxScale(java.lang.Number maxScale)
Sets the maximum scale value for this axis.
|
void |
setMinScale(java.lang.Number minScale)
Sets the minimum scale value for this axis.
|
void |
setOffset(java.lang.Number num)
Sets the offset of the x-axis from the origin.
|
void |
setOriginAutomatic(boolean b)
This function is used to enable/disable auto calculation of origin.
|
void |
setScaleAutomatic(boolean b)
This function is used to enable/disable auto calculation of scales.
|
void |
setScaleStep(int yr,
int mo,
int dd,
int hr,
int min)
Sets the scalestep value for this axis. Used when the scale step uses a
date/time/timestamp instead of a number.
|
void |
setScaleStep(java.lang.Number scaleStep)
Sets the scale step size(interval) for this axis.
|
void |
setShowLogValue(boolean b)
This function enables/disables show log value for the given axis.
|
void |
setSkipGridOffset(boolean b)
This function enables/disables grid line offset for the axis associated with this object.
|
void |
setThickness(int t)
This function is used to set the axis line thickness for a 2D chart.
|
void |
setTickerColor(java.awt.Color c)
This function sets the ticker color of the axis or wall.
|
void |
setTickerLabels(java.lang.String[] labels)
This function is used to set the ticker labels for the given axis.
|
void |
setTickersInward(boolean b)
This function is used to decide the axis tickers drawing direction.
|
void |
setTickerStep(int stepSize)
This function is used to set the ticker step size for a particular axis.
|
void |
setTickersVisible(boolean b)
This function is used to enable/disable axis tickers rendering for the given axis.
|
void |
setVisible(boolean b)
Enables/Disables the display of the particular chart axis or wall.
|
java.awt.Color getColor()
Associated QbChart property: AXIS_COLOR
Note: This method returns the same value for all the axes. i.e. all the axes share the same color.
void setColor(java.awt.Color c)
Associated QbChart property: AXIS_COLOR
Note: All the axes share the same color value.
c
- An object of type Color, used to set the color for that axis.boolean hasArrowhead()
Associated QbChart property: DRAW_ARROWHEAD
void setArrowhead(boolean drawArrows)
Associated QbChart property: DRAW_ARROWHEAD
Note: It applies to all the axes. i.e. Arrowheads, when enabled, appear on ALL the axes.
drawArrows
- set to true if arrow heads are desired.int getThickness()
Associated QbChart property: AXISLINE_THICKNESS
void setThickness(int t)
Associated QbChart property: AXISLINE_THICKNESS
t
- The thickness (int) desired for the axes.boolean isVisible()
Associated QbChart property:
DRAW_XAXIS DRAW_YAXIS DRAW_ZAXIS
void setVisible(boolean b)
Associated QbChart property:
DRAW_XAXIS DRAW_YAXIS DRAW_ZAXIS
b
- True if axis/wall needs to be displayed. False otherwise.boolean isScaleAutomatic()
Associated QbChart property:
XAXIS_AUTOSCALE YAXIS_AUTOSCALE ZAXIS_AUTOSCALE
void setScaleAutomatic(boolean b)
b
- True if auto scale is desired, false otherwise.isScaleAutomatic for a list of the associated properties.
boolean isOriginAutomatic()
Associated QbChart property:
XAXIS_AUTOSCALE YAXIS_AUTOSCALE ZAXIS_AUTOSCALE
void setOriginAutomatic(boolean b)
b
- True if auto origin is desired, false otherwise.isOriginAutomatic for a list of the associated properties.
boolean isAxisPaddingAdded()
void setAxisPaddingAdded(boolean b)
b
- True if adding axis padding is desired, false otherwise.isAxisPaddingNeeded for a list of the associated properties.
boolean isLogScale()
Associated QbChart properties:
XAXIS_LOGSCALE YAXIS_LOGSCALE ZAXIS_LOGSCALE
void setLogScale(boolean b)
b
- True if a log scale is desired, false otherwise.isLogScale()
double getBaseForLog()
void setBaseForLog(double logBase)
logBase
- value of logarithmic base.boolean getLogSubTickersState()
void setLogSubTickersState(boolean state)
state
- the state of log sub-tickers.boolean isShowLogValue()
void setShowLogValue(boolean b)
b
- True if a log value is shown, false otherwise.isShowLogValue()
ITextString gethTitle()
ITextString
ILabel gethLabel()
ILabel
int getLabelRowCount()
XLABEL_ROWSIZE
void setLabelRowCount(int numRows)
XLABEL_ROWSIZE
numRows
- The number of rows used to draw the labels.boolean isLabelOutsidePlotArea()
void setLabelOutsidePlotArea(boolean b)
b
- set to true to set tickers and labels on the side, false otherwiseisLabelOutsidePlotArea()
java.lang.Object[] getOriginalTickerLabels(boolean formatedLabel)
formatedData
- set to true to get formatted ticker labels, false otherwiseint getTickerLabelsCount()
void setTickerLabels(java.lang.String[] labels)
labels
- replace original ticker labels with new labelsboolean areTickersVisible()
DRAW_XTICKER DRAW_YTICKER DRAW_ZTICKER
void setTickersVisible(boolean b)
b
- set to true to see tickers, false otherwiseareTickersVisible()
boolean areTickersInward()
void setTickersInward(boolean b)
b
- set to true to draw tickers inward, false otherwiseareTickersInward()
java.awt.Color getTickerColor()
void setTickerColor(java.awt.Color c)
c
- The color to be set.getTickerColor()
java.awt.Color getGridColor()
XGRID_COLOR YGRID_COLOR ZGRID_COLOR
void setGridColor(java.awt.Color c)
c
- The color to be set.getGridColor()
int getGridThickness()
XGRIDLINE_THICKNESS YGRIDLINE_THICKNESS
void setGridThickness(int t)
t
- The thickness desired.getGridThickness()
boolean isGridVisible()
DRAW_XGRID DRAW_YGRID DRAW_ZGRID
void setGridVisible(boolean b)
b
- Set to true if grid lines are desired, false otherwise.isGridVisible()
double getGridHeightRatio()
void setGridHeightRatio(double ratio)
ratio
- grid height ratio.getGridHeightRatio()
boolean isSkipGridOffset()
void setSkipGridOffset(boolean b)
b
- Set to true if grid line offset is desired, false otherwise.boolean isGridAlignedWithTicker()
void setGridAlignedWithTicker(boolean b)
b
- Set to true if grid lines are aligned with tickers, false otherwise.isGridAlignedWithTicker()
boolean isGridInFront()
void setGridInFront(boolean b)
b
- Set to true if grid lines are in front of the chart, false otherwise.isGridInFront()
java.lang.Number getMinScale()
Associated QbChart property: AXIS_SCALE
void setMinScale(java.lang.Number minScale)
minScale
- The minimum scale value to use.java.lang.Number getMaxScale()
Associated QbChart property: AXIS_SCALE
void setMaxScale(java.lang.Number maxScale)
maxScale
- The maximum scale value to use.java.lang.Number getScaleStep()
Associated QbChart property: AXIS_SCALE
void setScaleStep(java.lang.Number scaleStep)
scaleStep
- The step size to use for the scale.java.lang.Number getOffset()
void setOffset(java.lang.Number num)
Associated QbChart property: X_ORIGIN
num
- The offset value.boolean isDisplayLabelAsDate()
void setDisplayLabelAsDate(boolean b)
b
- Set to true if date labels are desired, false otherwise.void setScaleStep(int yr, int mo, int dd, int hr, int min)
yr
- The scalestep in yearmo
- The scalestep in monthdd
- The scalestep in dayhr
- The scalestep in hourmin
- The scalestep in minuteboolean isDateTimeDisplay()
void setDateTimeDisplay(boolean state)
state
- the new state, default is true.boolean isDisplayByWeek()
void setDisplayByWeek(boolean state)
state
- the new state.int getTickerStep()
setTickerStep(int)
void setTickerStep(int stepSize)
size
- The step size.getTickerStep()
IFormat getLabelFormat()
IFormat
void setLabelFormat(IFormat format)
format
- The object of type IFormat containing the label format.IFormat
int getLabelUnit()
setLabelStep(.....)
to set the label unit. No API for
setlabelUnit
is implemented such that the unit can be consistent with the input
data type of the columnIDataPointSet.getLabelUnit() for the definition of the return
value specifications.
int getLabelStep()
void setLabelStep(int size)
size
- The label step size desired.getLabelStep()
int getMaxLabelAndTickerCount()
void setMaxLabelAndTickerCount(int ct)
ct
- The max count for number of the label and ticker desired.getMaxLabelAndTickerCount()