AxisBound
Contents
[
Hide
]Inheritance: java.lang.Object
public class AxisBound
Represents minimum or maximum bound of axis values.
To learn more, visit the Working with Charts documentation article.
Remarks:
Bound can be specified as a numeric, datetime or a special “auto” value.
The instances of this class are immutable.
Examples:
Shows how to insert chart with date/time values.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
Shape shape = builder.insertChart(ChartType.LINE, 500.0, 300.0);
Chart chart = shape.getChart();
// Clear the chart's demo data series to start with a clean chart.
chart.getSeries().clear();
// Add a custom series containing date/time values for the X-axis, and respective decimal values for the Y-axis.
chart.getSeries().add("Aspose Test Series",
new Date[]
{
DocumentHelper.createDate(2017, 11, 6), DocumentHelper.createDate(2017, 11, 9), DocumentHelper.createDate(2017, 11, 15),
DocumentHelper.createDate(2017, 11, 21), DocumentHelper.createDate(2017, 11, 25), DocumentHelper.createDate(2017, 11, 29)
},
new double[]{1.2, 0.3, 2.1, 2.9, 4.2, 5.3});
// Set lower and upper bounds for the X-axis.
ChartAxis xAxis = chart.getAxisX();
Date datetimeMin = DocumentHelper.createDate(2017, 11, 5);
xAxis.getScaling().setMinimum(new AxisBound(datetimeMin));
Date datetimeMax = DocumentHelper.createDate(2017, 12, 3);
xAxis.getScaling().setMaximum(new AxisBound(datetimeMax));
// Set the major units of the X-axis to a week, and the minor units to a day.
xAxis.setBaseTimeUnit(AxisTimeUnit.DAYS);
xAxis.setMajorUnit(7.0d);
xAxis.setMajorTickMark(AxisTickMark.CROSS);
xAxis.setMinorUnit(1.0d);
xAxis.setMinorTickMark(AxisTickMark.OUTSIDE);
xAxis.hasMajorGridlines(true);
xAxis.hasMinorGridlines(true);
// Define Y-axis properties for decimal values.
ChartAxis yAxis = chart.getAxisY();
yAxis.getTickLabels().setPosition(AxisTickLabelPosition.HIGH);
yAxis.setMajorUnit(100.0d);
yAxis.setMinorUnit(50.0d);
yAxis.getDisplayUnit().setUnit(AxisBuiltInUnit.HUNDREDS);
yAxis.getScaling().setMinimum(new AxisBound(100.0));
yAxis.getScaling().setMaximum(new AxisBound(700.0));
yAxis.hasMajorGridlines(true);
yAxis.hasMinorGridlines(true);
doc.save(getArtifactsDir() + "Charts.DateTimeValues.docx");
Constructors
| Constructor | Description |
|---|---|
| AxisBound() | Creates a new instance indicating that axis bound should be determined automatically by a word-processing application. |
| AxisBound(double value) | Creates an axis bound represented as a number. |
| AxisBound(Date datetime) | Creates an axis bound represented as datetime value. |
Methods
| Method | Description |
|---|---|
| equals(Object obj) | Determines whether the specified object is equal in value to the current object. |
| getValue() | Returns numeric value of axis bound. |
| getValueAsDate() | Returns value of axis bound represented as datetime. |
| hashCode() | |
| isAuto() | Returns a flag indicating that axis bound should be determined automatically. |
| toString() | Returns a user-friendly string that displays the value of this object. |
AxisBound()
public AxisBound()
Creates a new instance indicating that axis bound should be determined automatically by a word-processing application.
Examples:
Shows how to set custom axis bounds.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
Shape chartShape = builder.insertChart(ChartType.SCATTER, 450.0, 300.0);
Chart chart = chartShape.getChart();
// Clear the chart's demo data series to start with a clean chart.
chart.getSeries().clear();
// Add a series with two decimal arrays. The first array contains the X-values,
// and the second contains corresponding Y-values for points in the scatter chart.
chart.getSeries().add("Series 1",
new double[]{1.1, 5.4, 7.9, 3.5, 2.1, 9.7},
new double[]{2.1, 0.3, 0.6, 3.3, 1.4, 1.9});
// By default, default scaling is applied to the graph's X and Y-axes,
// so that both their ranges are big enough to encompass every X and Y-value of every series.
Assert.assertTrue(chart.getAxisX().getScaling().getMinimum().isAuto());
// We can define our own axis bounds.
// In this case, we will make both the X and Y-axis rulers show a range of 0 to 10.
chart.getAxisX().getScaling().setMinimum(new AxisBound(0.0));
chart.getAxisX().getScaling().setMaximum(new AxisBound(10.0));
chart.getAxisY().getScaling().setMinimum(new AxisBound(0.0));
chart.getAxisY().getScaling().setMaximum(new AxisBound(10.0));
Assert.assertFalse(chart.getAxisX().getScaling().getMinimum().isAuto());
Assert.assertFalse(chart.getAxisY().getScaling().getMinimum().isAuto());
// Create a line chart with a series requiring a range of dates on the X-axis, and decimal values for the Y-axis.
chartShape = builder.insertChart(ChartType.LINE, 450.0, 300.0);
chart = chartShape.getChart();
chart.getSeries().clear();
Date[] dates = {DocumentHelper.createDate(1973, 5, 11),
DocumentHelper.createDate(1981, 2, 4),
DocumentHelper.createDate(1985, 9, 23),
DocumentHelper.createDate(1989, 6, 28),
DocumentHelper.createDate(1994, 12, 15)
};
chart.getSeries().add("Series 1", dates, new double[]{3.0, 4.7, 5.9, 7.1, 8.9});
// We can set axis bounds in the form of dates as well, limiting the chart to a period.
// Setting the range to 1980-1990 will omit the two of the series values
// that are outside of the range from the graph.
Date datetimeMin = DocumentHelper.createDate(1980, 1, 1);
chart.getAxisX().getScaling().setMinimum(new AxisBound(datetimeMin));
Date datetimeMax = DocumentHelper.createDate(1980, 1, 1);
chart.getAxisX().getScaling().setMaximum(new AxisBound(datetimeMax));
doc.save(getArtifactsDir() + "Charts.AxisBound.docx");
AxisBound(double value)
public AxisBound(double value)
Creates an axis bound represented as a number.
Examples:
Shows how to insert chart with date/time values.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
Shape shape = builder.insertChart(ChartType.LINE, 500.0, 300.0);
Chart chart = shape.getChart();
// Clear the chart's demo data series to start with a clean chart.
chart.getSeries().clear();
// Add a custom series containing date/time values for the X-axis, and respective decimal values for the Y-axis.
chart.getSeries().add("Aspose Test Series",
new Date[]
{
DocumentHelper.createDate(2017, 11, 6), DocumentHelper.createDate(2017, 11, 9), DocumentHelper.createDate(2017, 11, 15),
DocumentHelper.createDate(2017, 11, 21), DocumentHelper.createDate(2017, 11, 25), DocumentHelper.createDate(2017, 11, 29)
},
new double[]{1.2, 0.3, 2.1, 2.9, 4.2, 5.3});
// Set lower and upper bounds for the X-axis.
ChartAxis xAxis = chart.getAxisX();
Date datetimeMin = DocumentHelper.createDate(2017, 11, 5);
xAxis.getScaling().setMinimum(new AxisBound(datetimeMin));
Date datetimeMax = DocumentHelper.createDate(2017, 12, 3);
xAxis.getScaling().setMaximum(new AxisBound(datetimeMax));
// Set the major units of the X-axis to a week, and the minor units to a day.
xAxis.setBaseTimeUnit(AxisTimeUnit.DAYS);
xAxis.setMajorUnit(7.0d);
xAxis.setMajorTickMark(AxisTickMark.CROSS);
xAxis.setMinorUnit(1.0d);
xAxis.setMinorTickMark(AxisTickMark.OUTSIDE);
xAxis.hasMajorGridlines(true);
xAxis.hasMinorGridlines(true);
// Define Y-axis properties for decimal values.
ChartAxis yAxis = chart.getAxisY();
yAxis.getTickLabels().setPosition(AxisTickLabelPosition.HIGH);
yAxis.setMajorUnit(100.0d);
yAxis.setMinorUnit(50.0d);
yAxis.getDisplayUnit().setUnit(AxisBuiltInUnit.HUNDREDS);
yAxis.getScaling().setMinimum(new AxisBound(100.0));
yAxis.getScaling().setMaximum(new AxisBound(700.0));
yAxis.hasMajorGridlines(true);
yAxis.hasMinorGridlines(true);
doc.save(getArtifactsDir() + "Charts.DateTimeValues.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double |
AxisBound(Date datetime)
public AxisBound(Date datetime)
Creates an axis bound represented as datetime value.
Examples:
Shows how to insert chart with date/time values.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
Shape shape = builder.insertChart(ChartType.LINE, 500.0, 300.0);
Chart chart = shape.getChart();
// Clear the chart's demo data series to start with a clean chart.
chart.getSeries().clear();
// Add a custom series containing date/time values for the X-axis, and respective decimal values for the Y-axis.
chart.getSeries().add("Aspose Test Series",
new Date[]
{
DocumentHelper.createDate(2017, 11, 6), DocumentHelper.createDate(2017, 11, 9), DocumentHelper.createDate(2017, 11, 15),
DocumentHelper.createDate(2017, 11, 21), DocumentHelper.createDate(2017, 11, 25), DocumentHelper.createDate(2017, 11, 29)
},
new double[]{1.2, 0.3, 2.1, 2.9, 4.2, 5.3});
// Set lower and upper bounds for the X-axis.
ChartAxis xAxis = chart.getAxisX();
Date datetimeMin = DocumentHelper.createDate(2017, 11, 5);
xAxis.getScaling().setMinimum(new AxisBound(datetimeMin));
Date datetimeMax = DocumentHelper.createDate(2017, 12, 3);
xAxis.getScaling().setMaximum(new AxisBound(datetimeMax));
// Set the major units of the X-axis to a week, and the minor units to a day.
xAxis.setBaseTimeUnit(AxisTimeUnit.DAYS);
xAxis.setMajorUnit(7.0d);
xAxis.setMajorTickMark(AxisTickMark.CROSS);
xAxis.setMinorUnit(1.0d);
xAxis.setMinorTickMark(AxisTickMark.OUTSIDE);
xAxis.hasMajorGridlines(true);
xAxis.hasMinorGridlines(true);
// Define Y-axis properties for decimal values.
ChartAxis yAxis = chart.getAxisY();
yAxis.getTickLabels().setPosition(AxisTickLabelPosition.HIGH);
yAxis.setMajorUnit(100.0d);
yAxis.setMinorUnit(50.0d);
yAxis.getDisplayUnit().setUnit(AxisBuiltInUnit.HUNDREDS);
yAxis.getScaling().setMinimum(new AxisBound(100.0));
yAxis.getScaling().setMaximum(new AxisBound(700.0));
yAxis.hasMajorGridlines(true);
yAxis.hasMinorGridlines(true);
doc.save(getArtifactsDir() + "Charts.DateTimeValues.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| datetime | java.util.Date |
equals(Object obj)
public boolean equals(Object obj)
Determines whether the specified object is equal in value to the current object.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| obj | java.lang.Object |
Returns: boolean
getValue()
public double getValue()
Returns numeric value of axis bound.
Examples:
Shows how to set custom axis bounds.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
Shape chartShape = builder.insertChart(ChartType.SCATTER, 450.0, 300.0);
Chart chart = chartShape.getChart();
// Clear the chart's demo data series to start with a clean chart.
chart.getSeries().clear();
// Add a series with two decimal arrays. The first array contains the X-values,
// and the second contains corresponding Y-values for points in the scatter chart.
chart.getSeries().add("Series 1",
new double[]{1.1, 5.4, 7.9, 3.5, 2.1, 9.7},
new double[]{2.1, 0.3, 0.6, 3.3, 1.4, 1.9});
// By default, default scaling is applied to the graph's X and Y-axes,
// so that both their ranges are big enough to encompass every X and Y-value of every series.
Assert.assertTrue(chart.getAxisX().getScaling().getMinimum().isAuto());
// We can define our own axis bounds.
// In this case, we will make both the X and Y-axis rulers show a range of 0 to 10.
chart.getAxisX().getScaling().setMinimum(new AxisBound(0.0));
chart.getAxisX().getScaling().setMaximum(new AxisBound(10.0));
chart.getAxisY().getScaling().setMinimum(new AxisBound(0.0));
chart.getAxisY().getScaling().setMaximum(new AxisBound(10.0));
Assert.assertFalse(chart.getAxisX().getScaling().getMinimum().isAuto());
Assert.assertFalse(chart.getAxisY().getScaling().getMinimum().isAuto());
// Create a line chart with a series requiring a range of dates on the X-axis, and decimal values for the Y-axis.
chartShape = builder.insertChart(ChartType.LINE, 450.0, 300.0);
chart = chartShape.getChart();
chart.getSeries().clear();
Date[] dates = {DocumentHelper.createDate(1973, 5, 11),
DocumentHelper.createDate(1981, 2, 4),
DocumentHelper.createDate(1985, 9, 23),
DocumentHelper.createDate(1989, 6, 28),
DocumentHelper.createDate(1994, 12, 15)
};
chart.getSeries().add("Series 1", dates, new double[]{3.0, 4.7, 5.9, 7.1, 8.9});
// We can set axis bounds in the form of dates as well, limiting the chart to a period.
// Setting the range to 1980-1990 will omit the two of the series values
// that are outside of the range from the graph.
Date datetimeMin = DocumentHelper.createDate(1980, 1, 1);
chart.getAxisX().getScaling().setMinimum(new AxisBound(datetimeMin));
Date datetimeMax = DocumentHelper.createDate(1980, 1, 1);
chart.getAxisX().getScaling().setMaximum(new AxisBound(datetimeMax));
doc.save(getArtifactsDir() + "Charts.AxisBound.docx");
Returns: double - Numeric value of axis bound.
getValueAsDate()
public Date getValueAsDate()
Returns value of axis bound represented as datetime.
Examples:
Shows how to set custom axis bounds.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
Shape chartShape = builder.insertChart(ChartType.SCATTER, 450.0, 300.0);
Chart chart = chartShape.getChart();
// Clear the chart's demo data series to start with a clean chart.
chart.getSeries().clear();
// Add a series with two decimal arrays. The first array contains the X-values,
// and the second contains corresponding Y-values for points in the scatter chart.
chart.getSeries().add("Series 1",
new double[]{1.1, 5.4, 7.9, 3.5, 2.1, 9.7},
new double[]{2.1, 0.3, 0.6, 3.3, 1.4, 1.9});
// By default, default scaling is applied to the graph's X and Y-axes,
// so that both their ranges are big enough to encompass every X and Y-value of every series.
Assert.assertTrue(chart.getAxisX().getScaling().getMinimum().isAuto());
// We can define our own axis bounds.
// In this case, we will make both the X and Y-axis rulers show a range of 0 to 10.
chart.getAxisX().getScaling().setMinimum(new AxisBound(0.0));
chart.getAxisX().getScaling().setMaximum(new AxisBound(10.0));
chart.getAxisY().getScaling().setMinimum(new AxisBound(0.0));
chart.getAxisY().getScaling().setMaximum(new AxisBound(10.0));
Assert.assertFalse(chart.getAxisX().getScaling().getMinimum().isAuto());
Assert.assertFalse(chart.getAxisY().getScaling().getMinimum().isAuto());
// Create a line chart with a series requiring a range of dates on the X-axis, and decimal values for the Y-axis.
chartShape = builder.insertChart(ChartType.LINE, 450.0, 300.0);
chart = chartShape.getChart();
chart.getSeries().clear();
Date[] dates = {DocumentHelper.createDate(1973, 5, 11),
DocumentHelper.createDate(1981, 2, 4),
DocumentHelper.createDate(1985, 9, 23),
DocumentHelper.createDate(1989, 6, 28),
DocumentHelper.createDate(1994, 12, 15)
};
chart.getSeries().add("Series 1", dates, new double[]{3.0, 4.7, 5.9, 7.1, 8.9});
// We can set axis bounds in the form of dates as well, limiting the chart to a period.
// Setting the range to 1980-1990 will omit the two of the series values
// that are outside of the range from the graph.
Date datetimeMin = DocumentHelper.createDate(1980, 1, 1);
chart.getAxisX().getScaling().setMinimum(new AxisBound(datetimeMin));
Date datetimeMax = DocumentHelper.createDate(1980, 1, 1);
chart.getAxisX().getScaling().setMaximum(new AxisBound(datetimeMax));
doc.save(getArtifactsDir() + "Charts.AxisBound.docx");
Returns: java.util.Date - Value of axis bound represented as datetime.
hashCode()
public int hashCode()
Returns: int
isAuto()
public boolean isAuto()
Returns a flag indicating that axis bound should be determined automatically.
Examples:
Shows how to set custom axis bounds.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
Shape chartShape = builder.insertChart(ChartType.SCATTER, 450.0, 300.0);
Chart chart = chartShape.getChart();
// Clear the chart's demo data series to start with a clean chart.
chart.getSeries().clear();
// Add a series with two decimal arrays. The first array contains the X-values,
// and the second contains corresponding Y-values for points in the scatter chart.
chart.getSeries().add("Series 1",
new double[]{1.1, 5.4, 7.9, 3.5, 2.1, 9.7},
new double[]{2.1, 0.3, 0.6, 3.3, 1.4, 1.9});
// By default, default scaling is applied to the graph's X and Y-axes,
// so that both their ranges are big enough to encompass every X and Y-value of every series.
Assert.assertTrue(chart.getAxisX().getScaling().getMinimum().isAuto());
// We can define our own axis bounds.
// In this case, we will make both the X and Y-axis rulers show a range of 0 to 10.
chart.getAxisX().getScaling().setMinimum(new AxisBound(0.0));
chart.getAxisX().getScaling().setMaximum(new AxisBound(10.0));
chart.getAxisY().getScaling().setMinimum(new AxisBound(0.0));
chart.getAxisY().getScaling().setMaximum(new AxisBound(10.0));
Assert.assertFalse(chart.getAxisX().getScaling().getMinimum().isAuto());
Assert.assertFalse(chart.getAxisY().getScaling().getMinimum().isAuto());
// Create a line chart with a series requiring a range of dates on the X-axis, and decimal values for the Y-axis.
chartShape = builder.insertChart(ChartType.LINE, 450.0, 300.0);
chart = chartShape.getChart();
chart.getSeries().clear();
Date[] dates = {DocumentHelper.createDate(1973, 5, 11),
DocumentHelper.createDate(1981, 2, 4),
DocumentHelper.createDate(1985, 9, 23),
DocumentHelper.createDate(1989, 6, 28),
DocumentHelper.createDate(1994, 12, 15)
};
chart.getSeries().add("Series 1", dates, new double[]{3.0, 4.7, 5.9, 7.1, 8.9});
// We can set axis bounds in the form of dates as well, limiting the chart to a period.
// Setting the range to 1980-1990 will omit the two of the series values
// that are outside of the range from the graph.
Date datetimeMin = DocumentHelper.createDate(1980, 1, 1);
chart.getAxisX().getScaling().setMinimum(new AxisBound(datetimeMin));
Date datetimeMax = DocumentHelper.createDate(1980, 1, 1);
chart.getAxisX().getScaling().setMaximum(new AxisBound(datetimeMax));
doc.save(getArtifactsDir() + "Charts.AxisBound.docx");
Returns: boolean - A flag indicating that axis bound should be determined automatically.
toString()
public String toString()
Returns a user-friendly string that displays the value of this object.
Returns: java.lang.String
