com.aspose.cells.Axis.html Maven / Gradle / Ivy
Axis
com.aspose.cells
Class Axis
java.lang.Object
com.aspose.cells.Axis
public class Axis
- extends java.lang.Object
Example:
//Instantiating a Workbook object
Workbook workbook = new Workbook();
//Adding a new worksheet to the Excel object
int sheetIndex = workbook.getWorksheets().add();
//Obtaining the reference of the newly added worksheet by passing its sheet index
Worksheet worksheet = workbook.getWorksheets().get(sheetIndex);
//Adding a sample value to "A1" cell
worksheet.getCells().get("A1").putValue(50);
//Adding a sample value to "A2" cell
worksheet.getCells().get("A2").putValue(100);
//Adding a sample value to "A3" cell
worksheet.getCells().get("A3").putValue(150);
//Adding a sample value to "B1" cell
worksheet.getCells().get("B1").putValue(4);
//Adding a sample value to "B2" cell
worksheet.getCells().get("B2").putValue(20);
//Adding a sample value to "B3" cell
worksheet.getCells().get("B3").putValue(50);
//Adding a chart to the worksheet
int chartIndex = worksheet.getCharts().add(ChartType.COLUMN, 5, 0, 25, 5);
//Accessing the instance of the newly added chart
Chart chart = worksheet.getCharts().get(chartIndex);
//Adding NSeries (chart data source) to the chart ranging from "A1" cell to "B3"
chart.getNSeries().add("A1:B3", true);
//Set the max value of value axis
chart.getValueAxis().setMaxValue(200);
//Set the min value of value axis
chart.getValueAxis().setMinValue(0);
//Set the major unit
chart.getValueAxis().setMajorUnit(25);
//Category(X) axis crosses at the maxinum value.
chart.getValueAxis().setCrossType(CrossType.MAXIMUM);
//Set he number of categories or series between tick-mark labels.
chart.getCategoryAxis().setTickLabelSpacing(2);
//Saving the Excel file
workbook.save("C:\\book1.xls");
| Property Getters/Setters Summary | ||
|---|---|---|
Area | getArea() | |
|
Gets the |
||
boolean | getAxisBetweenCategories() | |
void | setAxisBetweenCategories(boolean) | |
| Represents if the value axis crosses the category axis between categories. | ||
java.util.ArrayList | getAxisLabels() | |
| Gets the labels of the axis after call Chart.Calculate() method. | ||
Line | getAxisLine() | |
| Gets the appearance of an Axis. | ||
int | getBaseUnitScale() | |
void | setBaseUnitScale(int) | |
| Represents the base unit scale for the category axis. The value of the property is TimeUnit integer constant. | ||
AxisBins | getBins() | |
| Represents bins on a chart(Histogram/Pareto) axis | ||
int | getCategoryType() | |
void | setCategoryType(int) | |
| Represents the category axis type. The value of the property is CategoryType integer constant. | ||
double | getCrossAt() | |
void | setCrossAt(double) | |
| Represents the point on the value axis where the category axis crosses it. | ||
int | getCrossType() | |
void | setCrossType(int) | |
|
Represents the |
||
int | getCustUnit() | |
void | setCustUnit(int) | |
| Specifies a custom value for the display unit. | ||
int | getDisplayUnit() | |
void | setDisplayUnit(int) | |
| Represents the unit label for the specified axis. The value of the property is DisplayUnitType integer constant. | ||
DisplayUnitLabel | getDisplayUnitLabel() | |
| Represents a unit label on an axis in the specified chart. Unit labels are useful for charting large values— for example, in the millions or billions. | ||
boolean | hasMultiLevelLabels() | |
void | setHasMultiLevelLabels(boolean) | |
| Indicates whether the labels shall be shown as multi level. | ||
boolean | isAutomaticMajorUnit() | |
void | setAutomaticMajorUnit(boolean) | |
| Indicates whether the major unit of the axis is automatically assigned. | ||
boolean | isAutomaticMaxValue() | |
void | setAutomaticMaxValue(boolean) | |
| Indicates whether the max value is automatically assigned. | ||
boolean | isAutomaticMinorUnit() | |
void | setAutomaticMinorUnit(boolean) | |
| Indicates whether the minor unit of the axis is automatically assigned. | ||
boolean | isAutomaticMinValue() | |
void | setAutomaticMinValue(boolean) | |
| Indicates whether the min value is automatically assigned. | ||
boolean | isAutoTickLabelSpacing() | |
void | setAutoTickLabelSpacing(boolean) | |
| Indicates whether the spacing of tick label is automatic | ||
boolean | isBaseUnitAuto() | |
void | setBaseUnitAuto(boolean) | |
| Represents whether the base unit is automatic. | ||
boolean | isDisplayUnitLabelShown() | |
void | setDisplayUnitLabelShown(boolean) | |
| Represents if the display unit label is shown on the specified axis. | ||
boolean | isLogarithmic() | |
void | setLogarithmic(boolean) | |
| Represents if the value axis scale type is logarithmic or not. | ||
boolean | isPlotOrderReversed() | |
void | setPlotOrderReversed(boolean) | |
| Represents if Microsoft Excel plots data points from last to first. | ||
boolean | isVisible() | |
void | setVisible(boolean) | |
| Represents if the axis is visible. | ||
double | getLogBase() | |
void | setLogBase(double) | |
| Represents the logarithmic base. Default value is 10.Only applies for Excel2007. | ||
Line | getMajorGridLines() | |
| Represents major gridlines on a chart axis. | ||
int | getMajorTickMark() | |
void | setMajorTickMark(int) | |
| Represents the type of major tick mark for the specified axis. The value of the property is TickMarkType integer constant. | ||
double | getMajorUnit() | |
void | setMajorUnit(double) | |
| Represents the major units for the axis. | ||
int | getMajorUnitScale() | |
void | setMajorUnitScale(int) | |
| Represents the major unit scale for the category axis. The value of the property is TimeUnit integer constant. | ||
java.lang.Object | getMaxValue() | |
void | setMaxValue(java.lang.Object) | |
| Represents the maximum value on the value axis. | ||
Line | getMinorGridLines() | |
| Represents minor gridlines on a chart axis. | ||
int | getMinorTickMark() | |
void | setMinorTickMark(int) | |
| Represents the type of minor tick mark for the specified axis. The value of the property is TickMarkType integer constant. | ||
double | getMinorUnit() | |
void | setMinorUnit(double) | |
| Represents the minor units for the axis. | ||
int | getMinorUnitScale() | |
void | setMinorUnitScale(int) | |
| Represents the major unit scale for the category axis. The value of the property is TimeUnit integer constant. | ||
java.lang.Object | getMinValue() | |
void | setMinValue(java.lang.Object) | |
| Represents the minimum value on the value axis. | ||
int | getTickLabelPosition() | |
void | setTickLabelPosition(int) | |
| Represents the position of tick-mark labels on the specified axis. The value of the property is TickLabelPositionType integer constant. | ||
TickLabels | getTickLabels() | |
|
Returns a |
||
int | getTickLabelSpacing() | |
void | setTickLabelSpacing(int) | |
| Represents the number of categories or series between tick-mark labels. Applies only to category and series axes. | ||
int | getTickMarkSpacing() | |
void | setTickMarkSpacing(int) | |
| Returns or sets the number of categories or series between tick marks. Applies only to category and series axes. | ||
Title | getTitle() | |
| Gets the axis' title. | ||
| Method Summary | ||
|---|---|---|
boolean | isAutoCross() | |
| Indicates whether Microsoft Workbook automatically sets the axis crossing point. | ||
boolean | isCrossAtMax() | |
| Indicates whether Microsoft Workbook automatically sets the axis crossing point. | ||
void | setAutoCross() | |
| Sets the axis crossing point as automatic. | ||
void | setCrossAtMax(boolean isCrossAtMax) | |
| Sets whether the axis crosses at the maximum value. | ||
| Property Getters/Setters Detail |
|---|
getArea | |
public Area getArea() | |
Gets the Area .
isAutomaticMinValue/setAutomaticMinValue | |
public boolean isAutomaticMinValue() / public void setAutomaticMinValue(boolean value) | |
Indicates whether the min value is automatically assigned.
getMinValue/setMinValue | |
public java.lang.Object getMinValue() / public void setMinValue(java.lang.Object value) | |
Represents the minimum value on the value axis. The minValue type only can be double or DateTime
isAutomaticMaxValue/setAutomaticMaxValue | |
public boolean isAutomaticMaxValue() / public void setAutomaticMaxValue(boolean value) | |
Indicates whether the max value is automatically assigned.
getMaxValue/setMaxValue | |
public java.lang.Object getMaxValue() / public void setMaxValue(java.lang.Object value) | |
Represents the maximum value on the value axis. The maxValue type only can be double or DateTime
isAutomaticMajorUnit/setAutomaticMajorUnit | |
public boolean isAutomaticMajorUnit() / public void setAutomaticMajorUnit(boolean value) | |
Indicates whether the major unit of the axis is automatically assigned.
getMajorUnit/setMajorUnit | |
public double getMajorUnit() / public void setMajorUnit(double value) | |
Represents the major units for the axis. The major units must be greater than zero.
isAutomaticMinorUnit/setAutomaticMinorUnit | |
public boolean isAutomaticMinorUnit() / public void setAutomaticMinorUnit(boolean value) | |
Indicates whether the minor unit of the axis is automatically assigned.
getMinorUnit/setMinorUnit | |
public double getMinorUnit() / public void setMinorUnit(double value) | |
Represents the minor units for the axis. The minor units must be greater than zero.
getAxisLine | |
public Line getAxisLine() | |
Gets the appearance of an Axis.
getMajorTickMark/setMajorTickMark | |
public int getMajorTickMark() / public void setMajorTickMark(int value) | |
Represents the type of major tick mark for the specified axis. The value of the property is TickMarkType integer constant.
getMinorTickMark/setMinorTickMark | |
public int getMinorTickMark() / public void setMinorTickMark(int value) | |
Represents the type of minor tick mark for the specified axis. The value of the property is TickMarkType integer constant.
getTickLabelPosition/setTickLabelPosition | |
public int getTickLabelPosition() / public void setTickLabelPosition(int value) | |
Represents the position of tick-mark labels on the specified axis. The value of the property is TickLabelPositionType integer constant.
getCrossAt/setCrossAt | |
public double getCrossAt() / public void setCrossAt(double value) | |
Represents the point on the value axis where the category axis crosses it. The number should be a integer when it applies to category axis. And the value must be between 1 and 31999.
getCrossType/setCrossType | |
public int getCrossType() / public void setCrossType(int value) | |
Represents the CrossType on the specified axis where the other axis crosses. The value of the property is CrossType integer constant.
getLogBase/setLogBase | |
public double getLogBase() / public void setLogBase(double value) | |
Represents the logarithmic base. Default value is 10.Only applies for Excel2007.
isLogarithmic/setLogarithmic | |
public boolean isLogarithmic() / public void setLogarithmic(boolean value) | |
Represents if the value axis scale type is logarithmic or not.
isPlotOrderReversed/setPlotOrderReversed | |
public boolean isPlotOrderReversed() / public void setPlotOrderReversed(boolean value) | |
Represents if Microsoft Excel plots data points from last to first.
getAxisBetweenCategories/setAxisBetweenCategories | |
public boolean getAxisBetweenCategories() / public void setAxisBetweenCategories(boolean value) | |
Represents if the value axis crosses the category axis between categories. This property applies only to category axes, and it doesn't apply to 3-D charts.
getTickLabels | |
public TickLabels getTickLabels() | |
Returns a TickLabels object that represents the tick-mark labels for the specified axis.
getTickLabelSpacing/setTickLabelSpacing | |
public int getTickLabelSpacing() / public void setTickLabelSpacing(int value) | |
Represents the number of categories or series between tick-mark labels. Applies only to category and series axes. The number must be between 1 and 31999.
isAutoTickLabelSpacing/setAutoTickLabelSpacing | |
public boolean isAutoTickLabelSpacing() / public void setAutoTickLabelSpacing(boolean value) | |
Indicates whether the spacing of tick label is automatic
getTickMarkSpacing/setTickMarkSpacing | |
public int getTickMarkSpacing() / public void setTickMarkSpacing(int value) | |
Returns or sets the number of categories or series between tick marks. Applies only to category and series axes. The number must be between 1 and 31999.
getDisplayUnit/setDisplayUnit | |
public int getDisplayUnit() / public void setDisplayUnit(int value) | |
Represents the unit label for the specified axis. The value of the property is DisplayUnitType integer constant.
getCustUnit/setCustUnit | |
public int getCustUnit() / public void setCustUnit(int value) | |
Specifies a custom value for the display unit.
getDisplayUnitLabel | |
public DisplayUnitLabel getDisplayUnitLabel() | |
Represents a unit label on an axis in the specified chart. Unit labels are useful for charting large values— for example, in the millions or billions.
isDisplayUnitLabelShown/setDisplayUnitLabelShown | |
public boolean isDisplayUnitLabelShown() / public void setDisplayUnitLabelShown(boolean value) | |
Represents if the display unit label is shown on the specified axis. The default value is True.
getTitle | |
public Title getTitle() | |
Gets the axis' title.
getCategoryType/setCategoryType | |
public int getCategoryType() / public void setCategoryType(int value) | |
Represents the category axis type. The value of the property is CategoryType integer constant.
getBaseUnitScale/setBaseUnitScale | |
public int getBaseUnitScale() / public void setBaseUnitScale(int value) | |
Represents the base unit scale for the category axis. The value of the property is TimeUnit integer constant. Setting this property only takes effect when the CategoryType property is set to TimeScale.
isBaseUnitAuto/setBaseUnitAuto | |
public boolean isBaseUnitAuto() / public void setBaseUnitAuto(boolean value) | |
Represents whether the base unit is automatic.
getMajorUnitScale/setMajorUnitScale | |
public int getMajorUnitScale() / public void setMajorUnitScale(int value) | |
Represents the major unit scale for the category axis. The value of the property is TimeUnit integer constant. Example:
chart.getCategoryAxis().setCategoryType(CategoryType.TIME_SCALE); chart.getCategoryAxis().setMajorUnitScale(TimeUnit.MONTHS); chart.getCategoryAxis().setMajorUnit(2);
getMinorUnitScale/setMinorUnitScale | |
public int getMinorUnitScale() / public void setMinorUnitScale(int value) | |
Represents the major unit scale for the category axis. The value of the property is TimeUnit integer constant. Example:
chart.getCategoryAxis().setCategoryType(CategoryType.TIME_SCALE); chart.getCategoryAxis().setMinorUnitScale(TimeUnit.MONTHS); chart.getCategoryAxis().setMinorUnit(2);
isVisible/setVisible | |
public boolean isVisible() / public void setVisible(boolean value) | |
Represents if the axis is visible.
getMajorGridLines | |
public Line getMajorGridLines() | |
Represents major gridlines on a chart axis. Example:
chart.getValueAxis().getMajorGridLines().setVisible(false); chart.getCategoryAxis().getMajorGridLines().setVisible(true);
getMinorGridLines | |
public Line getMinorGridLines() | |
Represents minor gridlines on a chart axis.
hasMultiLevelLabels/setHasMultiLevelLabels | |
public boolean hasMultiLevelLabels() / public void setHasMultiLevelLabels(boolean value) | |
Indicates whether the labels shall be shown as multi level. Only valid for category axis.
getAxisLabels | |
public java.util.ArrayList getAxisLabels() | |
Gets the labels of the axis after call Chart.Calculate() method.
getBins | |
public AxisBins getBins() | |
Represents bins on a chart(Histogram/Pareto) axis
| Method Detail |
|---|
isAutoCross | |
public boolean isAutoCross() | |
Indicates whether Microsoft Workbook automatically sets the axis crossing point. NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Charts.Axis.CrossType property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.
isCrossAtMax | |
public boolean isCrossAtMax() | |
Indicates whether Microsoft Workbook automatically sets the axis crossing point. NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Charts.Axis.CrossType property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.
setAutoCross | |
public void setAutoCross() | |
Sets the axis crossing point as automatic. NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Charts.Axis.CrossType property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.
setCrossAtMax | |
public void setCrossAtMax(boolean isCrossAtMax) | |
Sets whether the axis crosses at the maximum value. NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Charts.Axis.CrossType property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.
See Also:
Aspose.Cells Documentation - the home page for the Aspose.Cells Product Documentation.
Aspose.Cells Support Forum - our preferred method of support.