com.aspose.words

Class ChartAxisTitle

java.lang.Object

com.aspose.words.ChartAxisTitle

public class ChartAxisTitle
extends java.lang.Object

Provides access to the axis title properties.

To learn more, visit the Working with Charts documentation article.

Examples:

Shows how to set chart axis title.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 Shape shape = builder.insertChart(ChartType.COLUMN, 432.0, 252.0);

 Chart chart = shape.getChart();
 ChartSeriesCollection seriesColl = chart.getSeries();
 // Delete default generated series.
 seriesColl.clear();

 seriesColl.add("AW Series 1", new String[] { "AW Category 1", "AW Category 2" }, new double[] { 1.0, 2.0 });

 // Set axis title.
 ChartAxisTitle chartAxisXTitle = chart.getAxisX().getTitle();
 chartAxisXTitle.setText("Categories");
 chartAxisXTitle.setShow(true);
 ChartAxisTitle chartAxisYTitle = chart.getAxisY().getTitle();
 chartAxisYTitle.setText("Values");
 chartAxisYTitle.setShow(true);
 chartAxisYTitle.setOverlay(true);
 chartAxisYTitle.getFont().setSize(12.0);
 chartAxisYTitle.getFont().setColor(Color.BLUE);

 doc.save(getArtifactsDir() + "Charts.ChartAxisTitle.docx");
 
 

Method Summary

Modifier and Type	Method and Description
Font	getFont() Provides access to the font formatting of the axis title.
ChartFormat	getFormat() Provides access to fill and line formatting of the axis title.
boolean	getOverlay() Determines whether other chart elements shall be allowed to overlap the title.
boolean	getShow() Determines whether the title shall be shown for the axis.
java.lang.String	getText() Gets the text of the axis title.
void	setOverlay(boolean value) Determines whether other chart elements shall be allowed to overlap the title.
void	setShow(boolean value) Determines whether the title shall be shown for the axis.
void	setText(java.lang.String value) Sets the text of the axis title.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getText

public java.lang.String getText()

Gets the text of the axis title. If null or empty value is specified, auto generated title will be shown.

Remarks:

Use getShow() / setShow(boolean) option if you need to show the title.

Examples:

Shows how to set chart axis title.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 Shape shape = builder.insertChart(ChartType.COLUMN, 432.0, 252.0);

 Chart chart = shape.getChart();
 ChartSeriesCollection seriesColl = chart.getSeries();
 // Delete default generated series.
 seriesColl.clear();

 seriesColl.add("AW Series 1", new String[] { "AW Category 1", "AW Category 2" }, new double[] { 1.0, 2.0 });

 // Set axis title.
 ChartAxisTitle chartAxisXTitle = chart.getAxisX().getTitle();
 chartAxisXTitle.setText("Categories");
 chartAxisXTitle.setShow(true);
 ChartAxisTitle chartAxisYTitle = chart.getAxisY().getTitle();
 chartAxisYTitle.setText("Values");
 chartAxisYTitle.setShow(true);
 chartAxisYTitle.setOverlay(true);
 chartAxisYTitle.getFont().setSize(12.0);
 chartAxisYTitle.getFont().setColor(Color.BLUE);

 doc.save(getArtifactsDir() + "Charts.ChartAxisTitle.docx");
 
 

Returns:

The text of the axis title.

setText

public void setText(java.lang.String value)

Sets the text of the axis title. If null or empty value is specified, auto generated title will be shown.

Remarks:

Use getShow() / setShow(boolean) option if you need to show the title.

Examples:

Shows how to set chart axis title.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 Shape shape = builder.insertChart(ChartType.COLUMN, 432.0, 252.0);

 Chart chart = shape.getChart();
 ChartSeriesCollection seriesColl = chart.getSeries();
 // Delete default generated series.
 seriesColl.clear();

 seriesColl.add("AW Series 1", new String[] { "AW Category 1", "AW Category 2" }, new double[] { 1.0, 2.0 });

 // Set axis title.
 ChartAxisTitle chartAxisXTitle = chart.getAxisX().getTitle();
 chartAxisXTitle.setText("Categories");
 chartAxisXTitle.setShow(true);
 ChartAxisTitle chartAxisYTitle = chart.getAxisY().getTitle();
 chartAxisYTitle.setText("Values");
 chartAxisYTitle.setShow(true);
 chartAxisYTitle.setOverlay(true);
 chartAxisYTitle.getFont().setSize(12.0);
 chartAxisYTitle.getFont().setColor(Color.BLUE);

 doc.save(getArtifactsDir() + "Charts.ChartAxisTitle.docx");
 
 

Parameters:

value - The text of the axis title.

getOverlay

public boolean getOverlay()

Determines whether other chart elements shall be allowed to overlap the title. The default value is false.

Examples:

Shows how to set chart axis title.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 Shape shape = builder.insertChart(ChartType.COLUMN, 432.0, 252.0);

 Chart chart = shape.getChart();
 ChartSeriesCollection seriesColl = chart.getSeries();
 // Delete default generated series.
 seriesColl.clear();

 seriesColl.add("AW Series 1", new String[] { "AW Category 1", "AW Category 2" }, new double[] { 1.0, 2.0 });

 // Set axis title.
 ChartAxisTitle chartAxisXTitle = chart.getAxisX().getTitle();
 chartAxisXTitle.setText("Categories");
 chartAxisXTitle.setShow(true);
 ChartAxisTitle chartAxisYTitle = chart.getAxisY().getTitle();
 chartAxisYTitle.setText("Values");
 chartAxisYTitle.setShow(true);
 chartAxisYTitle.setOverlay(true);
 chartAxisYTitle.getFont().setSize(12.0);
 chartAxisYTitle.getFont().setColor(Color.BLUE);

 doc.save(getArtifactsDir() + "Charts.ChartAxisTitle.docx");
 
 

Returns:

The corresponding boolean value.

setOverlay

public void setOverlay(boolean value)

Determines whether other chart elements shall be allowed to overlap the title. The default value is false.

Examples:

Shows how to set chart axis title.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 Shape shape = builder.insertChart(ChartType.COLUMN, 432.0, 252.0);

 Chart chart = shape.getChart();
 ChartSeriesCollection seriesColl = chart.getSeries();
 // Delete default generated series.
 seriesColl.clear();

 seriesColl.add("AW Series 1", new String[] { "AW Category 1", "AW Category 2" }, new double[] { 1.0, 2.0 });

 // Set axis title.
 ChartAxisTitle chartAxisXTitle = chart.getAxisX().getTitle();
 chartAxisXTitle.setText("Categories");
 chartAxisXTitle.setShow(true);
 ChartAxisTitle chartAxisYTitle = chart.getAxisY().getTitle();
 chartAxisYTitle.setText("Values");
 chartAxisYTitle.setShow(true);
 chartAxisYTitle.setOverlay(true);
 chartAxisYTitle.getFont().setSize(12.0);
 chartAxisYTitle.getFont().setColor(Color.BLUE);

 doc.save(getArtifactsDir() + "Charts.ChartAxisTitle.docx");
 
 

Parameters:

value - The corresponding boolean value.

getShow

public boolean getShow()

Determines whether the title shall be shown for the axis. The default value is false.

Examples:

Shows how to set chart axis title.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 Shape shape = builder.insertChart(ChartType.COLUMN, 432.0, 252.0);

 Chart chart = shape.getChart();
 ChartSeriesCollection seriesColl = chart.getSeries();
 // Delete default generated series.
 seriesColl.clear();

 seriesColl.add("AW Series 1", new String[] { "AW Category 1", "AW Category 2" }, new double[] { 1.0, 2.0 });

 // Set axis title.
 ChartAxisTitle chartAxisXTitle = chart.getAxisX().getTitle();
 chartAxisXTitle.setText("Categories");
 chartAxisXTitle.setShow(true);
 ChartAxisTitle chartAxisYTitle = chart.getAxisY().getTitle();
 chartAxisYTitle.setText("Values");
 chartAxisYTitle.setShow(true);
 chartAxisYTitle.setOverlay(true);
 chartAxisYTitle.getFont().setSize(12.0);
 chartAxisYTitle.getFont().setColor(Color.BLUE);

 doc.save(getArtifactsDir() + "Charts.ChartAxisTitle.docx");
 
 

Returns:

The corresponding boolean value.

setShow

public void setShow(boolean value)

Determines whether the title shall be shown for the axis. The default value is false.

Examples:

Shows how to set chart axis title.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 Shape shape = builder.insertChart(ChartType.COLUMN, 432.0, 252.0);

 Chart chart = shape.getChart();
 ChartSeriesCollection seriesColl = chart.getSeries();
 // Delete default generated series.
 seriesColl.clear();

 seriesColl.add("AW Series 1", new String[] { "AW Category 1", "AW Category 2" }, new double[] { 1.0, 2.0 });

 // Set axis title.
 ChartAxisTitle chartAxisXTitle = chart.getAxisX().getTitle();
 chartAxisXTitle.setText("Categories");
 chartAxisXTitle.setShow(true);
 ChartAxisTitle chartAxisYTitle = chart.getAxisY().getTitle();
 chartAxisYTitle.setText("Values");
 chartAxisYTitle.setShow(true);
 chartAxisYTitle.setOverlay(true);
 chartAxisYTitle.getFont().setSize(12.0);
 chartAxisYTitle.getFont().setColor(Color.BLUE);

 doc.save(getArtifactsDir() + "Charts.ChartAxisTitle.docx");
 
 

Parameters:

value - The corresponding boolean value.

getFont

public Font getFont()

Provides access to the font formatting of the axis title.

Examples:

Shows how to set chart axis title.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 Shape shape = builder.insertChart(ChartType.COLUMN, 432.0, 252.0);

 Chart chart = shape.getChart();
 ChartSeriesCollection seriesColl = chart.getSeries();
 // Delete default generated series.
 seriesColl.clear();

 seriesColl.add("AW Series 1", new String[] { "AW Category 1", "AW Category 2" }, new double[] { 1.0, 2.0 });

 // Set axis title.
 ChartAxisTitle chartAxisXTitle = chart.getAxisX().getTitle();
 chartAxisXTitle.setText("Categories");
 chartAxisXTitle.setShow(true);
 ChartAxisTitle chartAxisYTitle = chart.getAxisY().getTitle();
 chartAxisYTitle.setText("Values");
 chartAxisYTitle.setShow(true);
 chartAxisYTitle.setOverlay(true);
 chartAxisYTitle.getFont().setSize(12.0);
 chartAxisYTitle.getFont().setColor(Color.BLUE);

 doc.save(getArtifactsDir() + "Charts.ChartAxisTitle.docx");
 
 

Returns:

The corresponding Font value.

getFormat

public ChartFormat getFormat()

Provides access to fill and line formatting of the axis title.

Examples:

Shows how to use chart formating.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 Shape shape = builder.insertChart(ChartType.COLUMN, 432.0, 252.0);
 Chart chart = shape.getChart();

 // Delete series generated by default.
 ChartSeriesCollection series = chart.getSeries();
 series.clear();

 String[] categories = new String[] { "Category 1", "Category 2" };
 series.add("Series 1", categories, new double[] { 1.0, 2.0 });
 series.add("Series 2", categories, new double[] { 3.0, 4.0 });

 // Format chart background.
 chart.getFormat().getFill().solid(Color.darkGray);

 // Hide axis tick labels.
 chart.getAxisX().getTickLabels().setPosition(AxisTickLabelPosition.NONE);
 chart.getAxisY().getTickLabels().setPosition(AxisTickLabelPosition.NONE);

 // Format chart title.
 chart.getTitle().getFormat().getFill().solid(Color.yellow);

 // Format axis title.
 chart.getAxisX().getTitle().setShow(true);
 chart.getAxisX().getTitle().getFormat().getFill().solid(Color.yellow);

 // Format legend.
 chart.getLegend().getFormat().getFill().solid(Color.yellow);

 doc.save(getArtifactsDir() + "Charts.ChartFormat.docx");
 
 

Returns:

The corresponding ChartFormat value.