Chart (binjr 1.6.0 API)

java.lang.Object
- eu.fthevenet.binjr.data.workspace.Chart<T>

All Implemented Interfaces:

Dirtyable, java.lang.AutoCloseable
```
public class Chart<T>
extends java.lang.Object
implements Dirtyable, java.lang.AutoCloseable
```
A class that represents and holds the current state of a single chart view

Author:

Frederic Thevenet

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`javafx.beans.property.BooleanProperty`	`autoScaleYAxis`
`javafx.beans.property.Property<ChartType>`	`chartType` The type of chart hosted by the `Worksheet`
`javafx.beans.property.BooleanProperty`	`dirty` A `BooleanProperty` that observes the changes made to the `Dirtyable` instance
`javafx.beans.property.DoubleProperty`	`graphOpacity` The graphOpacity property
`javafx.beans.property.Property<java.lang.String>`	`name` The name of the `Worksheet`
`javafx.beans.property.BooleanProperty`	`showAreaOutline` The showAreaOutline property
`javafx.beans.property.BooleanProperty`	`showProperties`
`javafx.beans.property.DoubleProperty`	`strokeWidth` The strokeWidth property.
`javafx.beans.property.Property<UnitPrefixes>`	`unitPrefixes` The unit prefix for the `Worksheet`'s times series Y axis
`javafx.beans.property.Property<java.lang.String>`	`unit` The unit for the `Worksheet`'s times series Y axis
`javafx.beans.property.DoubleProperty`	`yAxisMaxValue`
`javafx.beans.property.DoubleProperty`	`yAxisMinValue`

Constructor Summary

Constructors
Constructor and Description
`Chart()` Initializes a new instance of the `Worksheet` class
`Chart(Chart<T> initChart)` Copy constructor to deep clone a `Chart` instance.
`Chart(java.lang.String name, ChartType chartType, java.lang.String unitName, UnitPrefixes prefix)` Initializes a new instance of the `Worksheet` class with the provided name, chart type and zoneid

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addSeries(java.util.Collection<TimeSeriesInfo<T>> seriesInfo)` Adds a collection of `TimeSeriesInfo` to the worksheet
`void`	`addSeries(TimeSeriesInfo<T> seriesInfo)` Adds a `TimeSeriesInfo` to the worksheet
`javafx.beans.property.BooleanProperty`	`autoScaleYAxisProperty()`
`javafx.beans.property.Property<ChartType>`	`chartTypeProperty()` The type of chart hosted by the `Worksheet`
`void`	`cleanUp()` Clear the dirty status of the `Dirtyable` instance
`void`	`clearSeries()` Clear the `Worksheet` list
`void`	`close()`
`javafx.beans.property.BooleanProperty`	`dirtyProperty()` A `BooleanProperty` that observes the changes made to the `Dirtyable` instance
`void`	`fetchDataFromSources(java.time.ZonedDateTime startTime, java.time.ZonedDateTime endTime, boolean bypassCache)` Fills up the backend for all `TimeSeriesInfo` in the worksheet with data from the adapter on the specified time interval
`ChartType`	`getChartType()` The type of chart hosted by the `Worksheet`
`double`	`getGraphOpacity()` Gets the opacity factor to apply the the graph
`java.lang.String`	`getName()` The name of the `Worksheet`
`javafx.collections.ObservableList<TimeSeriesInfo<T>>`	`getSeries()` The time series of the `Worksheet`
`double`	`getStrokeWidth()` Return the stroke width for line charts
`java.lang.String`	`getUnit()` The unit for the `Worksheet`'s times series Y axis
`UnitPrefixes`	`getUnitPrefixes()` The unit prefix for the `Worksheet`'s times series Y axis
`double`	`getyAxisMaxValue()`
`double`	`getyAxisMinValue()`
`javafx.beans.property.DoubleProperty`	`graphOpacityProperty()` The graphOpacity property
`boolean`	`isAutoScaleYAxis()` Gets the value of the property autoScaleYAxis.
`java.lang.Boolean`	`isDirty()` Gets the value of the property dirty.
`boolean`	`isShowAreaOutline()` Returns true if area charts should display an outline stroke, false otherwise
`boolean`	`isShowProperties()` Gets the value of the property showProperties.
`javafx.beans.property.Property<java.lang.String>`	`nameProperty()` The name of the `Worksheet`
`void`	`removeSeries(java.util.Collection<TimeSeriesInfo> seriesInfo)` Remove all the elements in the provided collection from the list of `Worksheet` instances
`void`	`setAutoScaleYAxis(boolean autoScaleYAxis)` Sets the value of the property autoScaleYAxis.
`void`	`setChartType(ChartType chartType)` The type of chart hosted by the `Worksheet`
`void`	`setGraphOpacity(double graphOpacity)` Sets the opacity factor to apply the the graph
`void`	`setName(java.lang.String name)` The name of the `Worksheet`
`void`	`setShowAreaOutline(boolean showAreaOutline)` Set to true if area charts should display an outline stroke, false otherwise
`void`	`setShowProperties(boolean showProperties)` Sets the value of the property showProperties.
`void`	`setStrokeWidth(double value)` Sets the stroke width for line charts.
`void`	`setUnit(java.lang.String unit)` The unit for the `Worksheet`'s times series Y axis
`void`	`setUnitPrefixes(UnitPrefixes unitPrefixes)` The unit prefix for the `Worksheet`'s times series Y axis
`void`	`setyAxisMaxValue(double yAxisMaxValue)`
`void`	`setyAxisMinValue(double yAxisMinValue)`
`javafx.beans.property.BooleanProperty`	`showAreaOutlineProperty()` The showAreaOutline property
`javafx.beans.property.BooleanProperty`	`showPropertiesProperty()`
`javafx.beans.property.DoubleProperty`	`strokeWidthProperty()` The strokeWidth property.
`java.lang.String`	`toString()`
`javafx.beans.property.Property<UnitPrefixes>`	`unitPrefixesProperty()` The unit prefix for the `Worksheet`'s times series Y axis
`javafx.beans.property.Property<java.lang.String>`	`unitProperty()` The unit for the `Worksheet`'s times series Y axis
`javafx.beans.property.DoubleProperty`	`yAxisMaxValueProperty()`
`javafx.beans.property.DoubleProperty`	`yAxisMinValueProperty()`

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

- Property Detail
  - name
```
public javafx.beans.property.Property<java.lang.String> nameProperty
```
    The name of the Worksheet
    
    See Also:
    
    getName(), setName(String)
  - chartType
```
public javafx.beans.property.Property<ChartType> chartTypeProperty
```
    The type of chart hosted by the Worksheet
    
    See Also:
    
    getChartType(), setChartType(ChartType)
  - unit
```
public javafx.beans.property.Property<java.lang.String> unitProperty
```
    The unit for the Worksheet's times series Y axis
    
    See Also:
    
    getUnit(), setUnit(String)
  - unitPrefixes
```
public javafx.beans.property.Property<UnitPrefixes> unitPrefixesProperty
```
    The unit prefix for the Worksheet's times series Y axis
    
    See Also:
    
    getUnitPrefixes(), setUnitPrefixes(UnitPrefixes)
  - graphOpacity
```
public javafx.beans.property.DoubleProperty graphOpacityProperty
```
    The graphOpacity property
    
    See Also:
    
    getGraphOpacity(), setGraphOpacity(double)
  - showAreaOutline
```
public javafx.beans.property.BooleanProperty showAreaOutlineProperty
```
    The showAreaOutline property
    
    See Also:
    
    isShowAreaOutline(), setShowAreaOutline(boolean)
  - strokeWidth
```
public javafx.beans.property.DoubleProperty strokeWidthProperty
```
    The strokeWidth property.
    
    See Also:
    
    getStrokeWidth(), setStrokeWidth(double)
  - dirty
```
public javafx.beans.property.BooleanProperty dirtyProperty
```
    Specified by:
    
    dirtyProperty in interface Dirtyable
    
    See Also:
    
    isDirty()
  - autoScaleYAxis
```
public javafx.beans.property.BooleanProperty autoScaleYAxisProperty
```
    See Also:
    
    isAutoScaleYAxis(), setAutoScaleYAxis(boolean)
  - yAxisMinValue
```
public javafx.beans.property.DoubleProperty yAxisMinValueProperty
```
  - yAxisMaxValue
```
public javafx.beans.property.DoubleProperty yAxisMaxValueProperty
```
  - showProperties
```
public javafx.beans.property.BooleanProperty showPropertiesProperty
```
    See Also:
    
    isShowProperties(), setShowProperties(boolean)
- Constructor Detail
  - Chart
```
public Chart()
```
    Initializes a new instance of the Worksheet class
  - Chart
```
public Chart(java.lang.String name,
             ChartType chartType,
             java.lang.String unitName,
             UnitPrefixes prefix)
```
    Initializes a new instance of the Worksheet class with the provided name, chart type and zoneid
    
    Parameters:
    
    name - the name for the new Worksheet instance
    
    chartType - the ChartType for the new Worksheet instance
  - Chart
```
public Chart(Chart<T> initChart)
```
    Copy constructor to deep clone a Chart instance.
    
    Parameters:
    
    initChart - the Chart instance to clone.
- Method Detail
  - fetchDataFromSources
```
public void fetchDataFromSources(java.time.ZonedDateTime startTime,
                                 java.time.ZonedDateTime endTime,
                                 boolean bypassCache)
                          throws DataAdapterException
```
    Fills up the backend for all TimeSeriesInfo in the worksheet with data from the adapter on the specified time interval
    
    Parameters:
    
    startTime - the start of the time interval
    
    endTime - the end of the time interval
    
    Throws:
    
    DataAdapterException - if an error occurs while retrieving data from the adapter
  - addSeries
```
public void addSeries(TimeSeriesInfo<T> seriesInfo)
```
    Adds a TimeSeriesInfo to the worksheet
    
    Parameters:
    
    seriesInfo - the TimeSeriesInfo to add
  - addSeries
```
public void addSeries(java.util.Collection<TimeSeriesInfo<T>> seriesInfo)
```
    Adds a collection of TimeSeriesInfo to the worksheet
    
    Parameters:
    
    seriesInfo - the collection TimeSeriesInfo to add
  - removeSeries
```
public void removeSeries(java.util.Collection<TimeSeriesInfo> seriesInfo)
```
    Remove all the elements in the provided collection from the list of Worksheet instances
    
    Parameters:
    
    seriesInfo - the list of Worksheet instances to remove
  - clearSeries
```
public void clearSeries()
```
    Clear the Worksheet list
  - getName
```
public java.lang.String getName()
```
    The name of the Worksheet
    
    Returns:
    
    the name of the Worksheet
  - nameProperty
```
public javafx.beans.property.Property<java.lang.String> nameProperty()
```
    The name of the Worksheet
    
    See Also:
    
    getName(), setName(String)
  - setName
```
public void setName(java.lang.String name)
```
    The name of the Worksheet
    
    Parameters:
    
    name - the name of the Worksheet
  - getSeries
```
public javafx.collections.ObservableList<TimeSeriesInfo<T>> getSeries()
```
    The time series of the Worksheet
    
    Returns:
    
    the time series of the Worksheet
  - getChartType
```
public ChartType getChartType()
```
    The type of chart hosted by the Worksheet
    
    Returns:
    
    the type of chart hosted by the Worksheet
  - chartTypeProperty
```
public javafx.beans.property.Property<ChartType> chartTypeProperty()
```
    The type of chart hosted by the Worksheet
    
    See Also:
    
    getChartType(), setChartType(ChartType)
  - setChartType
```
public void setChartType(ChartType chartType)
```
    The type of chart hosted by the Worksheet
    
    Parameters:
    
    chartType - the type of chart hosted by the Worksheet
  - getUnit
```
public java.lang.String getUnit()
```
    The unit for the Worksheet's times series Y axis
    
    Returns:
    
    the unit for the Worksheet's times series Y axis
  - unitProperty
```
public javafx.beans.property.Property<java.lang.String> unitProperty()
```
    The unit for the Worksheet's times series Y axis
    
    See Also:
    
    getUnit(), setUnit(String)
  - setUnit
```
public void setUnit(java.lang.String unit)
```
    The unit for the Worksheet's times series Y axis
    
    Parameters:
    
    unit - the unit for the Worksheet's times series Y axis
  - getUnitPrefixes
```
public UnitPrefixes getUnitPrefixes()
```
    The unit prefix for the Worksheet's times series Y axis
    
    Returns:
    
    the unit prefix for the Worksheet's times series Y axis
  - unitPrefixesProperty
```
public javafx.beans.property.Property<UnitPrefixes> unitPrefixesProperty()
```
    The unit prefix for the Worksheet's times series Y axis
    
    See Also:
    
    getUnitPrefixes(), setUnitPrefixes(UnitPrefixes)
  - setUnitPrefixes
```
public void setUnitPrefixes(UnitPrefixes unitPrefixes)
```
    The unit prefix for the Worksheet's times series Y axis
    
    Parameters:
    
    unitPrefixes - the unit prefix for the Worksheet's times series Y axis
  - getGraphOpacity
```
public double getGraphOpacity()
```
    Gets the opacity factor to apply the the graph
    
    Returns:
    
    the opacity factor to apply the the graph
  - graphOpacityProperty
```
public javafx.beans.property.DoubleProperty graphOpacityProperty()
```
    The graphOpacity property
    
    See Also:
    
    getGraphOpacity(), setGraphOpacity(double)
  - setGraphOpacity
```
public void setGraphOpacity(double graphOpacity)
```
    Sets the opacity factor to apply the the graph
    
    Parameters:
    
    graphOpacity - the opacity factor to apply the the graph
  - isShowAreaOutline
```
public boolean isShowAreaOutline()
```
    Returns true if area charts should display an outline stroke, false otherwise
    
    Returns:
    
    true if area charts should display an outline stroke, false otherwise
  - showAreaOutlineProperty
```
public javafx.beans.property.BooleanProperty showAreaOutlineProperty()
```
    The showAreaOutline property
    
    See Also:
    
    isShowAreaOutline(), setShowAreaOutline(boolean)
  - setShowAreaOutline
```
public void setShowAreaOutline(boolean showAreaOutline)
```
    Set to true if area charts should display an outline stroke, false otherwise
    
    Parameters:
    
    showAreaOutline - true if area charts should display an outline stroke, false otherwise
  - strokeWidthProperty
```
public javafx.beans.property.DoubleProperty strokeWidthProperty()
```
    The strokeWidth property.
    
    See Also:
    
    getStrokeWidth(), setStrokeWidth(double)
  - getStrokeWidth
```
public double getStrokeWidth()
```
    Return the stroke width for line charts
    
    Returns:
    
    the stroke width for line charts
  - setStrokeWidth
```
public void setStrokeWidth(double value)
```
    Sets the stroke width for line charts.
    
    Parameters:
    
    value - the stroke width for line charts.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - isDirty
```
public java.lang.Boolean isDirty()
```
    Gets the value of the property dirty.
    
    Specified by:
    
    isDirty in interface Dirtyable
    
    Returns:
    
    true if the Dirtyable instance needs to be persisted, false otherwise
  - dirtyProperty
```
public javafx.beans.property.BooleanProperty dirtyProperty()
```
    Description copied from interface: Dirtyable
    
    A BooleanProperty that observes the changes made to the Dirtyable instance
    
    Specified by:
    
    dirtyProperty in interface Dirtyable
    
    See Also:
    
    isDirty()
  - cleanUp
```
public void cleanUp()
```
    Description copied from interface: Dirtyable
    
    Clear the dirty status of the Dirtyable instance
    
    Specified by:
    
    cleanUp in interface Dirtyable
  - close
```
public void close()
```
    Specified by:
    
    close in interface java.lang.AutoCloseable
  - isAutoScaleYAxis
```
public boolean isAutoScaleYAxis()
```
    Gets the value of the property autoScaleYAxis.
  - autoScaleYAxisProperty
```
public javafx.beans.property.BooleanProperty autoScaleYAxisProperty()
```
    See Also:
    
    isAutoScaleYAxis(), setAutoScaleYAxis(boolean)
  - setAutoScaleYAxis
```
public void setAutoScaleYAxis(boolean autoScaleYAxis)
```
    Sets the value of the property autoScaleYAxis.
  - getyAxisMinValue
```
public double getyAxisMinValue()
```
  - yAxisMinValueProperty
```
public javafx.beans.property.DoubleProperty yAxisMinValueProperty()
```
  - setyAxisMinValue
```
public void setyAxisMinValue(double yAxisMinValue)
```
  - getyAxisMaxValue
```
public double getyAxisMaxValue()
```
  - yAxisMaxValueProperty
```
public javafx.beans.property.DoubleProperty yAxisMaxValueProperty()
```
  - setyAxisMaxValue
```
public void setyAxisMaxValue(double yAxisMaxValue)
```
  - isShowProperties
```
public boolean isShowProperties()
```
    Gets the value of the property showProperties.
  - showPropertiesProperty
```
public javafx.beans.property.BooleanProperty showPropertiesProperty()
```
    See Also:
    
    isShowProperties(), setShowProperties(boolean)
  - setShowProperties
```
public void setShowProperties(boolean showProperties)
```
    Sets the value of the property showProperties.

Class Chart<T>

Property Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Property Detail

name

chartType

unit

unitPrefixes

graphOpacity

showAreaOutline

strokeWidth

dirty

autoScaleYAxis

yAxisMinValue

yAxisMaxValue

showProperties

Constructor Detail

Chart

Chart

Chart

Method Detail

fetchDataFromSources

addSeries

addSeries

removeSeries

clearSeries

getName

nameProperty

setName

getSeries

getChartType

chartTypeProperty

setChartType

getUnit

unitProperty

setUnit

getUnitPrefixes

unitPrefixesProperty

setUnitPrefixes

getGraphOpacity

graphOpacityProperty

setGraphOpacity

isShowAreaOutline

showAreaOutlineProperty

setShowAreaOutline

strokeWidthProperty

getStrokeWidth

setStrokeWidth

toString

isDirty

dirtyProperty

cleanUp

close

isAutoScaleYAxis

autoScaleYAxisProperty

setAutoScaleYAxis

getyAxisMinValue

yAxisMinValueProperty

setyAxisMinValue

getyAxisMaxValue

yAxisMaxValueProperty

setyAxisMaxValue

isShowProperties

showPropertiesProperty

setShowProperties