Class BarOptions
- java.lang.Object
-
- org.pepstock.charba.client.configuration.ConfigurationOptions
-
- org.pepstock.charba.client.configuration.ScalesOptions
-
- org.pepstock.charba.client.configuration.BarOptions
-
- All Implemented Interfaces:
HasAnimation
,ConfigurationElement
,AddHandlerEventHandler
,EventHandler
,RemoveHandlerEventHandler
- Direct Known Subclasses:
HorizontalBarOptions
,StackedBarOptions
public class BarOptions extends ScalesOptions
Specific options for BAR chart. It contains all properties for this kind of chart.- Author:
- Andrea "Stock" Stocchero
-
-
Constructor Summary
Constructors Constructor Description BarOptions(IsChart chart, IsDefaultScaledOptions defaultValues)
Builds the object storing the chart instance and default values.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IsChart
getChart()
Returns the chart instanceprotected T
getConfiguration()
Returns the configuration element.IndexAxis
getIndexAxis()
Returns the base axis for the dataset.boolean
isSkipNull()
Iftrue
, null or undefined values will not be drawn.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)
Sets the base axis for the dataset.
UseIndexAxis.Y
for horizontal bar.void
setSkipNull(boolean skipNull)
Iftrue
, null or undefined values will not be drawn.String
toJSON()
Returns the JSON representation of the object.-
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
-
BarOptions
public BarOptions(IsChart chart, IsDefaultScaledOptions defaultValues)
Builds the object storing the chart instance and default values.- Parameters:
chart
- chart instancedefaultValues
- defaults options of bar chart
-
-
Method Detail
-
setIndexAxis
public void setIndexAxis(IndexAxis indexAxis)
Sets the base axis for the dataset.
UseIndexAxis.Y
for horizontal bar.- Parameters:
indexAxis
- the base axis for the dataset
-
getIndexAxis
public IndexAxis getIndexAxis()
Returns the base axis for the dataset.- Returns:
- the base axis for the dataset
-
setSkipNull
public void setSkipNull(boolean skipNull)
Iftrue
, null or undefined values will not be drawn.- Parameters:
skipNull
- iftrue
, null or undefined values will not be drawn
-
isSkipNull
public boolean isSkipNull()
Iftrue
, null or undefined values will not be drawn.- Returns:
- If
true
, null or undefined values will not be drawn
-
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
-
-