ChartTitle
Inheritance: java.lang.Object
public class ChartTitle
Provides access to the chart title properties.
To learn more, visit the Working with Charts documentation article.
Examples:
Shows how to insert a chart and set a title.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a chart shape with a document builder and get its chart.
Shape chartShape = builder.insertChart(ChartType.BAR, 400.0, 300.0);
Chart chart = chartShape.getChart();
// Use the "Title" property to give our chart a title, which appears at the top center of the chart area.
ChartTitle title = chart.getTitle();
title.setText("My Chart");
// Set the "Show" property to "true" to make the title visible.
title.setShow(true);
// Set the "Overlay" property to "true" Give other chart elements more room by allowing them to overlap the title
title.setOverlay(true);
doc.save(getArtifactsDir() + "Charts.ChartTitle.docx");
Methods
| Method | Description |
|---|---|
| getOverlay() | Determines whether other chart elements shall be allowed to overlap title. |
| getShow() | Determines whether the title shall be shown for this chart. |
| getText() | Gets the text of the chart title. |
| setOverlay(boolean value) | Determines whether other chart elements shall be allowed to overlap title. |
| setShow(boolean value) | Determines whether the title shall be shown for this chart. |
| setText(String value) | Sets the text of the chart title. |
getOverlay()
public boolean getOverlay()
Determines whether other chart elements shall be allowed to overlap title. By default overlay is false .
Examples:
Shows how to insert a chart and set a title.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a chart shape with a document builder and get its chart.
Shape chartShape = builder.insertChart(ChartType.BAR, 400.0, 300.0);
Chart chart = chartShape.getChart();
// Use the "Title" property to give our chart a title, which appears at the top center of the chart area.
ChartTitle title = chart.getTitle();
title.setText("My Chart");
// Set the "Show" property to "true" to make the title visible.
title.setShow(true);
// Set the "Overlay" property to "true" Give other chart elements more room by allowing them to overlap the title
title.setOverlay(true);
doc.save(getArtifactsDir() + "Charts.ChartTitle.docx");
Returns: boolean - The corresponding boolean value.
getShow()
public boolean getShow()
Determines whether the title shall be shown for this chart. Default value is true .
Examples:
Shows how to insert a chart and set a title.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a chart shape with a document builder and get its chart.
Shape chartShape = builder.insertChart(ChartType.BAR, 400.0, 300.0);
Chart chart = chartShape.getChart();
// Use the "Title" property to give our chart a title, which appears at the top center of the chart area.
ChartTitle title = chart.getTitle();
title.setText("My Chart");
// Set the "Show" property to "true" to make the title visible.
title.setShow(true);
// Set the "Overlay" property to "true" Give other chart elements more room by allowing them to overlap the title
title.setOverlay(true);
doc.save(getArtifactsDir() + "Charts.ChartTitle.docx");
Returns: boolean - The corresponding boolean value.
getText()
public String getText()
Gets the text of the chart title. If null or empty value is specified, auto generated title will be shown.
Remarks:
Use getShow() / setShow(boolean) option if you need to hide the Title.
Examples:
Shows how to insert a chart and set a title.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a chart shape with a document builder and get its chart.
Shape chartShape = builder.insertChart(ChartType.BAR, 400.0, 300.0);
Chart chart = chartShape.getChart();
// Use the "Title" property to give our chart a title, which appears at the top center of the chart area.
ChartTitle title = chart.getTitle();
title.setText("My Chart");
// Set the "Show" property to "true" to make the title visible.
title.setShow(true);
// Set the "Overlay" property to "true" Give other chart elements more room by allowing them to overlap the title
title.setOverlay(true);
doc.save(getArtifactsDir() + "Charts.ChartTitle.docx");
Returns: java.lang.String - The text of the chart title.
setOverlay(boolean value)
public void setOverlay(boolean value)
Determines whether other chart elements shall be allowed to overlap title. By default overlay is false .
Examples:
Shows how to insert a chart and set a title.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a chart shape with a document builder and get its chart.
Shape chartShape = builder.insertChart(ChartType.BAR, 400.0, 300.0);
Chart chart = chartShape.getChart();
// Use the "Title" property to give our chart a title, which appears at the top center of the chart area.
ChartTitle title = chart.getTitle();
title.setText("My Chart");
// Set the "Show" property to "true" to make the title visible.
title.setShow(true);
// Set the "Overlay" property to "true" Give other chart elements more room by allowing them to overlap the title
title.setOverlay(true);
doc.save(getArtifactsDir() + "Charts.ChartTitle.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The corresponding boolean value. |
setShow(boolean value)
public void setShow(boolean value)
Determines whether the title shall be shown for this chart. Default value is true .
Examples:
Shows how to insert a chart and set a title.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a chart shape with a document builder and get its chart.
Shape chartShape = builder.insertChart(ChartType.BAR, 400.0, 300.0);
Chart chart = chartShape.getChart();
// Use the "Title" property to give our chart a title, which appears at the top center of the chart area.
ChartTitle title = chart.getTitle();
title.setText("My Chart");
// Set the "Show" property to "true" to make the title visible.
title.setShow(true);
// Set the "Overlay" property to "true" Give other chart elements more room by allowing them to overlap the title
title.setOverlay(true);
doc.save(getArtifactsDir() + "Charts.ChartTitle.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The corresponding boolean value. |
setText(String value)
public void setText(String value)
Sets the text of the chart title. If null or empty value is specified, auto generated title will be shown.
Remarks:
Use getShow() / setShow(boolean) option if you need to hide the Title.
Examples:
Shows how to insert a chart and set a title.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a chart shape with a document builder and get its chart.
Shape chartShape = builder.insertChart(ChartType.BAR, 400.0, 300.0);
Chart chart = chartShape.getChart();
// Use the "Title" property to give our chart a title, which appears at the top center of the chart area.
ChartTitle title = chart.getTitle();
title.setText("My Chart");
// Set the "Show" property to "true" to make the title visible.
title.setShow(true);
// Set the "Overlay" property to "true" Give other chart elements more room by allowing them to overlap the title
title.setOverlay(true);
doc.save(getArtifactsDir() + "Charts.ChartTitle.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | The text of the chart title. |
