com.aspose.words
Class ChartYValue

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

public class ChartYValue 
extends java.lang.Object

Represents an Y value for a chart series.

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

All non-null Y values of a chart series must be of the same ChartYValueType type.


Property Getters/Setters Summary
java.util.DategetDateTimeValue()
           Gets the stored datetime value.
doublegetDoubleValue()
           Gets the stored numeric value.
longgetTimeValue()
           Gets the stored time value.
intgetValueType()
           Gets the type of the Y value stored in the object. The value of the property is ChartYValueType integer constant.
 
Method Summary
booleanequals(java.lang.Object obj)
           Gets a flag indicating whether the specified object is equal to the current Y value object.
static ChartYValuefromDateTime(java.util.Date value)
           Creates a ChartYValue instance of the ChartYValueType.DATE_TIME type.
static ChartYValuefromDouble(double value)
           Creates a ChartYValue instance of the ChartYValueType.DOUBLE type.
static ChartYValuefromTimeSpan(long value)
           Creates a ChartYValue instance of the ChartYValueType.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.

getTimeValue

public long getTimeValue()
Gets the stored time value.

getValueType

public int getValueType()
Gets the type of the Y value stored in the object. The value of the property is ChartYValueType 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 Y value object.

fromDateTime

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

fromDouble

public static ChartYValue fromDouble(double value)
Creates a ChartYValue instance of the ChartYValueType.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");

fromTimeSpan

public static ChartYValue fromTimeSpan(long value)
Creates a ChartYValue instance of the ChartYValueType.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.