com.aspose.words
Class ChartLegendEntry

java.lang.Object
    extended by com.aspose.words.ChartLegendEntry
All Implemented Interfaces:
java.lang.Cloneable

public class ChartLegendEntry 
extends java.lang.Object

Represents a chart legend entry.

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

A legend entry corresponds to a specific chart series or trendline.

The text of the entry is the name of the series or trendline. The text cannot be changed.

Example:

Shows how to work with a legend font.
Document doc = new Document(getMyDir() + "Reporting engine template - Chart series (Java).docx");
Chart chart = ((Shape)doc.getChild(NodeType.SHAPE, 0, true)).getChart();

ChartLegend chartLegend = chart.getLegend();
// Set default font size all legend entries.
chartLegend.getFont().setSize(14.0);
// Change font for specific legend entry.
chartLegend.getLegendEntries().get(1).getFont().setItalic(true);
chartLegend.getLegendEntries().get(1).getFont().setSize(12.0);

doc.save(getArtifactsDir() + "Charts.LegendFont.docx");
See Also:
ChartSeries.LegendEntry

Property Getters/Setters Summary
FontgetFont()
           Provides access to the font formatting of this legend entry.
booleanisHidden()
voidisHidden(boolean value)
           Gets or sets a value indicating whether this entry is hidden in the chart legend. The default value is false.
 

Property Getters/Setters Detail

getFont

public Font getFont()
Provides access to the font formatting of this legend entry.

Example:

Shows how to work with a legend font.
Document doc = new Document(getMyDir() + "Reporting engine template - Chart series (Java).docx");
Chart chart = ((Shape)doc.getChild(NodeType.SHAPE, 0, true)).getChart();

ChartLegend chartLegend = chart.getLegend();
// Set default font size all legend entries.
chartLegend.getFont().setSize(14.0);
// Change font for specific legend entry.
chartLegend.getLegendEntries().get(1).getFont().setItalic(true);
chartLegend.getLegendEntries().get(1).getFont().setSize(12.0);

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

isHidden/isHidden

public boolean isHidden() / public void isHidden(boolean value)
Gets or sets a value indicating whether this entry is hidden in the chart legend. The default value is false. When a chart legend entry is hidden, it does not affect the corresponding chart series or trendline that is still displayed on the chart.

Example:

Shows how to work with a legend entry for chart series.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

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

Chart chart = shape.getChart();
ChartSeriesCollection series = chart.getSeries();
series.clear();

String[] categories = new String[] { "AW Category 1", "AW Category 2" };

ChartSeries series1 = series.add("Series 1", categories, new double[] { 1.0, 2.0 });
series.add("Series 2", categories, new double[] { 3.0, 4.0 });
series.add("Series 3", categories, new double[] { 5.0, 6.0 });
series.add("Series 4", categories, new double[] { 0.0, 0.0 });

ChartLegendEntryCollection legendEntries = chart.getLegend().getLegendEntries();
legendEntries.get(3).isHidden(true);

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

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.