public class nUIChartAxis
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
nUIChartLabel |
axis_label
A label for the axis itself
|
nUIChartLabel[] |
tick_labels
An array of labels for the tick marks
|
Constructor and Description |
---|
nUIChartAxis()
Default Constructor
|
nUIChartAxis(float min,
float max)
Create a chart axis with a minimum and maximum value.
|
Modifier and Type | Method and Description |
---|---|
nUIChartLabel |
getAxisLabel()
Gets the nUIChartLabel for this axis
|
float |
getMajorGridlineFrequency()
Gets the current major gridline frequency.
|
float |
getMaximum()
Gets the current maximum value this axis will display, or Float.NaN if the value is not known.
|
float |
getMinimum()
Gets the current minimum value this axis will display, or Float.NaN if not known.
|
float |
getMinorGridlineFrequency()
Gets the current minor gridline frequency.
|
nUIChartLabel[] |
getTickLabels()
Gets the array of labels for the chart axis ticks.
|
boolean |
hasMajorGridlineFrequency()
Return true if a major gridline frequency has been set.
|
boolean |
hasMaximum()
Return true if a maximum value has been set for this axis.
|
boolean |
hasMinimum()
Return true if a minimum value has been set for this axis.
|
boolean |
hasMinorGridlineFrequency()
Return true if a minor gridline frequency has been set.
|
void |
setAxesLabels(nUIChartLabel axis_label,
nUIChartLabel[] tick_labels)
Sets the axis label for the chart from an array of
nUIChartLabel items.
|
void |
setAxesLabelStrings(java.lang.String axis_label,
java.lang.String[] tick_labels)
Sets the axes labels for the chart using strings.
|
void |
setAxisLabel(nUIChartLabel label)
Sets the label for this chart axis.
|
void |
setAxisLabel(java.lang.String label)
Convenience method, calls setAxisLabel(nUIChartLabel label)
|
void |
setMajorGridlineFrequency(float frequency)
Sets the major gridline frequency (these are often labelled with values).
|
void |
setMajorGridlineFrequency(java.lang.Float frequency)
Sets the major gridline frequency (these are often labelled with values).
|
void |
setMaximum(float max)
Sets the maximum value this axis should be capable of displaying.
|
void |
setMaximum(java.lang.Float max)
Sets the maximum value this axis should be capable of displaying.
|
void |
setMinimum(float min)
Sets the minimum value that this axis should be capable of displaying.
|
void |
setMinimum(java.lang.Float min)
Sets the minimum value that this axis should be capable of displaying.
|
void |
setMinorGridlineFrequency(float frequency)
Sets minor (unlabelled) grid lines running perpendicular to the axis, along the
chart.
|
void |
setMinorGridlineFrequency(java.lang.Float frequency)
Sets minor (unlabelled) grid lines running perpendicular to the axis, along the
chart.
|
void |
setRange(float min,
float max)
Sets the minimum and maximum values for this axis.
|
void |
setRange(java.lang.Float min,
java.lang.Float max)
Sets the minimum and maximum values for this axis.
|
public nUIChartLabel axis_label
public nUIChartLabel[] tick_labels
public nUIChartAxis()
public nUIChartAxis(float min, float max)
public void setAxisLabel(java.lang.String label)
label
- the String to set.public void setAxisLabel(nUIChartLabel label)
label
- the nUIChartLabel to set.public nUIChartLabel getAxisLabel()
public void setMinorGridlineFrequency(float frequency)
frequency
- adds a grid line to the chart at every
frequency
value.public void setMinorGridlineFrequency(java.lang.Float frequency)
frequency
- adds a grid line to the chart at every
frequency
value.public float getMinorGridlineFrequency()
public void setMajorGridlineFrequency(float frequency)
public void setMajorGridlineFrequency(java.lang.Float frequency)
public float getMajorGridlineFrequency()
public void setRange(float min, float max)
public void setRange(java.lang.Float min, java.lang.Float max)
public void setMinimum(float min)
public void setMinimum(java.lang.Float min)
public float getMinimum()
public void setMaximum(float max)
public void setMaximum(java.lang.Float max)
public float getMaximum()
public boolean hasMinimum()
public boolean hasMaximum()
public boolean hasMinorGridlineFrequency()
public boolean hasMajorGridlineFrequency()
public void setAxesLabelStrings(java.lang.String axis_label, java.lang.String[] tick_labels)
axis_label
- string to label the axis withtick_labels
- an array of strings, or null to clear any
labelspublic void setAxesLabels(nUIChartLabel axis_label, nUIChartLabel[] tick_labels)
tick_labels
- array of nUIChartLabel items, or null to
clear any labelsaxis_label
- a label to set for the axis.public nUIChartLabel[] getTickLabels()