com.softwarefx.chartfx.server

Class CustomGridLineValue

java.lang.Object

com.softwarefx.chartfx.server.CustomGridLineValue

public class CustomGridLineValue
extends java.lang.Object

Provides access to the CustomGridLineValue object.

This class is used to set the CustomGridLine value used to draw the line. The developer can assign a specific CustomGridLine value when creating a non-calculated CustomGridLine.

The setValue method to draw a CustomGridLine can be a statistical calculation.

Constructor Summary

Constructors

Constructor and Description
CustomGridLineValue() Constructs a newly allocated CustomGridLineValue object
CustomGridLineValue(CustomGridLineCalculation value) Constructs a newly allocated CustomGridLineValue object
CustomGridLineValue(DataUnit value) Constructs a newly allocated CustomGridLineValue object
CustomGridLineValue(java.util.Date value) Constructs a newly allocated CustomGridLineValue object
CustomGridLineValue(double value) Constructs a newly allocated CustomGridLineValue object
CustomGridLineValue(TimeSpan value) Constructs a newly allocated CustomGridLineValue object

Method Summary

Methods

Modifier and Type	Method and Description
CustomGridLineCalculation	getCalculation() Gets or sets a CustomGridLine Calculation to be used in a CustomGridLine
double	getValue() Gets or sets a value in the Axis where the CustomGridLine is draw in the chart.
void	resetCalculation() Set the property Calculation to its default value.
void	resetValue() Set the property Value to its default value.
void	setCalculation(CustomGridLineCalculation value) Gets or sets a CustomGridLine Calculation to be used in a CustomGridLine
void	setValue(double value) Gets or sets a value in the Axis where the CustomGridLine is draw in the chart.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomGridLineValue

public CustomGridLineValue()

Constructs a newly allocated CustomGridLineValue object

CustomGridLineValue

public CustomGridLineValue(TimeSpan value)

Constructs a newly allocated CustomGridLineValue object

Parameters:

value -

CustomGridLineValue

public CustomGridLineValue(CustomGridLineCalculation value)

Constructs a newly allocated CustomGridLineValue object

Parameters:

value -

CustomGridLineValue

public CustomGridLineValue(DataUnit value)

Constructs a newly allocated CustomGridLineValue object

Parameters:

value -

CustomGridLineValue

public CustomGridLineValue(double value)

Constructs a newly allocated CustomGridLineValue object

Parameters:

value -

CustomGridLineValue

public CustomGridLineValue(java.util.Date value)

Constructs a newly allocated CustomGridLineValue object

Parameters:

value -

Method Detail

getCalculation

public CustomGridLineCalculation getCalculation()

Gets or sets a CustomGridLine Calculation to be used in a CustomGridLine

The Calculation attribute provide developers with a mechanism for performing statistical calculations to be used as the CustomGridLine value

To set the Mean statistical calculation as the value to draw a CustomGridLine:

• Java

• CustomGridLineValue CustomGridval;
  CustomGridval = new CustomGridLineValue();
  CustomGridval.setCalculation(CustomGridLineCalculation.Mean);
  CustomGridLine CustomGridLine1;
  CustomGridLine1 = new CustomGridLine();
  CustomGridLine1.setValue(CustomGridval);
  chart1.getAxisY().getCustomGridLines().add(CustomGridLine1);
  

See Also:

resetCalculation

setCalculation

public void setCalculation(CustomGridLineCalculation value)

Gets or sets a CustomGridLine Calculation to be used in a CustomGridLine

The Calculation attribute provide developers with a mechanism for performing statistical calculations to be used as the CustomGridLine value

To set the Mean statistical calculation as the value to draw a CustomGridLine:

• Java

• CustomGridLineValue CustomGridval;
  CustomGridval = new CustomGridLineValue();
  CustomGridval.setCalculation(CustomGridLineCalculation.Mean);
  CustomGridLine CustomGridLine1;
  CustomGridLine1 = new CustomGridLine();
  CustomGridLine1.setValue(CustomGridval);
  chart1.getAxisY().getCustomGridLines().add(CustomGridLine1);
  

Parameters:

value -

See Also:

resetCalculation

getValue

public double getValue()

Gets or sets a value in the Axis where the CustomGridLine is draw in the chart.

This method can be set to a DataUnit value when setting the CustomGridLine setCalculation method to none.

When the programmer is setting the CustomGridLineValue.Calculation attribute using a statistical calculation, this value does not need to be set and will be auto calculated.

To draw a CustomGridLine by setting the Value to 100:

• Java

• CustomGridLineValue CustomGridval;
  CustomGridval = new CustomGridLineValue();
  CustomGridval.setCalculation(CustomGridLineCalculation.None);
  CustomGridval.setValue(new DataUnit(100.0));
  CustomGridLine CustomGridLine1;
  CustomGridLine1 = new CustomGridLine();
  CustomGridLine1.getTitle().setText("Custom Grid");
  CustomGridLine1.setValue(CustomGridval);
  chart1.getAxisY().getCustomGridLines().add(CustomGridLine1);
  

See Also:

resetValue

setValue

public void setValue(double value)

Gets or sets a value in the Axis where the CustomGridLine is draw in the chart.

This method can be set to a DataUnit value when setting the CustomGridLine setCalculation method to none.

When the programmer is setting the CustomGridLineValue.Calculation attribute using a statistical calculation, this value does not need to be set and will be auto calculated.

To draw a CustomGridLine by setting the Value to 100:

• Java

• CustomGridLineValue CustomGridval;
  CustomGridval = new CustomGridLineValue();
  CustomGridval.setCalculation(CustomGridLineCalculation.None);
  CustomGridval.setValue(new DataUnit(100.0));
  CustomGridLine CustomGridLine1;
  CustomGridLine1 = new CustomGridLine();
  CustomGridLine1.getTitle().setText("Custom Grid");
  CustomGridLine1.setValue(CustomGridval);
  chart1.getAxisY().getCustomGridLines().add(CustomGridLine1);
  

Parameters:

value -

See Also:

resetValue

resetCalculation

public void resetCalculation()

Set the property Calculation to its default value.

See Also:

setCalculation

resetValue

public void resetValue()

Set the property Value to its default value.

See Also:

setValue