Class StackedLineOptions
- java.lang.Object
-
- org.pepstock.charba.client.configuration.ConfigurationOptions
-
- org.pepstock.charba.client.configuration.ScalesOptions
-
- org.pepstock.charba.client.configuration.LineOptions
-
- org.pepstock.charba.client.configuration.StackedLineOptions
-
- All Implemented Interfaces:
HasAnimation
,ConfigurationElement
,AddHandlerEventHandler
,EventHandler
,RemoveHandlerEventHandler
public class StackedLineOptions extends LineOptions
Configuration of chart which could be stacked.
It uses Category axis for X axis and Linear for Y axis.- Author:
- Andrea "Stock" Stocchero
-
-
Constructor Summary
Constructors Constructor Description StackedLineOptions(IsChart chart, IsDefaultScaledOptions defaultValues)
Builds the object storing the chart instance and default values.StackedLineOptions(IsChart chart, IsDefaultScaledOptions defaultValues, IndexAxis indexAxis)
Builds the object storing the chart instance and default values.
-
Method Summary
All Methods Instance Methods Concrete Methods Default Methods Modifier and Type Method Description IsChart
getChart()
Returns the chart instanceprotected T
getConfiguration()
Returns the configuration element.default boolean
isShowLine()
Iffalse
, the lines between points are not drawn.default boolean
isSpanGaps()
If false,Double.NaN
data causes a break in the line.ChartEnvelop<NativeObject>
loadNativeObject(ChartEnvelop<NativeObject> envelop)
Returns the native object instance inside an envelop.
It can be called only fromorg.pepstock.charba.client
package.void
merge(NativeObjectContainer source, String property)
Merge a native object in the this one with a specific property name.
This is used by plugins implementation (native java script ones) when they are not using the standard way to add plugin configuration in the options of chart.protected void
setConfiguration(T configuration)
void
setIndexAxis(IndexAxis indexAxis)
If invoked, this is ignored because theIndexAxis
is already set, based on the chart class.default void
setShowLine(boolean showLine)
Iffalse
, the lines between points are not drawn.default void
setSpanGaps(boolean spanGaps)
If false,Double.NaN
data causes a break in the line.String
toJSON()
Returns the JSON representation of the object.-
Methods inherited from class org.pepstock.charba.client.configuration.LineOptions
getDecimation, getIndexAxis, getOptions, getSegment
-
Methods inherited from class org.pepstock.charba.client.configuration.ScalesOptions
getAxisById, getScales
-
Methods inherited from class org.pepstock.charba.client.configuration.ConfigurationOptions
afterAxisConfigurationUpdate, afterConfigurationUpdate, beforeAxisConfigurationUpdate, beforeConfigurationUpdate, getAnimationContainer, getAspectRatio, getBackgroundColor, getBackgroundColorAsString, getBorderColor, getBorderColorAsString, getColor, getColorAsString, getDatasets, getDevicePixelRatio, getElements, getEvents, getFiller, getFont, getHover, getInteraction, getLayout, getLegend, getLocale, getPlugins, getResizeDelay, getSubtitle, getTitle, getTooltips, hasAxisClickHandlers, hasAxisEnterHandlers, hasAxisHoverHandlers, hasAxisLeaveHandlers, hasDatasetSelectionHandlers, hasSubtitleClickHandlers, hasSubtitleEnterHandlers, hasSubtitleLeaveHandlers, hasTitleClickHandlers, hasTitleEnterHandlers, hasTitleLeaveHandlers, isDestroyOnDetach, isDrawOnAttach, isMaintainAspectRatio, isResponsive, load, loadOptions, onAdd, onRemove, setAspectRatio, setBackgroundColor, setBackgroundColor, setBorderColor, setBorderColor, setChartOptions, setColor, setColor, setDestroyOnDetach, setDevicePixelRatio, setDrawOnAttach, setEvents, setLocale, setMaintainAspectRatio, setResizeDelay, setResponsive
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.pepstock.charba.client.configuration.HasAnimation
getAnimation, getAnimations, getTransitions, isAnimationEnabled, setAnimationEnabled
-
-
-
-
Constructor Detail
-
StackedLineOptions
public StackedLineOptions(IsChart chart, IsDefaultScaledOptions defaultValues)
Builds the object storing the chart instance and default values.- Parameters:
chart
- chart instancedefaultValues
- defaults options of bar chart
-
StackedLineOptions
public StackedLineOptions(IsChart chart, IsDefaultScaledOptions defaultValues, IndexAxis indexAxis)
Builds the object storing the chart instance and default values.- Parameters:
chart
- chart instancedefaultValues
- defaults options of bar chartindexAxis
- defines the orientation of the bar chart
-
-
Method Detail
-
setIndexAxis
public final void setIndexAxis(IndexAxis indexAxis)
If invoked, this is ignored because theIndexAxis
is already set, based on the chart class.- Overrides:
setIndexAxis
in classLineOptions
- Parameters:
indexAxis
- this is ignored because theIndexAxis
is already set, based on the chart class
-
setShowLine
public default void setShowLine(boolean showLine)
Iffalse
, the lines between points are not drawn.- Parameters:
showLine
- iffalse
, the lines between points are not drawn.
-
isShowLine
public default boolean isShowLine()
Iffalse
, the lines between points are not drawn.- Returns:
- if
false
, the lines between points are not drawn.
-
setSpanGaps
public default void setSpanGaps(boolean spanGaps)
If false,Double.NaN
data causes a break in the line.- Parameters:
spanGaps
- If false,Double.NaN
data causes a break in the line.
-
isSpanGaps
public default boolean isSpanGaps()
If false,Double.NaN
data causes a break in the line.- Returns:
- If false,
Double.NaN
data causes a break in the line.
-
setConfiguration
protected final void setConfiguration(T configuration)
- Parameters:
configuration
- the configuration to set
-
getConfiguration
protected final T getConfiguration()
Returns the configuration element.- Returns:
- the configuration element.
-
merge
public final void merge(NativeObjectContainer source, String property)
Merge a native object in the this one with a specific property name.
This is used by plugins implementation (native java script ones) when they are not using the standard way to add plugin configuration in the options of chart.- Parameters:
source
- native object container to addproperty
- property name
-
toJSON
public final String toJSON()
Returns the JSON representation of the object.- Returns:
- the JSON representation of the object.
-
loadNativeObject
public final ChartEnvelop<NativeObject> loadNativeObject(ChartEnvelop<NativeObject> envelop)
Returns the native object instance inside an envelop.
It can be called only fromorg.pepstock.charba.client
package.- Parameters:
envelop
- envelop instance which will contain the native object- Returns:
- the envelop, passed as argument, loaded with the native object
-
getChart
public final IsChart getChart()
Returns the chart instance- Returns:
- the chart
-
-