C
- type for the specific chartpublic abstract class AbstractChartWidget<C extends IsChart> extends SimplePanel implements IsChart
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled
HasWidgets.ForIsWidget
DEBUG_ID_PREFIX
Modifier | Constructor and Description |
---|---|
protected |
AbstractChartWidget(C chart)
Creates a chart widget for GWT by chart element instance.
|
Modifier and Type | Method and Description |
---|---|
HandlerRegistration |
addHandler(EventHandler handler,
EventType type)
Adds this handler to the widget.
|
void |
checkAxes(Axis... axes)
Checks if axes, requested to be stored, are an acceptable type or amount.
If a axis type or the amount of axes are not consistent for the chart, a IllegalArgumentException will be thrown. |
void |
checkDatasets(Dataset... datasets)
Checks if datasets, requested to be stored, are an acceptable type or amount.
If a dataset type or the amount of datasets are not consistent for the chart, a IllegalArgumentException will be thrown. |
void |
createAndSetTimer(ChartTimerTask task,
int interval)
Creates a
CTimer instance inside chart.It can be created only once during the life cycle of the chart. |
void |
destroy()
Use this to destroy any chart instances that are created.
|
void |
draw()
Draws the chart
|
void |
fireEvent(Event event)
Fires the event to the handlers.
|
List<ActiveDatasetElement> |
getActiveElements()
Returns the active (hovered) elements for the chart.
|
Type |
getBaseType()
Returns the base type of chart that in case of
ChartType is the same of IsChart.getType() otherwise, in case the type of the chart is a
ControllerType is the chart type extension if there is or null . |
Canvas |
getCanvas()
Returns the canvas element used to draw the chart.
|
C |
getChart()
Returns the chart instance, wrapped by this GWT widget.
|
Div |
getChartElement()
Gets a handle to the object's underlying DOM element.
|
Data |
getData()
Returns the data object with all passed datasets.
|
List<DatasetReference> |
getDatasetAtEvent(BaseNativeEvent event)
Looks for the dataset that matches the event.
|
DatasetItem |
getDatasetItem(int index)
Looks for the dataset that matches the current index and returns.
|
IsDefaultScaledOptions |
getDefaultChartOptions()
Returns the default options created based on chart type.
|
DatasetReference |
getElementAtEvent(BaseNativeEvent event)
Calling on your chart instance passing an argument of an event, will return the single element at the event position.
If there are multiple items within range, only the first is returned. |
List<DatasetReference> |
getElementsAtEvent(BaseNativeEvent event)
Looks for the element under the event point, then returns all elements at the same data index.
Calling it on your chart instance passing an argument of an event, will return the point elements that are at that the same position of that event. |
int |
getHandlerCount(EventType type)
Returns the amount of handlers for a specific event type.
|
String |
getId()
Returns the ID of chart.
It could be considered as chart unique ID. |
CursorType |
getInitialCursor()
Returns the initial cursor of the chart.
|
ChartNode |
getNode()
Returns the chart node with runtime data.
|
Plugins |
getPlugins()
Returns the plugins element to manage inline plugins.
|
CTimer |
getTimer()
Returns a
CTimer instance inside chart. |
List<ActiveDatasetElement> |
getTooltipActiveElements()
Returns the active tooltip elements for the chart.
|
Type |
getType()
Returns the type of chart.
|
int |
getVisibleDatasetCount()
Returns the amount of datasets which are visible
|
IsDefaultScaledOptions |
getWholeOptions()
Returns the default options by a chart instance, merging global, chart type global and chart options.
|
void |
hide(int datasetIndex)
Sets the visibility for the given dataset to false.
Updates the chart and animates the dataset with 'hide' mode. This animation can be configured under the hide key in animation options. |
void |
hide(int datasetIndex,
int dataIndex)
Sets the hidden flag of that element index to
true and updates the chart. |
boolean |
isChartAttached()
Returns
true whether this chart is currently attached to the browser's document. |
boolean |
isDatasetVisible(int index)
Looks for the dataset if it's visible or not, selected by index.
|
boolean |
isDataVisible(int index)
Returns the stored visibility state of an data index for all datasets.
|
boolean |
isDestroyOnDetach()
Returns
true if the chart is configured to be destroyed on the attach of DIV element, otherwise false . |
boolean |
isDrawOnAttach()
Returns
true if the chart is configured to be drawn on the attach of DIV element, otherwise false . |
boolean |
isEventHandled(EventType type)
Returns
true if there is any event handler for event type passed as argument. |
boolean |
isInitialized()
Returns
true if CHART.JS chart has been initialized, otherwise false . |
void |
reconfigure()
Triggers an update of the chart.
This can be safely called after updating the data object. This will update the options, mutating the options property in place. |
void |
reconfigure(TransitionKey mode)
Triggers an update of the chart.
This can be safely called after updating the data object. This will update the options, mutating the options property in place. A animation mode key can be provided for the update process using a specific animation configuration. This is useful when update is manually called inside an event handler and some different animation is desired. |
void |
reconfigure(UpdateConfiguration config)
Triggers an update of the chart.
This can be safely called after updating the data object. This will update the options, mutating the options property in place. A configuration object can be provided with additional configuration for the update process. This is useful when update is manually called inside an event handler and some different animation is desired. |
void |
removeCanvasPreventDefault()
Remove the registration of prevent default mouse listener from canvas.
This is necessary when you will add your mouse down listener. |
void |
render()
Triggers a redraw of all chart elements.
Note, this does not update elements for new data. |
void |
reset()
Reset the chart to it's state before the initial animation.
|
void |
resetActiveElements()
Resets the active (hovered) elements for the chart.
|
void |
resetTooltipActiveElements()
Resets the active tooltip elements for the chart.
|
void |
resize()
Use this to manually resize the canvas element.
|
void |
resize(int width,
int height)
Use this to manually resize the canvas element.
This is run each time the canvas container is resized, but can be called this method manually if you change the size of the canvas nodes container element. |
void |
setActiveElements(ActiveDatasetElement... elements)
Sets the active (hovered) elements for the chart.
|
void |
setActiveElements(List<ActiveDatasetElement> elements)
Sets the active (hovered) elements for the chart.
|
void |
setDatasetVisibility(int datasetIndex,
boolean visibility)
Sets the visibility for a given dataset.
This can be used to build a chart legend in HTML. During click on one of the HTML items, you can call it to change the appropriate dataset. |
void |
setDestroyOnDetach(boolean destroyOnDetach)
Sets
true if the chart is configured to be destroyed on the attach of DIV element, otherwise false . |
void |
setDrawOnAttach(boolean drawOnAttach)
Sets
true if the chart is configured to be draw on the attach of DIV element, otherwise false . |
void |
setTooltipActiveElements(ActiveDatasetElement... elements)
Sets the active tooltip elements for the chart.
|
void |
setTooltipActiveElements(List<ActiveDatasetElement> elements)
Sets the active tooltip elements for the chart.
|
void |
show(int datasetIndex)
Sets the visibility for the given dataset to true.
Updates the chart and animates the dataset with 'show' mode. This animation can be configured under the show key in animation options. |
void |
show(int datasetIndex,
int dataIndex)
Sets the hidden flag of that element index to
false and updates the chart. |
void |
stop()
Use this to stop any current animation loop.
|
String |
toBase64Image(ImageMimeType type,
double encoderOptions)
Returns a base 64 encoded string of the chart in it's current state.
|
void |
toggleDataVisibility(int index)
Toggles the visibility of an item in all datasets.
A dataset needs to explicitly support this feature for it to have an effect. From internal chart types, doughnut / pie and polar area use this. |
void |
update()
Triggers an update of the chart.
This can be safely called after updating the data object. This will update all scales, legends, and then re-render the chart. |
void |
update(TransitionKey mode)
Triggers an update of the chart.
This can be safely called after updating the data object. This will update all scales, legends, and then re-render the chart. A config object can be provided with additional configuration for the update process. This is useful when update is manually called inside an event handler and some different animation is desired. |
void |
update(UpdateConfiguration config)
Triggers an update of the chart.
This can be safely called after updating the data object. This will update all scales, legends, and then re-render the chart. A config object can be provided with additional configuration for the update process. This is useful when update is manually called inside an event handler and some different animation is desired. |
add, getContainerElement, getWidget, iterator, remove, setWidget, setWidget
add, adopt, clear, doAttachChildren, doDetachChildren, orphan, remove
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents
addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
checkAndGetIfConsistent, checkAndGetIfValid, checkIfConsistent, checkIfValid, clear, getOptions, isAbstractChart, isConsistent, isValid, toBase64Image, toBase64Image, toBase64Image
forEach, spliterator
protected AbstractChartWidget(C chart)
chart
- chart instance to wrap by the widgetpublic final C getChart()
public final void fireEvent(Event event)
IsChart
public final HandlerRegistration addHandler(EventHandler handler, EventType type)
IsChart
addHandler
in interface IsChart
handler
- the handlertype
- the event typepublic int getHandlerCount(EventType type)
IsChart
getHandlerCount
in interface IsChart
type
- event type to use to get the amount of handlerspublic boolean isEventHandled(EventType type)
IsChart
true
if there is any event handler for event type passed as argument.isEventHandled
in interface IsChart
type
- event type to checktrue
if there is any event handler for event type passed as argumentpublic final Div getChartElement()
IsChart
getChartElement
in interface IsChart
public final boolean isChartAttached()
IsChart
true
whether this chart is currently attached to the browser's document.isChartAttached
in interface IsChart
true
whether this chart is currently attached to the browser's documentpublic final Type getType()
IsChart
public final Type getBaseType()
IsChart
ChartType
is the same of IsChart.getType()
otherwise, in case the type of the chart is a
ControllerType
is the chart type extension if there is or null
.getBaseType
in interface IsChart
public final String getId()
IsChart
public final Canvas getCanvas()
IsChart
public final void removeCanvasPreventDefault()
IsChart
removeCanvasPreventDefault
in interface IsChart
public final CursorType getInitialCursor()
IsChart
getInitialCursor
in interface IsChart
public final boolean isInitialized()
IsChart
true
if CHART.JS chart has been initialized, otherwise false
.isInitialized
in interface IsChart
true
if CHART.JS chart has been initialized, otherwise false
.public final ChartNode getNode()
IsChart
public final Data getData()
IsChart
public final Plugins getPlugins()
IsChart
getPlugins
in interface IsChart
public final IsDefaultScaledOptions getDefaultChartOptions()
IsChart
getDefaultChartOptions
in interface IsChart
public final IsDefaultScaledOptions getWholeOptions()
IsChart
getWholeOptions
in interface IsChart
public final CTimer getTimer()
IsChart
CTimer
instance inside chart.public final void createAndSetTimer(ChartTimerTask task, int interval)
IsChart
CTimer
instance inside chart.createAndSetTimer
in interface IsChart
task
- the task to be executed repeatedlyinterval
- the time, in milliseconds (thousands of a second), the timer should delay in between executions of the specified task.public final boolean isDrawOnAttach()
IsChart
true
if the chart is configured to be drawn on the attach of DIV element, otherwise false
.isDrawOnAttach
in interface IsChart
true
if the chart is configured to be drawn on the attach of DIV element, otherwise false
.public final void setDrawOnAttach(boolean drawOnAttach)
IsChart
true
if the chart is configured to be draw on the attach of DIV element, otherwise false
.setDrawOnAttach
in interface IsChart
drawOnAttach
- the drawOnAttach to setpublic final boolean isDestroyOnDetach()
IsChart
true
if the chart is configured to be destroyed on the attach of DIV element, otherwise false
.isDestroyOnDetach
in interface IsChart
true
if the chart is configured to be destroyed on the attach of DIV element, otherwise false
.public final void setDestroyOnDetach(boolean destroyOnDetach)
IsChart
true
if the chart is configured to be destroyed on the attach of DIV element, otherwise false
.setDestroyOnDetach
in interface IsChart
destroyOnDetach
- the destroyOnDetach to setpublic void setActiveElements(List<ActiveDatasetElement> elements)
IsChart
setActiveElements
in interface IsChart
elements
- list of active elementspublic void setActiveElements(ActiveDatasetElement... elements)
IsChart
setActiveElements
in interface IsChart
elements
- array of active elementspublic void resetActiveElements()
IsChart
resetActiveElements
in interface IsChart
public List<ActiveDatasetElement> getActiveElements()
IsChart
getActiveElements
in interface IsChart
public void setTooltipActiveElements(List<ActiveDatasetElement> elements)
IsChart
setTooltipActiveElements
in interface IsChart
elements
- list of active tooltip elementspublic void setTooltipActiveElements(ActiveDatasetElement... elements)
IsChart
setTooltipActiveElements
in interface IsChart
elements
- array of active tooltip elementspublic void resetTooltipActiveElements()
IsChart
resetTooltipActiveElements
in interface IsChart
public List<ActiveDatasetElement> getTooltipActiveElements()
IsChart
getTooltipActiveElements
in interface IsChart
public final void destroy()
IsChart
public final void stop()
IsChart
.render()
to re-animate.public final void reset()
IsChart
public String toBase64Image(ImageMimeType type, double encoderOptions)
IsChart
toBase64Image
in interface IsChart
type
- indicating the image formatencoderOptions
- between 0 and 1 indicating the image quality to use for image formats that use lossy compression.Undefined.STRING
if chart is not initialized.public final void resize()
IsChart
public void resize(int width, int height)
IsChart
public final void update()
IsChart
public final void update(TransitionKey mode)
IsChart
public final void update(UpdateConfiguration config)
IsChart
public void reconfigure()
IsChart
reconfigure
in interface IsChart
public void reconfigure(TransitionKey mode)
IsChart
reconfigure
in interface IsChart
mode
- an animation mode can be provided to indicate what should be updated and what animation configuration should be usedpublic void reconfigure(UpdateConfiguration config)
IsChart
reconfigure
in interface IsChart
config
- a configuration object can be provided with additional configuration for the update processpublic final void render()
IsChart
.update()
in that case.public final DatasetItem getDatasetItem(int index)
IsChart
getDatasetItem
in interface IsChart
index
- dataset indexpublic final List<DatasetReference> getDatasetAtEvent(BaseNativeEvent event)
IsChart
getDatasetAtEvent
in interface IsChart
event
- event of chart.public final boolean isDatasetVisible(int index)
IsChart
isDatasetVisible
in interface IsChart
index
- dataset indextrue
if dataset is visible otherwise false
.public final int getVisibleDatasetCount()
IsChart
getVisibleDatasetCount
in interface IsChart
Undefined.INTEGER
.public void setDatasetVisibility(int datasetIndex, boolean visibility)
IsChart
setDatasetVisibility
in interface IsChart
datasetIndex
- dataset indexvisibility
- if true
enables the visibility otherwise false
public void toggleDataVisibility(int index)
IsChart
toggleDataVisibility
in interface IsChart
index
- data indexpublic boolean isDataVisible(int index)
IsChart
isDataVisible
in interface IsChart
index
- data indextrue
if the data item is visiblepublic void hide(int datasetIndex)
IsChart
public void hide(int datasetIndex, int dataIndex)
IsChart
true
and updates the chart.public void show(int datasetIndex)
IsChart
public void show(int datasetIndex, int dataIndex)
IsChart
false
and updates the chart.public final DatasetReference getElementAtEvent(BaseNativeEvent event)
IsChart
getElementAtEvent
in interface IsChart
event
- event of chart.public final List<DatasetReference> getElementsAtEvent(BaseNativeEvent event)
IsChart
getElementsAtEvent
in interface IsChart
event
- event of chart.public final void draw()
IsChart
public final void checkDatasets(Dataset... datasets)
IsChart
IllegalArgumentException
will be thrown.checkDatasets
in interface IsChart
datasets
- list of datasets to check.public final void checkAxes(Axis... axes)
IsChart
IllegalArgumentException
will be thrown.