public final class ChoroplethOptions extends ScalesOptions
Modifier and Type | Method and Description |
---|---|
protected void |
afterAxisConfigurationUpdate(Axis axis)
Invoked after the axis options has been updated.
|
protected void |
afterConfigurationUpdate()
Invoked after the chart options has been updated.
|
IsChart |
getChart()
Returns the chart instance
|
default ClipMap |
getClipMap()
Returns whether to clip the rendering to the chart area of the graph.
|
protected T |
getConfiguration()
Returns the configuration element.
|
ChoroplethElements |
getElements()
Returns the elements element.
|
org.pepstock.charba.client.geo.CommonOptionsHandler |
getHandler() |
default List<Feature> |
getOutline()
Returns the outline used to scale and centralize the projection in the chart area.
|
default Graticule |
getShowGraticule()
Returns the graticule to render the lines in the background.
|
default boolean |
isClipMap()
Returns whether to clip the rendering to the chart area of the graph.
|
default boolean |
isShowGraticule()
Returns
true to render a graticule in the background. |
default boolean |
isShowOutline()
Returns
true to render the outline in the background. |
ChartEnvelop<NativeObject> |
loadNativeObject(ChartEnvelop<NativeObject> envelop)
Returns the native object instance inside an envelop.
It can be called only from org.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. |
static void |
register(IsChart chart,
org.pepstock.charba.client.configuration.IsEventProvider provider)
Adds the event provider implementation as handlers of chart.
|
default void |
setClipMap(boolean clipMap)
Sets whether to clip the rendering to the chart area of the graph.
|
default void |
setClipMap(ClipMap clipMap)
Sets whether to clip the rendering to the chart area of the graph.
|
protected void |
setConfiguration(T configuration) |
default void |
setOutline(Feature... outline)
Sets the outline used to scale and centralize the projection in the chart area.
|
default void |
setOutline(List<Feature> outline)
Sets the outline used to scale and centralize the projection in the chart area.
|
default void |
setShowGraticule(boolean showGraticule)
Sets
true to render the lines in the background. |
default void |
setShowGraticule(Graticule showGraticule)
Sets the graticule object to render the lines in the background.
|
default void |
setShowOutline(boolean showOutline)
Sets
true to render the outline in the background. |
String |
toJSON()
Returns the JSON representation of the object.
|
getAxisById, getScales
beforeAxisConfigurationUpdate, beforeConfigurationUpdate, getAnimationContainer, getAspectRatio, getBackgroundColor, getBackgroundColorAsString, getBorderColor, getBorderColorAsString, getColor, getColorAsString, getDatasets, getDevicePixelRatio, 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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getAnimation, getAnimations, getTransitions, isAnimationEnabled, setAnimationEnabled
protected final void afterConfigurationUpdate()
ConfigurationOptions
afterConfigurationUpdate
in class ConfigurationOptions
protected void afterAxisConfigurationUpdate(Axis axis)
ConfigurationOptions
afterAxisConfigurationUpdate
in class ConfigurationOptions
axis
- axis instance which has been updatedpublic org.pepstock.charba.client.geo.CommonOptionsHandler getHandler()
public ChoroplethElements getElements()
ConfigurationOptions
getElements
in class ConfigurationOptions
public void setOutline(Feature... outline)
outline
- the outline used to scale and centralize the projection in the chart areapublic void setOutline(List<Feature> outline)
outline
- the outline used to scale and centralize the projection in the chart areapublic List<Feature> getOutline()
public void setShowOutline(boolean showOutline)
true
to render the outline in the background.showOutline
- true
to render the outline in the backgroundpublic boolean isShowOutline()
true
to render the outline in the background.true
to render the outline in the backgroundpublic void setShowGraticule(boolean showGraticule)
true
to render the lines in the background.showGraticule
- true
to render the lines in the backgroundpublic void setShowGraticule(Graticule showGraticule)
showGraticule
- the graticule to render the lines in the backgroundpublic boolean isShowGraticule()
true
to render a graticule in the background.true
to render a graticule in the backgroundpublic Graticule getShowGraticule()
null
is any object has been setpublic void setClipMap(ClipMap clipMap)
clipMap
- whether to clip the rendering to the chart area of the graphpublic ClipMap getClipMap()
public void setClipMap(boolean clipMap)
clipMap
- whether to clip the rendering to the chart area of the graphpublic boolean isClipMap()
public static void register(IsChart chart, org.pepstock.charba.client.configuration.IsEventProvider provider)
chart
- chart instanceprovider
- event provider implmentationprotected final void setConfiguration(T configuration)
configuration
- the configuration to setprotected final T getConfiguration()
public final void merge(NativeObjectContainer source, String property)
source
- native object container to addproperty
- property namepublic final String toJSON()
public final ChartEnvelop<NativeObject> loadNativeObject(ChartEnvelop<NativeObject> envelop)
org.pepstock.charba.client
package.envelop
- envelop instance which will contain the native objectpublic final IsChart getChart()