com.aspose.words
Class ChartXValue

java.lang.Object
    extended by com.aspose.words.ChartXValue

public class ChartXValue 
extends java.lang.Object

Represents an X value for a chart series.

This class contains a number of static methods for creating an X value of a particular type. The ValueType property allows you to determine the type of an existing X value.

All non-null X values of a chart series must be of the same ChartXValueType type.

Example:

Shows how to populate chart series with data.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder();

Shape shape = builder.insertChart(ChartType.COLUMN, 432.0, 252.0);
Chart chart = shape.getChart();
ChartSeries series1 = chart.getSeries().get(0);

// Clear X and Y values of the first series.
series1.clearValues();

// Populate the series with data.
series1.add(ChartXValue.fromDouble(3.0), ChartYValue.fromDouble(10.0));
series1.add(ChartXValue.fromDouble(5.0), ChartYValue.fromDouble(5.0));
series1.add(ChartXValue.fromDouble(7.0), ChartYValue.fromDouble(11.0));
series1.add(ChartXValue.fromDouble(9.0), ChartYValue.fromDouble(17.0));

ChartSeries series2 = chart.getSeries().get(1);

// Clear X and Y values of the second series.
series2.clearValues();

// Populate the series with data.
series2.add(ChartXValue.fromDouble(2.0), ChartYValue.fromDouble(4.0));
series2.add(ChartXValue.fromDouble(4.0), ChartYValue.fromDouble(7.0));
series2.add(ChartXValue.fromDouble(6.0), ChartYValue.fromDouble(14.0));
series2.add(ChartXValue.fromDouble(8.0), ChartYValue.fromDouble(7.0));

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

Property Getters/Setters Summary
java.util.DategetDateTimeValue()
           Gets the stored datetime value.
doublegetDoubleValue()
           Gets the stored numeric value.
ChartMultilevelValuegetMultilevelValue()
           Gets the stored multilevel value.
java.lang.StringgetStringValue()
           Gets the stored string value.
longgetTimeValue()
           Gets the stored time value.
intgetValueType()
           Gets the type of the X value stored in the object. The value of the property is ChartXValueType integer constant.
 
Method Summary
booleanequals(java.lang.Object obj)
           Gets a flag indicating whether the specified object is equal to the current X value object.
static ChartXValuefromDateTime(java.util.Date value)
           Creates a ChartXValue instance of the ChartXValueType.DATE_TIME type.
static ChartXValuefromDouble(double value)
           Creates a ChartXValue instance of the ChartXValueType.DOUBLE type.
static ChartXValuefromMultilevelValue(ChartMultilevelValue value)
           Creates a ChartXValue instance of the ChartXValueType.MULTILEVEL type.
static ChartXValuefromString(java.lang.String value)
           Creates a ChartXValue instance of the ChartXValueType.STRING type.
static ChartXValuefromTimeSpan(long value)
           Creates a ChartXValue instance of the ChartXValueType.TIME type.
 

Property Getters/Setters Detail

getDateTimeValue

public java.util.Date getDateTimeValue()
Gets the stored datetime value.

getDoubleValue

public double getDoubleValue()
Gets the stored numeric value.

getMultilevelValue

public ChartMultilevelValue getMultilevelValue()
Gets the stored multilevel value.

getStringValue

public java.lang.String getStringValue()
Gets the stored string value.

getTimeValue

public long getTimeValue()
Gets the stored time value.

getValueType

public int getValueType()
Gets the type of the X value stored in the object. The value of the property is ChartXValueType integer constant.

Method Detail

equals

public boolean equals(java.lang.Object obj)
Gets a flag indicating whether the specified object is equal to the current X value object.

fromDateTime

public static ChartXValue fromDateTime(java.util.Date value)
Creates a ChartXValue instance of the ChartXValueType.DATE_TIME type.

fromDouble

public static ChartXValue fromDouble(double value)
Creates a ChartXValue instance of the ChartXValueType.DOUBLE type.

Example:

Shows how to populate chart series with data.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder();

Shape shape = builder.insertChart(ChartType.COLUMN, 432.0, 252.0);
Chart chart = shape.getChart();
ChartSeries series1 = chart.getSeries().get(0);

// Clear X and Y values of the first series.
series1.clearValues();

// Populate the series with data.
series1.add(ChartXValue.fromDouble(3.0), ChartYValue.fromDouble(10.0));
series1.add(ChartXValue.fromDouble(5.0), ChartYValue.fromDouble(5.0));
series1.add(ChartXValue.fromDouble(7.0), ChartYValue.fromDouble(11.0));
series1.add(ChartXValue.fromDouble(9.0), ChartYValue.fromDouble(17.0));

ChartSeries series2 = chart.getSeries().get(1);

// Clear X and Y values of the second series.
series2.clearValues();

// Populate the series with data.
series2.add(ChartXValue.fromDouble(2.0), ChartYValue.fromDouble(4.0));
series2.add(ChartXValue.fromDouble(4.0), ChartYValue.fromDouble(7.0));
series2.add(ChartXValue.fromDouble(6.0), ChartYValue.fromDouble(14.0));
series2.add(ChartXValue.fromDouble(8.0), ChartYValue.fromDouble(7.0));

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

fromMultilevelValue

public static ChartXValue fromMultilevelValue(ChartMultilevelValue value)
Creates a ChartXValue instance of the ChartXValueType.MULTILEVEL type.

fromString

public static ChartXValue fromString(java.lang.String value)
Creates a ChartXValue instance of the ChartXValueType.STRING type.

Example:

Shows how to add/remove chart data values.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder();

Shape shape = builder.insertChart(ChartType.COLUMN, 432.0, 252.0);
Chart chart = shape.getChart();
ChartSeries department1Series = chart.getSeries().get(0);
ChartSeries department2Series = chart.getSeries().get(1);

// Remove the first value in the both series.
department1Series.remove(0);
department2Series.remove(0);

// Add new values to the both series.
ChartXValue newXCategory = ChartXValue.fromString("Q1, 2023");
department1Series.add(newXCategory, ChartYValue.fromDouble(10.3));
department2Series.add(newXCategory, ChartYValue.fromDouble(5.7));

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

fromTimeSpan

public static ChartXValue fromTimeSpan(long value)
Creates a ChartXValue instance of the ChartXValueType.TIME type.

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