org.pepstock.charba.client.Chart Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of charba Show documentation
Show all versions of charba Show documentation
Charba, GWT Chart library based on CHART.JS
/**
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/
package org.pepstock.charba.client;
import org.pepstock.charba.client.commons.ArrayChart;
import org.pepstock.charba.client.commons.ArrayObject;
import org.pepstock.charba.client.commons.Id;
import org.pepstock.charba.client.commons.IsJSType;
import org.pepstock.charba.client.commons.NativeName;
import org.pepstock.charba.client.commons.NativeObject;
import org.pepstock.charba.client.dom.elements.Context2dItem;
import org.pepstock.charba.client.dom.events.NativeBaseEvent;
import jsinterop.annotations.JsMethod;
import jsinterop.annotations.JsOverlay;
import jsinterop.annotations.JsPackage;
import jsinterop.annotations.JsProperty;
import jsinterop.annotations.JsType;
/**
* Native object which import the CHART java script object of CHART.JS.
* The Chart the entry point of CHART.JS.
*
* @author Andrea "Stock" Stocchero
*/
// Ignores SonarCloud issue, java:S1172 - Unused method parameters should be removed, because this is the way of JSINTEROP to invoke a JavaScript constructor.
@SuppressWarnings("java:S1172")
@JsType(isNative = true, name = NativeName.CHART, namespace = JsPackage.GLOBAL)
public final class Chart implements IsJSType {
/**
* Returns the defaults property by native object.
*
* @return the defaults property by native object.
*/
@JsProperty
static native NativeObject getDefaults();
/**
* Returns the overrides property by native object.
*
* @return the overrides property by native object.
*/
@JsProperty
static native NativeObject getOverrides();
/**
* Returns the helpers property by native object.
*
* @return the helpers property by native object.
*/
@JsProperty
static native NativeHelpers getHelpers();
/**
* Returns the instances property by native object.
*
* @return the instances property by native object.
*/
@JsProperty
public static native ArrayChart getInstances();
/**
* Returns the interaction property by native object.
*
* @return the interaction property by native object.
*/
@JsProperty(name = "Interaction")
static native NativeObject getInteraction();
/**
* Builds CHART object at CHART.JS level.
* This constructor MUST be empty.
*
* @param context represents a flat cartesian surface whose origin (0,0) is at the top left corner, with the coordinate space having x values increasing when going right, and y
* values increasing when going down.
* @param configuration configuration of CHART (native object).
*/
protected Chart(Context2dItem context, NativeObject configuration) {
}
/**
* 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.
*/
@JsMethod
native void resize();
/**
* 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.
*
* @param width width size of resize
* @param height height size of resize
*/
@JsMethod
native void resize(int width, int height);
/**
* 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.
*/
@JsMethod
native 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.
* 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.
*
* @param mode an animation mode can be provided to indicate what should be updated and what animation configuration should be used
*/
@JsMethod
native void update(String mode);
/**
* Triggers a redraw of all chart elements.
* Note, this does not update elements for new data. Use .update() in that case.
*/
@JsMethod
native void render();
/**
* Triggers a redraw of all chart elements.
* It just clears the canvas and draws all the elements again, without doing layout and other stuff.
*/
@JsMethod
native void draw();
/**
* Use this to destroy any chart instances that are created.
* This will clean up any references stored to the chart object within Chart.js, along with any associated event listeners attached by Chart.js.
*/
@JsMethod
native void destroy();
/**
* Use this to stop any current animation loop.
* This will pause the chart during any current animation frame. Call .render() to re-animate.
*/
@JsMethod
native void stop();
/**
* Will clear the chart canvas.
* Used extensively internally between animation frames.
*/
@JsMethod
native void clear();
/**
* Reset the chart to it's state before the initial animation.
* A new animation can then be triggered using update.
*/
@JsMethod
native void reset();
/**
* Returns a base 64 encoded string of the chart in it's current state.
*
* @param type indicating the image format
* @param encoderOptions between 0 and 1 indicating the image quality to use for image formats that use lossy compression.
* If this argument is anything else, the default value for image quality is used. The default value is 0.92.
* @return base 64 image
*/
@JsMethod
native String toBase64Image(String type, double encoderOptions);
/**
* 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.
*
* @param event event of chart.
* @param mode interaction mode to use
* @param options interaction options which is an object as following:
*
* interface IInteractionOptions {
* axis?: string;
* intersect?: boolean;
* }
*
* @param useFinalPosition if true, defines the interpolation to get the elements that will be in the event position when current animations are completed.
* When false, elements are considered at their current position.
* @return all elements at the same data index, as array of native object.
* It is an object as following:
*
* interface InteractionItem {
* element: Element;
* datasetIndex: number;
* index: number;
* }
*
*/
@JsMethod
native ArrayObject getElementsAtEventForMode(NativeBaseEvent event, String mode, NativeObject options, boolean useFinalPosition);
/**
* Returns an array of all the dataset meta's in the order that they are drawn on the canvas that are not hidden.
*
* @return an array of all the dataset meta's in the order that they are drawn on the canvas that are not hidden.
*/
@JsMethod
native ArrayObject getSortedVisibleDatasetMetas();
/**
* Looks for the dataset that matches the current index.
*
* @param index dataset index
* @return dataset item, as native object
*/
@JsMethod
native NativeObject getDatasetMeta(int index);
/**
* Gets if the dataset is visible or not, selected by index.
*
* @param index dataset index
* @return true if dataset is visible otherwise false.
*/
@JsMethod
native boolean isDatasetVisible(int index);
/**
* Gets the amount of datasets which are visible
*
* @return the amount of datasets which are visible
*/
@JsMethod
native int getVisibleDatasetCount();
/**
* 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.
*
* @param datasetIndex dataset index
* @param visibility if true enables the visibility otherwise false
*/
@JsMethod
native void setDatasetVisibility(int datasetIndex, boolean visibility);
/**
* 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.
*
* @param index data index
*/
@JsMethod
native void toggleDataVisibility(int index);
/**
* Returns the stored visibility state of an data index for all datasets.
*
* @param index data index
* @return true if the data item is visible
*/
@JsMethod
native boolean getDataVisibility(int index);
/**
* 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.
*
* @param datasetIndex dataset index
*/
@JsMethod
native void hide(int datasetIndex);
/**
* Sets the hidden flag of that element index to true and updates the chart.
*
* @param datasetIndex dataset index
* @param dataIndex data index
*/
@JsMethod
native void hide(int datasetIndex, int dataIndex);
/**
* 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.
*
* @param datasetIndex dataset index
*/
@JsMethod
native void show(int datasetIndex);
/**
* Sets the hidden flag of that element index to false and updates the chart.
*
* @param datasetIndex dataset index
* @param dataIndex data index
*/
@JsMethod
native void show(int datasetIndex, int dataIndex);
/**
* Sets the active (hovered) elements for the chart.
*
* @param elements array of active elements
*/
@JsMethod
native void setActiveElements(ArrayObject elements);
/**
* Returns the active (hovered) elements for the chart.
*
* @return the array of active elements
*/
@JsMethod
native ArrayObject getActiveElements();
/**
* Check if a plugin with the specific ID is registered and enabled.
*
* @param pluginId the ID of the plugin of which to check if it is enabled
* @return boolean returns true if plugin is registered and enabled
*/
@JsMethod
native boolean isPluginEnabled(String pluginId);
/**
* Returns the CHART JS chart ID.
*
* @return the CHART JS chart ID.
*/
@JsProperty
native int getId();
/**
* Returns the width in pixel.
*
* @return the width in pixel.
*/
@JsProperty
native int getWidth();
/**
* Returns the height in pixel.
*
* @return the height in pixel.
*/
@JsProperty
native int getHeight();
/**
* Returns the aspect ratio.
*
* @return the aspect ratio.
*/
@JsProperty
native double getAspectRatio();
/**
* Returns the current device pixel ratio.
*
* @return the current device pixel ratio.
*/
@JsProperty
native double getCurrentDevicePixelRatio();
/**
* Returns the chart area node, as native object.
*
* @return the chart area node.
*/
@JsProperty
native NativeObject getChartArea();
/**
* Returns the legend node, as native object.
*
* @return the legend node.
*/
@JsProperty
native NativeObject getLegend();
/**
* Returns the title node, as native object.
*
* @return the title node.
*/
@JsProperty
native NativeObject getTitleBlock();
/**
* Returns the subtitle node, as native object.
*
* @return the subtitle node.
*/
@JsOverlay
NativeObject getSubtitle() {
return JsChartHelper.get().getSubtitle(this);
}
/**
* Returns the options node, as native object.
*
* @return the options node.
*/
@JsProperty
native NativeObject getOptions();
/**
* Sets new options node, as native object, for updating a existing chart.
*
* @param newOptions options node.
*/
@JsProperty
native void setOptions(NativeObject newOptions);
/**
* Returns the scales node, as native object.
*
* @return the scales node.
*/
@JsProperty
native NativeObject getScales();
/**
* Returns the tooltip node, as native object.
*
* @return the tooltip node.
*/
@JsProperty
native NativeObject getTooltip();
/**
* Returns the CHARBA ID, set to the chart.
*
* @return the CHARBA ID
* @see org.pepstock.charba.client.commons.Id
*/
@JsOverlay
public String getCharbaId() {
return Id.get(getOptions());
}
/**
* Returns the CHARBA chart or null if CHARBA id is not present in the CAHRT.JS chart options.
*
* @return the CHARBA chart or null if CHARBA id is not present in the CAHRT.JS chart options
*/
@JsOverlay
public IsChart getChart() {
return Charts.get(getCharbaId());
}
}