com.aspose.words

Class ChartFormat

java.lang.Object

com.aspose.words.ChartFormat

public class ChartFormat
extends java.lang.Object

Represents the formatting of a chart element.

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

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");
 
 

Method Summary

Modifier and Type	Method and Description
int	getDashStyle()
int	getEndArrowLength()
int	getEndArrowType()
int	getEndArrowWidth()
int	getEndCap()
Fill	getFill() Gets fill formatting for the parent chart element.
java.awt.Color	getFillableBackColor()
int	getFillableBackThemeColor()
double	getFillableBackTintAndShade()
java.awt.Color	getFillableBaseForeColor()
java.awt.Color	getFillableForeColor()
int	getFillableForeThemeColor()
double	getFillableForeTintAndShade()
byte[]	getFillableImageBytes()
double	getFillableTransparency()
boolean	getFillableVisible()
java.awt.Color	getFilledColor()
int	getFillType()
double	getGradientAngle()
GradientStopCollection	getGradientStops()
int	getGradientStyle()
int	getGradientVariant()
int	getJoinStyle()
int	getLineFillType()
int	getLineStyle()
boolean	getOldOn()
double	getOldOpacity()
int	getPatternType()
int	getPresetTexture()
boolean	getRotateWithObject()
int	getShapeType() Gets the shape type of the parent chart element.
int	getStartArrowLength()
int	getStartArrowType()
int	getStartArrowWidth()
Stroke	getStroke() Gets line formatting for the parent chart element.
int	getStrokeBackThemeColor()
double	getStrokeBackTintAndShade()
int	getStrokeForeThemeColor()
double	getStrokeForeTintAndShade()
byte[]	getStrokeImageBytes()
double	getStrokeTransparency()
boolean	getStrokeVisible()
int	getTextureAlignment()
double	getWeight()
boolean	isDefined() Gets a flag indicating whether any format is defined.
void	oneColorGradient(int style, int variant, double degree)
void	patterned(int patternType)
void	presetTextured(int presetTexture)
void	setDashStyle(int value)
void	setDefaultFill() Resets the fill of the chart element to have the default value.
void	setEndArrowLength(int value)
void	setEndArrowType(int value)
void	setEndArrowWidth(int value)
void	setEndCap(int value)
void	setFillableBackColor(java.awt.Color value)
void	setFillableBackThemeColor(int value)
void	setFillableBackTintAndShade(double value)
void	setFillableForeColor(java.awt.Color value)
void	setFillableForeThemeColor(int value)
void	setFillableForeTintAndShade(double value)
void	setFillableTransparency(double value)
void	setFillableVisible(boolean value)
void	setFilledColor(java.awt.Color value)
void	setGradientAngle(double value)
void	setImage(byte[] imageBytes)
void	setJoinStyle(int value)
void	setLineFillType(int value)
void	setLineStyle(int value)
void	setOldOn(boolean value)
void	setOldOpacity(double value)
void	setRotateWithObject(boolean value)
void	setShapeType(int value) Sets the shape type of the parent chart element.
void	setStartArrowLength(int value)
void	setStartArrowType(int value)
void	setStartArrowWidth(int value)
void	setStrokeBackThemeColor(int value)
void	setStrokeBackTintAndShade(double value)
void	setStrokeForeThemeColor(int value)
void	setStrokeForeTintAndShade(double value)
void	setStrokeTransparency(double value)
void	setStrokeVisible(boolean value)
void	setTextureAlignment(int value)
void	setWeight(double value)
void	solid()
void	twoColorGradient(int style, int variant)

Methods inherited from class java.lang.Object

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

Method Detail

setDefaultFill

public void setDefaultFill()

Resets the fill of the chart element to have the default value.

Examples:

Shows how to reset the fill to the default value defined in the series.

 
 Document doc = new Document(getMyDir() + "DataPoint format.docx");

 Shape shape = (Shape)doc.getChild(NodeType.SHAPE, 0, true);
 ChartSeries series = shape.getChart().getSeries().get(0);
 ChartDataPoint dataPoint = series.getDataPoints().get(1);

 Assert.assertTrue(dataPoint.getFormat().isDefined());

 dataPoint.getFormat().setDefaultFill();

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

solid

public void solid()

presetTextured

public void presetTextured(int presetTexture)

patterned

public void patterned(int patternType)

getPresetTexture

public int getPresetTexture()
                     throws java.lang.Exception

Throws:

java.lang.Exception

getPatternType

public int getPatternType()

oneColorGradient

public void oneColorGradient(int style,
                             int variant,
                             double degree)

twoColorGradient

public void twoColorGradient(int style,
                             int variant)

setImage

public void setImage(byte[] imageBytes)

getFilledColor

public java.awt.Color getFilledColor()

setFilledColor

public void setFilledColor(java.awt.Color value)

getOldOn

public boolean getOldOn()

setOldOn

public void setOldOn(boolean value)

getOldOpacity

public double getOldOpacity()

setOldOpacity

public void setOldOpacity(double value)

getFillableImageBytes

public byte[] getFillableImageBytes()

getFillableForeColor

public java.awt.Color getFillableForeColor()

setFillableForeColor

public void setFillableForeColor(java.awt.Color value)

getFillableBaseForeColor

public java.awt.Color getFillableBaseForeColor()

getFillableBackColor

public java.awt.Color getFillableBackColor()

setFillableBackColor

public void setFillableBackColor(java.awt.Color value)

getFillableForeThemeColor

public int getFillableForeThemeColor()

setFillableForeThemeColor

public void setFillableForeThemeColor(int value)

getFillableBackThemeColor

public int getFillableBackThemeColor()

setFillableBackThemeColor

public void setFillableBackThemeColor(int value)

getFillableForeTintAndShade

public double getFillableForeTintAndShade()

setFillableForeTintAndShade

public void setFillableForeTintAndShade(double value)

getFillableBackTintAndShade

public double getFillableBackTintAndShade()

setFillableBackTintAndShade

public void setFillableBackTintAndShade(double value)

getFillableVisible

public boolean getFillableVisible()

setFillableVisible

public void setFillableVisible(boolean value)

getFillableTransparency

public double getFillableTransparency()

setFillableTransparency

public void setFillableTransparency(double value)

getRotateWithObject

public boolean getRotateWithObject()

setRotateWithObject

public void setRotateWithObject(boolean value)

getFillType

public int getFillType()

getTextureAlignment

public int getTextureAlignment()

setTextureAlignment

public void setTextureAlignment(int value)

getGradientAngle

public double getGradientAngle()

setGradientAngle

public void setGradientAngle(double value)

getGradientVariant

public int getGradientVariant()

getGradientStyle

public int getGradientStyle()

getGradientStops

public GradientStopCollection getGradientStops()

getStrokeForeThemeColor

public int getStrokeForeThemeColor()

setStrokeForeThemeColor

public void setStrokeForeThemeColor(int value)

getStrokeBackThemeColor

public int getStrokeBackThemeColor()

setStrokeBackThemeColor

public void setStrokeBackThemeColor(int value)

getStrokeForeTintAndShade

public double getStrokeForeTintAndShade()

setStrokeForeTintAndShade

public void setStrokeForeTintAndShade(double value)

getStrokeBackTintAndShade

public double getStrokeBackTintAndShade()

setStrokeBackTintAndShade

public void setStrokeBackTintAndShade(double value)

getStrokeVisible

public boolean getStrokeVisible()

setStrokeVisible

public void setStrokeVisible(boolean value)

getStrokeTransparency

public double getStrokeTransparency()

setStrokeTransparency

public void setStrokeTransparency(double value)

getWeight

public double getWeight()

setWeight

public void setWeight(double value)

getDashStyle

public int getDashStyle()

setDashStyle

public void setDashStyle(int value)

getJoinStyle

public int getJoinStyle()

setJoinStyle

public void setJoinStyle(int value)

getEndCap

public int getEndCap()

setEndCap

public void setEndCap(int value)

getLineStyle

public int getLineStyle()

setLineStyle

public void setLineStyle(int value)

getStartArrowType

public int getStartArrowType()

setStartArrowType

public void setStartArrowType(int value)

getEndArrowType

public int getEndArrowType()

setEndArrowType

public void setEndArrowType(int value)

getStartArrowWidth

public int getStartArrowWidth()

setStartArrowWidth

public void setStartArrowWidth(int value)

getStartArrowLength

public int getStartArrowLength()

setStartArrowLength

public void setStartArrowLength(int value)

getEndArrowWidth

public int getEndArrowWidth()

setEndArrowWidth

public void setEndArrowWidth(int value)

getEndArrowLength

public int getEndArrowLength()

setEndArrowLength

public void setEndArrowLength(int value)

getLineFillType

public int getLineFillType()

setLineFillType

public void setLineFillType(int value)

getStrokeImageBytes

public byte[] getStrokeImageBytes()
                           throws java.lang.Exception

Throws:

java.lang.Exception

getFill

public Fill getFill()

Gets fill formatting for the parent chart element.

Examples:

Show how to set marker formatting.

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

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

 // Delete default generated series.
 chart.getSeries().clear();
 ChartSeries series = chart.getSeries().add("AW Series 1", new double[] { 0.7, 1.8, 2.6, 3.9 },
         new double[] { 2.7, 3.2, 0.8, 1.7 });

 // Set marker formatting.
 series.getMarker().setSize(40);
 series.getMarker().setSymbol(MarkerSymbol.SQUARE);
 ChartDataPointCollection dataPoints = series.getDataPoints();
 dataPoints.get(0).getMarker().getFormat().getFill().presetTextured(PresetTexture.DENIM);
 dataPoints.get(0).getMarker().getFormat().getStroke().setForeColor(Color.YELLOW);
 dataPoints.get(0).getMarker().getFormat().getStroke().setBackColor(Color.RED);
 dataPoints.get(1).getMarker().getFormat().getFill().presetTextured(PresetTexture.WATER_DROPLETS);
 dataPoints.get(1).getMarker().getFormat().getStroke().setForeColor(Color.YELLOW);
 dataPoints.get(1).getMarker().getFormat().getStroke().setVisible(false);
 dataPoints.get(2).getMarker().getFormat().getFill().presetTextured(PresetTexture.GREEN_MARBLE);
 dataPoints.get(2).getMarker().getFormat().getStroke().setForeColor(Color.YELLOW);
 dataPoints.get(3).getMarker().getFormat().getFill().presetTextured(PresetTexture.OAK);
 dataPoints.get(3).getMarker().getFormat().getStroke().setForeColor(Color.YELLOW);
 dataPoints.get(3).getMarker().getFormat().getStroke().setTransparency(0.5);

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

Returns:

Fill formatting for the parent chart element.

getStroke

public Stroke getStroke()

Gets line formatting for the parent chart element.

Examples:

Show how to set marker formatting.

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

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

 // Delete default generated series.
 chart.getSeries().clear();
 ChartSeries series = chart.getSeries().add("AW Series 1", new double[] { 0.7, 1.8, 2.6, 3.9 },
         new double[] { 2.7, 3.2, 0.8, 1.7 });

 // Set marker formatting.
 series.getMarker().setSize(40);
 series.getMarker().setSymbol(MarkerSymbol.SQUARE);
 ChartDataPointCollection dataPoints = series.getDataPoints();
 dataPoints.get(0).getMarker().getFormat().getFill().presetTextured(PresetTexture.DENIM);
 dataPoints.get(0).getMarker().getFormat().getStroke().setForeColor(Color.YELLOW);
 dataPoints.get(0).getMarker().getFormat().getStroke().setBackColor(Color.RED);
 dataPoints.get(1).getMarker().getFormat().getFill().presetTextured(PresetTexture.WATER_DROPLETS);
 dataPoints.get(1).getMarker().getFormat().getStroke().setForeColor(Color.YELLOW);
 dataPoints.get(1).getMarker().getFormat().getStroke().setVisible(false);
 dataPoints.get(2).getMarker().getFormat().getFill().presetTextured(PresetTexture.GREEN_MARBLE);
 dataPoints.get(2).getMarker().getFormat().getStroke().setForeColor(Color.YELLOW);
 dataPoints.get(3).getMarker().getFormat().getFill().presetTextured(PresetTexture.OAK);
 dataPoints.get(3).getMarker().getFormat().getStroke().setForeColor(Color.YELLOW);
 dataPoints.get(3).getMarker().getFormat().getStroke().setTransparency(0.5);

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

Returns:

Line formatting for the parent chart element.

getShapeType

public int getShapeType()

Gets the shape type of the parent chart element.

Remarks:

Currently, the property can only be used for data labels.

Examples:

Shows how to set fill, stroke and callout formatting for chart data labels.

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

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

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

 // Add new series.
 ChartSeries series = chart.getSeries().add("AW Series 1",
         new String[] { "AW Category 1", "AW Category 2", "AW Category 3", "AW Category 4" },
         new double[] { 100.0, 200.0, 300.0, 400.0 });

 // Show data labels.
 series.hasDataLabels(true);
 series.getDataLabels().setShowValue(true);

 // Format data labels as callouts.
 ChartFormat format = series.getDataLabels().getFormat();
 format.setShapeType(ChartShapeType.WEDGE_RECT_CALLOUT);
 format.getStroke().setColor(Color.lightGray);
 format.getFill().solid(Color.GREEN);
 series.getDataLabels().getFont().setColor(Color.YELLOW);

 // Change fill and stroke of an individual data label.
 ChartFormat labelFormat = series.getDataLabels().get(0).getFormat();
 labelFormat.getStroke().setColor(Color.BLUE);
 labelFormat.getFill().solid(Color.BLUE);

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

Returns:

The shape type of the parent chart element. The returned value is one of ChartShapeType constants.

setShapeType

public void setShapeType(int value)

Sets the shape type of the parent chart element.

Remarks:

Currently, the property can only be used for data labels.

Examples:

Shows how to set fill, stroke and callout formatting for chart data labels.

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

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

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

 // Add new series.
 ChartSeries series = chart.getSeries().add("AW Series 1",
         new String[] { "AW Category 1", "AW Category 2", "AW Category 3", "AW Category 4" },
         new double[] { 100.0, 200.0, 300.0, 400.0 });

 // Show data labels.
 series.hasDataLabels(true);
 series.getDataLabels().setShowValue(true);

 // Format data labels as callouts.
 ChartFormat format = series.getDataLabels().getFormat();
 format.setShapeType(ChartShapeType.WEDGE_RECT_CALLOUT);
 format.getStroke().setColor(Color.lightGray);
 format.getFill().solid(Color.GREEN);
 series.getDataLabels().getFont().setColor(Color.YELLOW);

 // Change fill and stroke of an individual data label.
 ChartFormat labelFormat = series.getDataLabels().get(0).getFormat();
 labelFormat.getStroke().setColor(Color.BLUE);
 labelFormat.getFill().solid(Color.BLUE);

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

Parameters:

value - The shape type of the parent chart element. The value must be one of ChartShapeType constants.

isDefined

public boolean isDefined()

Gets a flag indicating whether any format is defined.

Examples:

Shows how to reset the fill to the default value defined in the series.

 
 Document doc = new Document(getMyDir() + "DataPoint format.docx");

 Shape shape = (Shape)doc.getChild(NodeType.SHAPE, 0, true);
 ChartSeries series = shape.getChart().getSeries().get(0);
 ChartDataPoint dataPoint = series.getDataPoints().get(1);

 Assert.assertTrue(dataPoint.getFormat().isDefined());

 dataPoint.getFormat().setDefaultFill();

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

Returns:

A flag indicating whether any format is defined.