Package io.keikai.model

Interface SErrorBar

All Known Implementing Classes:

ErrorBarImpl

public interface SErrorBar

Represents error bars on a chart series.

Reference: ECMA-376 5th Edition, sect. 21.2.2.55 (errBars).

Since:

7.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	SErrorBar.BarType	Which side(s) the error bar extends.
static enum	SErrorBar.Direction	The axis direction of the error bar.
static enum	SErrorBar.ValueType	How the error value is calculated.

Method Summary

Modifier and Type	Method	Description
SErrorBar.BarType	getBarType()	Returns the bar type (PLUS, MINUS, or BOTH).
String	getCustomMinusRef()	Returns the formula reference for custom minus error values, or null if not using custom values.
String	getCustomPlusRef()	Returns the formula reference for custom plus error values, or null if not using custom values.
SErrorBar.Direction	getDirection()	Returns the direction (X or Y) of this error bar.
double	getFixedValue()	Returns the fixed value used when getValueType() is FIXED or PERCENTAGE.
SErrorBar.ValueType	getValueType()	Returns how the error value is calculated.
void	setFixedValue(double value)	Sets the fixed value used when the value type is FIXED or PERCENTAGE.

Method Details

getDirection

SErrorBar.Direction getDirection()

Returns the direction (X or Y) of this error bar.

getBarType

SErrorBar.BarType getBarType()

Returns the bar type (PLUS, MINUS, or BOTH).

getValueType

SErrorBar.ValueType getValueType()

Returns how the error value is calculated.

getFixedValue

double getFixedValue()

Returns the fixed value used when getValueType() is FIXED or PERCENTAGE.

setFixedValue

void setFixedValue(double value)

Sets the fixed value used when the value type is FIXED or PERCENTAGE.

getCustomPlusRef

String getCustomPlusRef()

Returns the formula reference for custom plus error values, or null if not using custom values.

getCustomMinusRef

String getCustomMinusRef()

Returns the formula reference for custom minus error values, or null if not using custom values.