Home  Products  Purchase  Downloads  Demos  Forums  Blogs  Ticket  Wiki  API  Corporate


com.aspose.cells
Class ErrorBars

java.lang.Object
  extended by com.aspose.cells.ErrorBars

public class ErrorBars
extends java.lang.Object

Represents the error bars on a chart series.


Method Summary
 double getAmount()
          Gets the error amount.
 Line getBorder()
          Gets the line or border of ErrorBars object.
 java.lang.String getCustomAmount()
          Deprecated. replaced by getPlusValues()
 byte getInclude()
          Gets type of the error bar parts to include.
 java.lang.String getMinusValues()
          Gets the negative error amount when type is custom.
 java.lang.String getPlusValues()
          Gets the negative error amount when type is custom.
 byte getType()
          Gets the error bar type.
 boolean hasEndStyleCap()
          Indicates whether the error bars has the end style cap for the error bars.
 void setAmount(byte type, double amount)
          Sets the error bar type and amount.
 void setCustomAmount(java.lang.String plusValues, java.lang.String minusValues)
          Sets the error bar custom amount.
 void setEndStyleCap(boolean hasCap)
          Sets whether the error bars has the end style cap for the error bars.
 void setInclude(byte include)
          Sets the type of the error bar parts to include.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getBorder

public Line getBorder()
Gets the line or border of ErrorBars object.

Returns:
the line or border of ErrorBars object.
Throws:
CellsException - if ASeries object has bean removed.

getInclude

public byte getInclude()
Gets type of the error bar parts to include.

Returns:
the type of the error bar parts to include.
See Also:
setInclude(byte)

setInclude

public void setInclude(byte include)
Sets the type of the error bar parts to include.

Parameters:
include - the type of the error bar parts to include. It could be one of the following values:
ErrorBarInclude.NONE
ErrorBarInclude.BOTH
ErrorBarInclude.MINUS_VALUES
ErrorBarInclude.PLUS_VALUES
Throws:
java.lang.IllegalArgumentException - if the type is invalid.
CellsException - if ASeries object has bean removed.

getType

public byte getType()
Gets the error bar type.

Returns:
the error bar type.
See Also:
setAmount(byte, double)

getAmount

public double getAmount()
Gets the error amount.

Returns:
the error amount.

getCustomAmount

public java.lang.String getCustomAmount()
Deprecated. replaced by getPlusValues()

Gets the positive error amount when type is custom.

Returns:
the positive error amount when type is custom.

getPlusValues

public java.lang.String getPlusValues()
Gets the negative error amount when type is custom.

Returns:
the negative error amount when type is custom.

getMinusValues

public java.lang.String getMinusValues()
Gets the negative error amount when type is custom.

Returns:
the negative error amount when type is custom.

setAmount

public void setAmount(byte type,
                      double amount)
Sets the error bar type and amount.

Parameters:
type - The error bar type. It could be one of the following values:
ErrorBarType.PERCENT
ErrorBarType.STANDARD_ERROR
ErrorBarType.FIXED_VALUE
ErrorBarType.STANDARD_DEV
amount - The error amount.
Throws:
java.lang.IllegalArgumentException - if amount is less than 0 when type is PERCENT,STANDARD_DEV or FIXED_VALUE.
java.lang.IllegalArgumentException - if type is not one of ErrorBarType constants.
CellsException - if ASeries object has bean removed.

setCustomAmount

public void setCustomAmount(java.lang.String plusValues,
                            java.lang.String minusValues)
Sets the error bar custom amount.

Parameters:
plusValues - The positive error amount .
minusValues - The negative error amount .
Throws:
CellsException - if ASeries object has bean removed.

hasEndStyleCap

public boolean hasEndStyleCap()
Indicates whether the error bars has the end style cap for the error bars.

Returns:
whether the error bars has the end style cap for the error bars.

setEndStyleCap

public void setEndStyleCap(boolean hasCap)
Sets whether the error bars has the end style cap for the error bars.

Parameters:
hasCap - whether the error bars has the end style cap for the error bars.
Throws:
CellsException - if ASeries object has bean removed.