com.aspose.words

Class BubbleSizeCollection

java.lang.Object

com.aspose.words.BubbleSizeCollection

All Implemented Interfaces:

java.lang.Iterable

public class BubbleSizeCollection
extends java.lang.Object
implements java.lang.Iterable

Represents a collection of bubble sizes for a chart series.

Remarks:

The collection allows only changing bubble sizes. To add or insert new values to a chart series, or remove values, the appropriate methods of the ChartSeries class can be used.

Empty bubble size values are represented as double#NA_N.

See Also:

ChartSeries.add(com.aspose.words.ChartXValue), ChartSeries.add(com.aspose.words.ChartXValue, com.aspose.words.ChartYValue), ChartSeries.add(com.aspose.words.ChartXValue, com.aspose.words.ChartYValue, double), ChartSeries.insert(int, com.aspose.words.ChartXValue), ChartSeries.insert(int, com.aspose.words.ChartXValue, com.aspose.words.ChartYValue), ChartSeries.insert(int, com.aspose.words.ChartXValue, com.aspose.words.ChartYValue, double), ChartSeries.remove(int)

Method Summary

Modifier and Type	Method and Description
double	get(int index) Gets the bubble size value at the specified index.
int	getCount() Gets the number of items in this collection.
java.lang.String	getFormatCode() Gets the format code applied to the bubble sizes.
java.util.Iterator	iterator() Returns an enumerator object.
void	set(int index, double value) Sets the bubble size value at the specified index.
void	setFormatCode(java.lang.String value) Sets the format code applied to the bubble sizes.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

iterator

public java.util.Iterator iterator()

Returns an enumerator object.

Specified by:

iterator in interface java.lang.Iterable

getCount

public int getCount()

Gets the number of items in this collection.

Returns:

The number of items in this collection.

get

public double get(int index)

Gets the bubble size value at the specified index.

Returns:

The bubble size value at the specified index.

set

public void set(int index,
                double value)

Sets the bubble size value at the specified index.

Parameters:

value - The bubble size value at the specified index.

getFormatCode

public java.lang.String getFormatCode()

Gets the format code applied to the bubble sizes.

Remarks:

Number formatting is used to change the way values appears in the chart. The examples of number formats:

Number - "#,##0.00"

Currency - "\"$\"#,##0.00"

Time - "[$-x-systime]h:mm:ss AM/PM"

Date - "d/mm/yyyy"

Percentage - "0.00%"

Fraction - "# ?/?"

Scientific - "0.00E+00"

Accounting - "_-\"$\"* #,##0.00_-;-\"$\"* #,##0.00_-;_-\"$\"* \"-\"??_-;_-@_-"

Custom with color - "[Red]-#,##0.0"

Examples:

Shows how to work with the format code of the chart data.

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

 // Insert a Bubble chart.
 Shape shape = builder.insertChart(ChartType.BUBBLE, 432.0, 252.0);
 Chart chart = shape.getChart();

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

 ChartSeries series = chart.getSeries().add(
         "Series1",
         new double[] { 1.0, 1.9, 2.45, 3.0 },
         new double[] { 1.0, -0.9, 1.82, 0.0 },
         new double[] { 2.0, 1.1, 2.95, 2.0 });

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

 // Set data format codes.
 series.getXValues().setFormatCode("#,##0.0#");
 series.getYValues().setFormatCode("#,##0.0#;[Red]\\-#,##0.0#");
 series.getBubbleSizes().setFormatCode("#,##0.0#");

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

Returns:

The format code applied to the bubble sizes.

setFormatCode

public void setFormatCode(java.lang.String value)

Sets the format code applied to the bubble sizes.

Remarks:

Number formatting is used to change the way values appears in the chart. The examples of number formats:

Number - "#,##0.00"

Currency - "\"$\"#,##0.00"

Time - "[$-x-systime]h:mm:ss AM/PM"

Date - "d/mm/yyyy"

Percentage - "0.00%"

Fraction - "# ?/?"

Scientific - "0.00E+00"

Accounting - "_-\"$\"* #,##0.00_-;-\"$\"* #,##0.00_-;_-\"$\"* \"-\"??_-;_-@_-"

Custom with color - "[Red]-#,##0.0"

Examples:

Shows how to work with the format code of the chart data.

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

 // Insert a Bubble chart.
 Shape shape = builder.insertChart(ChartType.BUBBLE, 432.0, 252.0);
 Chart chart = shape.getChart();

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

 ChartSeries series = chart.getSeries().add(
         "Series1",
         new double[] { 1.0, 1.9, 2.45, 3.0 },
         new double[] { 1.0, -0.9, 1.82, 0.0 },
         new double[] { 2.0, 1.1, 2.95, 2.0 });

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

 // Set data format codes.
 series.getXValues().setFormatCode("#,##0.0#");
 series.getYValues().setFormatCode("#,##0.0#;[Red]\\-#,##0.0#");
 series.getBubbleSizes().setFormatCode("#,##0.0#");

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

Parameters:

value - The format code applied to the bubble sizes.