ChartExtent (Charting 0.0.5 API)

java.lang.Object
- org.bimserver.charting.Containers.ChartExtent

```
public class ChartExtent
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`double`	`DefaultTickCount`
`Double`	`Lower`
`boolean`	`LowerBoundIsZero`
`boolean`	`ShouldFormatAsDate`
`Double`	`Upper`
`double`	`WorldSpaceEnd`
`double`	`WorldSpaceStart`

Constructor Summary

Constructors
Constructor and Description
`ChartExtent()`
`ChartExtent(boolean lowerBoundIsZero, ArrayList<Number> args)` Number sequence-based constructor meant to yield a lower and an upper value.
`ChartExtent(boolean lowerBoundIsZero, boolean shouldFormatAsDate, ArrayList<Number> args)` Number sequence-based constructor meant to yield a lower and an upper value.
`ChartExtent(boolean lowerBoundIsZero, Double[] args)` Double sequence-based constructor meant to yield a lower and an upper value.
`ChartExtent(boolean lowerBoundIsZero, Integer[] args)` Integer sequence-based constructor meant to yield a lower and an upper value.
`ChartExtent(Double lower, Double upper, boolean lowerBoundIsZero)` Container for lower and upper double values.
`ChartExtent(Double lower, Double upper, double worldSpaceStart, double worldSpaceEnd)`
`ChartExtent(Integer lower, Integer upper, boolean lowerBoundIsZero)` Integer to Double conversion.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`getDefaultTickCount()`
`double`	`getDelta()`
`Double[]`	`getLinearSchedule()` Get the default linear scale, using the default tick count to subdivide this range and the world space range.
`Double[]`	`getLinearSchedule(boolean reverseTransformedDataOrder)` Get the default linear scale, using the default tick count to subdivide this range and the world space range.
`Double[]`	`getLinearScheduleGivenWorldSpaceValues(ArrayList<Double> worldSpaceValues, boolean reverseTransformedDataOrder)` Use a series of world space values (like locations, specified in pixels), to calculate percentages to be used to obtain corresponding real values (in range of lower to upper).
`double`	`getLinearValueAtXGivenWorldSpaceValue(double worldSpaceValue)` Use a world space value (like a location, specified in pixels), to calculate a percentage to be used to obtain a corresponding real value (in range of lower to upper).
`double`	`getLinearValueAtXGivenWorldSpaceValue(double worldSpaceValue, boolean reverseTransformedDataOrder)` Use a world space value (like a location, specified in pixels), to calculate a percentage to be used to obtain a corresponding real value (in range of lower to upper).
`Double[]`	`getLinearWorldSpaceScheduleGivenActualValues(ArrayList<Double> actualValues, boolean reverseTransformedDataOrder)` Use a series of actual values (like raw data positions), to calculate percentages to be used to obtain corresponding world-space values.
`double`	`getLinearWorldSpaceValueAtXGivenActualValue(double actualValue)` Use an actual value (like a raw data position), to calculate a percentage to be used to obtain a corresponding world-space value.
`double`	`getLinearWorldSpaceValueAtXGivenActualValue(double actualValue, boolean reverseTransformedDataOrder)` Use an actual value (like a raw data position), to calculate a percentage to be used to obtain a corresponding world-space value.
`double`	`getLower()`
`Double`	`getUpper()`
`double`	`getWorldSpaceDelta()`
`ArrayList<Pair<Double,Double>>`	`getWorldSpaceToActualValuePairsLinearSchedule()`
`ArrayList<Pair<Double,Double>>`	`getWorldSpaceToActualValuePairsLinearSchedule(boolean reverseTransformedDataOrder)` Get sets of data in the form Pair(world space value, actual value), representing the translation between the world space and actual values.
`ArrayList<Double>`	`getWorldSpaceValuesFromDefaultTickValue()`
`void`	`includeValue(Double value)`
`boolean`	`isValid()`
`void`	`setDefaultTickCount(double defaultTickCount)`
`void`	`setLower(Double lower)`
`void`	`setUpper(Double upper)`
`void`	`setWorldSpace(double start, double end)` Set the context these values exist in.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - Lower
```
public Double Lower
```
  - Upper
```
public Double Upper
```
  - LowerBoundIsZero
```
public boolean LowerBoundIsZero
```
  - WorldSpaceStart
```
public double WorldSpaceStart
```
  - WorldSpaceEnd
```
public double WorldSpaceEnd
```
  - DefaultTickCount
```
public double DefaultTickCount
```
  - ShouldFormatAsDate
```
public boolean ShouldFormatAsDate
```
- Constructor Detail
  - ChartExtent
```
public ChartExtent()
```
  - ChartExtent
```
public ChartExtent(Double lower,
                   Double upper,
                   boolean lowerBoundIsZero)
```
    Container for lower and upper double values.
    
    Parameters:
    
    lower -
    
    upper -
    
    lowerBoundIsZero -
  - ChartExtent
```
public ChartExtent(Integer lower,
                   Integer upper,
                   boolean lowerBoundIsZero)
```
    Integer to Double conversion.
    
    Parameters:
    
    lower -
    
    upper -
    
    lowerBoundIsZero -
  - ChartExtent
```
public ChartExtent(boolean lowerBoundIsZero,
                   Double[] args)
```
    Double sequence-based constructor meant to yield a lower and an upper value.
    
    Parameters:
    
    args -
  - ChartExtent
```
public ChartExtent(boolean lowerBoundIsZero,
                   Integer[] args)
```
    Integer sequence-based constructor meant to yield a lower and an upper value.
    
    Parameters:
    
    args -
  - ChartExtent
```
public ChartExtent(boolean lowerBoundIsZero,
                   ArrayList<Number> args)
```
    Number sequence-based constructor meant to yield a lower and an upper value. WARN: Do not use with BigInteger, because equivalence is not exact.
    
    Parameters:
    
    args -
  - ChartExtent
```
public ChartExtent(boolean lowerBoundIsZero,
                   boolean shouldFormatAsDate,
                   ArrayList<Number> args)
```
    Number sequence-based constructor meant to yield a lower and an upper value. WARN: Do not use with BigInteger, because equivalence is not exact.
    
    Parameters:
    
    args -
  - ChartExtent
```
public ChartExtent(Double lower,
                   Double upper,
                   double worldSpaceStart,
                   double worldSpaceEnd)
```
    Parameters:
    
    lower -
    
    upper -
    
    worldSpaceStart -
    
    worldSpaceEnd -
- Method Detail
  - getDefaultTickCount
```
public double getDefaultTickCount()
```
    Returns:
    
    the defaultTickCount
  - setDefaultTickCount
```
public void setDefaultTickCount(double defaultTickCount)
```
    Parameters:
    
    defaultTickCount - the defaultTickCount to set
  - getLower
```
public double getLower()
```
    Returns:
    
    the lower
  - setLower
```
public void setLower(Double lower)
```
    Parameters:
    
    lower - the lower to set
  - getUpper
```
public Double getUpper()
```
    Returns:
    
    the upper
  - setUpper
```
public void setUpper(Double upper)
```
    Parameters:
    
    upper - the upper to set
  - isValid
```
public boolean isValid()
```
  - includeValue
```
public void includeValue(Double value)
```
  - setWorldSpace
```
public void setWorldSpace(double start,
                          double end)
```
    Set the context these values exist in. Default is 0..1. Expected replacements are something like 23..980.
    
    Parameters:
    
    start -
    
    end -
  - getWorldSpaceValuesFromDefaultTickValue
```
public ArrayList<Double> getWorldSpaceValuesFromDefaultTickValue()
```
    Returns:
  - getLinearValueAtXGivenWorldSpaceValue
```
public double getLinearValueAtXGivenWorldSpaceValue(double worldSpaceValue,
                                                    boolean reverseTransformedDataOrder)
```
    Use a world space value (like a location, specified in pixels), to calculate a percentage to be used to obtain a corresponding real value (in range of lower to upper).
    
    Parameters:
    
    worldSpaceValue -
    
    Returns:
  - getLinearValueAtXGivenWorldSpaceValue
```
public double getLinearValueAtXGivenWorldSpaceValue(double worldSpaceValue)
```
    Use a world space value (like a location, specified in pixels), to calculate a percentage to be used to obtain a corresponding real value (in range of lower to upper). Convenience method.
    
    Parameters:
    
    worldSpaceValue -
    
    Returns:
  - getLinearSchedule
```
public Double[] getLinearSchedule(boolean reverseTransformedDataOrder)
```
    Get the default linear scale, using the default tick count to subdivide this range and the world space range.
    
    Parameters:
    
    reverseTransformedDataOrder -
    
    Returns:
  - getLinearSchedule
```
public Double[] getLinearSchedule()
```
    Get the default linear scale, using the default tick count to subdivide this range and the world space range. Convenience method.
    
    Returns:
  - getWorldSpaceToActualValuePairsLinearSchedule
```
public ArrayList<Pair<Double,Double>> getWorldSpaceToActualValuePairsLinearSchedule()
```
  - getWorldSpaceToActualValuePairsLinearSchedule
```
public ArrayList<Pair<Double,Double>> getWorldSpaceToActualValuePairsLinearSchedule(boolean reverseTransformedDataOrder)
```
    Get sets of data in the form Pair(world space value, actual value), representing the translation between the world space and actual values.
    
    Parameters:
    
    reverseTransformedDataOrder -
    
    Returns:
  - getLinearScheduleGivenWorldSpaceValues
```
public Double[] getLinearScheduleGivenWorldSpaceValues(ArrayList<Double> worldSpaceValues,
                                                       boolean reverseTransformedDataOrder)
```
    Use a series of world space values (like locations, specified in pixels), to calculate percentages to be used to obtain corresponding real values (in range of lower to upper).
    
    Parameters:
    
    worldSpaceValues -
    
    reverseTransformedDataOrder -
    
    Returns:
  - getDelta
```
public double getDelta()
```
    Returns:
  - getWorldSpaceDelta
```
public double getWorldSpaceDelta()
```
    Returns:
  - getLinearWorldSpaceValueAtXGivenActualValue
```
public double getLinearWorldSpaceValueAtXGivenActualValue(double actualValue)
```
    Use an actual value (like a raw data position), to calculate a percentage to be used to obtain a corresponding world-space value.
    
    Parameters:
    
    actualValue -
    
    Returns:
  - getLinearWorldSpaceValueAtXGivenActualValue
```
public double getLinearWorldSpaceValueAtXGivenActualValue(double actualValue,
                                                          boolean reverseTransformedDataOrder)
```
    Use an actual value (like a raw data position), to calculate a percentage to be used to obtain a corresponding world-space value.
    
    Parameters:
    
    actualValue -
    
    Returns:
  - getLinearWorldSpaceScheduleGivenActualValues
```
public Double[] getLinearWorldSpaceScheduleGivenActualValues(ArrayList<Double> actualValues,
                                                             boolean reverseTransformedDataOrder)
```
    Use a series of actual values (like raw data positions), to calculate percentages to be used to obtain corresponding world-space values.
    
    Parameters:
    
    actualValues -
    
    reverseTransformedDataOrder -
    
    Returns:

Class ChartExtent

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

Lower

Upper

LowerBoundIsZero

WorldSpaceStart

WorldSpaceEnd

DefaultTickCount

ShouldFormatAsDate

Constructor Detail

ChartExtent

ChartExtent

ChartExtent

ChartExtent

ChartExtent

ChartExtent

ChartExtent

ChartExtent

Method Detail

getDefaultTickCount

setDefaultTickCount

getLower

setLower

getUpper

setUpper

isValid

includeValue

setWorldSpace

getWorldSpaceValuesFromDefaultTickValue

getLinearValueAtXGivenWorldSpaceValue

getLinearValueAtXGivenWorldSpaceValue

getLinearSchedule

getLinearSchedule

getWorldSpaceToActualValuePairsLinearSchedule

getWorldSpaceToActualValuePairsLinearSchedule

getLinearScheduleGivenWorldSpaceValues

getDelta

getWorldSpaceDelta

getLinearWorldSpaceValueAtXGivenActualValue

getLinearWorldSpaceValueAtXGivenActualValue

getLinearWorldSpaceScheduleGivenActualValues