org.pepstock.charba.client.data.BubbleDataset 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 - J2CL and GWT charts library based on CHART.JS
/**
Copyright 2017 Andrea "Stock" Stocchero
Licensed 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.data;
import java.util.List;
import org.pepstock.charba.client.ChartType;
import org.pepstock.charba.client.Type;
import org.pepstock.charba.client.callbacks.PointStyleCallback;
import org.pepstock.charba.client.callbacks.RadiusCallback;
import org.pepstock.charba.client.callbacks.RotationCallback;
import org.pepstock.charba.client.callbacks.ScriptableContext;
import org.pepstock.charba.client.callbacks.ScriptableFunctions;
import org.pepstock.charba.client.callbacks.ScriptableUtils;
import org.pepstock.charba.client.commons.ArrayDouble;
import org.pepstock.charba.client.commons.ArrayDoubleList;
import org.pepstock.charba.client.commons.ArrayEnumList;
import org.pepstock.charba.client.commons.ArrayListHelper;
import org.pepstock.charba.client.commons.ArrayString;
import org.pepstock.charba.client.commons.CallbackProxy;
import org.pepstock.charba.client.commons.JsHelper;
import org.pepstock.charba.client.commons.Key;
import org.pepstock.charba.client.defaults.IsDefaultOptions;
import org.pepstock.charba.client.enums.PointStyle;
/**
* The chart allows a number of properties to be specified for each dataset. These are used to set display properties for a specific dataset.
* The location of the bubble is determined by the first two dimensions and the corresponding horizontal and vertical axes.
* The third dimension is represented by the size of the individual bubbles.
*
* @author Andrea "Stock" Stocchero
*/
public final class BubbleDataset extends HovingDataset implements HasDataPoints, HasOrder {
// ---------------------------
// -- CALLBACKS PROXIES ---
// ---------------------------
// callback proxy to invoke the radius function
private final CallbackProxy radiusCallbackProxy = JsHelper.get().newCallbackProxy();
// callback proxy to invoke the hit radius function
private final CallbackProxy hitRadiusCallbackProxy = JsHelper.get().newCallbackProxy();
// callback proxy to invoke the hover radius function
private final CallbackProxy hoverRadiusCallbackProxy = JsHelper.get().newCallbackProxy();
// callback proxy to invoke the rotation function
private final CallbackProxy rotationCallbackProxy = JsHelper.get().newCallbackProxy();
// callback proxy to invoke the point style function
private final CallbackProxy pointStyleCallbackProxy = JsHelper.get().newCallbackProxy();
// radius callback instance
private RadiusCallback radiusCallback = null;
// hit radius callback instance
private RadiusCallback hitRadiusCallback = null;
// hover radius callback instance
private RadiusCallback hoverRadiusCallback = null;
// rotation callback instance
private RotationCallback rotationCallback = null;
// point style callback instance
private PointStyleCallback pointStyleCallback = null;
/**
* Name of properties of native object.
*/
private enum Property implements Key
{
HOVER_RADIUS("hoverRadius"),
HIT_RADIUS("hitRadius"),
POINT_STYLE("pointStyle"),
RADIUS("radius"),
ROTATION("rotation");
// name value of property
private final String value;
/**
* Creates with the property value to use into native object.
*
* @param value value of property name
*/
private Property(String value) {
this.value = value;
}
/*
* (non-Javadoc)
*
* @see org.pepstock.charba.client.commons.Key#value()
*/
@Override
public String value() {
return value;
}
}
// instance or orderer
private final Orderer orderer;
/**
* Creates a dataset.
* It uses the global options has default.
*/
public BubbleDataset() {
this(ChartType.BUBBLE);
}
/**
* Creates the dataset using a default.
*
* @param defaultValues default options
*/
public BubbleDataset(IsDefaultOptions defaultValues) {
this(ChartType.BUBBLE, defaultValues);
}
/**
* Creates the dataset using chart type related to the dataset.
*
* @param type chart type related to the dataset
*/
protected BubbleDataset(Type type) {
this(type, null);
}
/**
* Creates the dataset using a default and chart type related to the dataset.
*
* @param type chart type related to the dataset
* @param defaultValues default options
*/
protected BubbleDataset(Type type, IsDefaultOptions defaultValues) {
super(type, defaultValues);
// sets new orderer
orderer = new Orderer(getNativeObject());
// -------------------------------
// -- SET CALLBACKS to PROXIES ---
// -------------------------------
// gets value calling callback
radiusCallbackProxy.setCallback((contextFunction, context) -> ScriptableUtils.getOptionValue(new ScriptableContext(context), radiusCallback, getDefaultValues().getElements().getPoint().getRadius()).doubleValue());
// gets value calling callback
hitRadiusCallbackProxy.setCallback((contextFunction, context) -> ScriptableUtils.getOptionValue(new ScriptableContext(context), hitRadiusCallback, getDefaultValues().getElements().getPoint().getHitRadius()).doubleValue());
// gets value calling callback
hoverRadiusCallbackProxy.setCallback((contextFunction, context) -> ScriptableUtils.getOptionValue(new ScriptableContext(context), hoverRadiusCallback, getDefaultValues().getElements().getPoint().getHoverRadius()).doubleValue());
// gets value calling callback
rotationCallbackProxy.setCallback((contextFunction, context) -> ScriptableUtils.getOptionValue(new ScriptableContext(context), rotationCallback, getDefaultValues().getElements().getPoint().getRotation()).doubleValue());
// gets value calling callback
pointStyleCallbackProxy.setCallback((contextFunction, context) -> onPointStyle(new ScriptableContext(context)));
}
/*
* (non-Javadoc)
*
* @see org.pepstock.charba.client.data.Dataset#mustUseDataPoints()
*/
@Override
final boolean mustUseDataPoints() {
return true;
}
/*
* (non-Javadoc)
*
* @see org.pepstock.charba.client.data.HasOrder#getOrderer()
*/
@Override
public Orderer getOrderer() {
return orderer;
}
/**
* Sets the style of the point.
*
* @param pointStyle array of the style of the point.
*/
public void setPointStyle(PointStyle... pointStyle) {
// resets callback
setPointStyle((PointStyleCallback) null);
// stores value
setValueOrArray(Property.POINT_STYLE, pointStyle);
}
/**
* Returns the style of the point.
*
* @return list of the style of the point.
*/
public List getPointStyle() {
// checks if the callback has not been set
if (getPointStyleCallback() == null) {
// returns the array
ArrayString array = getValueOrArray(Property.POINT_STYLE, getDefaultValues().getElements().getPoint().getPointStyle());
return ArrayListHelper.list(PointStyle.values(), array);
}
// if here, is a callback
// then returns an empty list
return new ArrayEnumList<>(PointStyle.values());
}
/**
* Sets the pixel size of the non-displayed point that reacts to mouse events.
*
* @param hitRadius array of the pixel size of the non-displayed point.
*/
public void setHitRadius(double... hitRadius) {
// resets callback
setHitRadius((RadiusCallback) null);
// stores value
setValueOrArray(Property.HIT_RADIUS, hitRadius);
}
/**
* Returns the pixel size of the non-displayed point that reacts to mouse events.
*
* @return list of the pixel size of the non-displayed point.
*/
public List getHitRadius() {
// checks if the callback has not been set
if (getHitRadiusCallback() == null) {
// returns the array
ArrayDouble array = getValueOrArray(Property.HIT_RADIUS, getDefaultValues().getElements().getPoint().getHitRadius());
return ArrayListHelper.list(array);
}
// if here, is a callback
// then returns an empty list
return new ArrayDoubleList();
}
/**
* Sets the radius of the point when hovered.
*
* @param hoverRadius array of the radius of the point when hovered.
*/
public void setHoverRadius(double... hoverRadius) {
// resets callback
setHoverRadius((RadiusCallback) null);
// stores value
setValueOrArray(Property.HOVER_RADIUS, hoverRadius);
}
/**
* Returns the radius of the point when hovered.
*
* @return list of the radius of the point when hovered.
*/
public List getHoverRadius() {
// checks if the callback has not been set
if (getHoverRadiusCallback() == null) {
// returns the array
ArrayDouble array = getValueOrArray(Property.HOVER_RADIUS, getDefaultValues().getElements().getPoint().getHoverRadius());
return ArrayListHelper.list(array);
}
// if here, is a callback
// then returns an empty list
return new ArrayDoubleList();
}
/**
* Sets the radius of the point shape. If set to 0, the point is not rendered.
*
* @param radius array of the radius of the point shape.
*/
public void setRadius(double... radius) {
// resets callback
setRadius((RadiusCallback) null);
// stores value
setValueOrArray(Property.RADIUS, radius);
}
/**
* Returns the radius of the point shape.
*
* @return list of the radius of the point shape.
*/
public List getRadius() {
// checks if the callback has not been set
if (getRadiusCallback() == null) {
// returns the array
ArrayDouble array = getValueOrArray(Property.RADIUS, getDefaultValues().getElements().getPoint().getRadius());
return ArrayListHelper.list(array);
}
// if here, is a callback
// then returns an empty list
return new ArrayDoubleList();
}
/**
* Sets the rotation of the point in degrees.
*
* @param rotation array of the rotation of the point in degrees.
*/
public void setRotation(double... rotation) {
// resets callback
setRotation((RotationCallback) null);
// stores value
setValueOrArray(Property.ROTATION, rotation);
}
/**
* Returns the rotation of the point in degrees.
*
* @return list of the rotation of the point in degrees.
*/
public List getRotation() {
// checks if the callback has not been set
if (getRotationCallback() == null) {
// returns the array
ArrayDouble array = getValueOrArray(Property.ROTATION, getDefaultValues().getElements().getPoint().getRotation());
return ArrayListHelper.list(array);
}
// if here, is a callback
// then returns an empty list
return new ArrayDoubleList();
}
/**
* Returns the radius callback, if set, otherwise null.
*
* @return the radius callback, if set, otherwise null.
*/
public RadiusCallback getRadiusCallback() {
return radiusCallback;
}
/**
* Sets the radius callback.
*
* @param radiusCallback the radius callback to set
*/
public void setRadius(RadiusCallback radiusCallback) {
// sets the callback
this.radiusCallback = radiusCallback;
// checks if callback is consistent
if (radiusCallback != null) {
// adds the callback proxy function to java script object
setValue(Property.RADIUS, radiusCallbackProxy.getProxy());
} else {
// otherwise sets null which removes the properties from java script object
remove(Property.RADIUS);
}
}
/**
* Returns the hit radius callback, if set, otherwise null.
*
* @return the hit radius callback, if set, otherwise null.
*/
public RadiusCallback getHitRadiusCallback() {
return hitRadiusCallback;
}
/**
* Sets the hit radius callback.
*
* @param hitRadiusCallback the hit radius callback to set
*/
public void setHitRadius(RadiusCallback hitRadiusCallback) {
// sets the callback
this.hitRadiusCallback = hitRadiusCallback;
// checks if callback is consistent
if (hitRadiusCallback != null) {
// adds the callback proxy function to java script object
setValue(Property.HIT_RADIUS, hitRadiusCallbackProxy.getProxy());
} else {
// otherwise sets null which removes the properties from java script object
remove(Property.HIT_RADIUS);
}
}
/**
* Returns the hover radius callback, if set, otherwise null.
*
* @return the hover radius callback, if set, otherwise null.
*/
public RadiusCallback getHoverRadiusCallback() {
return hoverRadiusCallback;
}
/**
* Sets the hover radius callback.
*
* @param hoverRadiusCallback the hover radius callback to set
*/
public void setHoverRadius(RadiusCallback hoverRadiusCallback) {
// sets the callback
this.hoverRadiusCallback = hoverRadiusCallback;
// checks if callback is consistent
if (hoverRadiusCallback != null) {
// adds the callback proxy function to java script object
setValue(Property.HOVER_RADIUS, hoverRadiusCallbackProxy.getProxy());
} else {
// otherwise sets null which removes the properties from java script object
remove(Property.HOVER_RADIUS);
}
}
/**
* Returns the rotation callback, if set, otherwise null.
*
* @return the rotation callback, if set, otherwise null.
*/
public RotationCallback getRotationCallback() {
return rotationCallback;
}
/**
* Sets the rotation callback.
*
* @param rotationCallback the rotation callback to set
*/
public void setRotation(RotationCallback rotationCallback) {
// sets the callback
this.rotationCallback = rotationCallback;
// checks if callback is consistent
if (rotationCallback != null) {
// adds the callback proxy function to java script object
setValue(Property.ROTATION, rotationCallbackProxy.getProxy());
} else {
// otherwise sets null which removes the properties from java script object
remove(Property.ROTATION);
}
}
/**
* Returns the point style callback, if set, otherwise null.
*
* @return the point style callback, if set, otherwise null.
*/
public PointStyleCallback getPointStyleCallback() {
return pointStyleCallback;
}
/**
* Sets the point style callback.
*
* @param pointStyleCallback the point style callback.
*/
public void setPointStyle(PointStyleCallback pointStyleCallback) {
// sets the callback
this.pointStyleCallback = pointStyleCallback;
// checks if callback is consistent
if (pointStyleCallback != null) {
// adds the callback proxy function to java script object
setValue(Property.POINT_STYLE, pointStyleCallbackProxy.getProxy());
} else {
// otherwise sets null which removes the properties from java script object
remove(Property.POINT_STYLE);
}
}
/**
* Returns a {@link PointStyle} when the callback has been activated.
*
* @param context native object as context.
* @return a object property value, as {@link PointStyle}
*/
private String onPointStyle(ScriptableContext context) {
// gets value
Object result = ScriptableUtils.getOptionValue(context, pointStyleCallback);
// checks result
if (result instanceof PointStyle) {
// is point style instance
PointStyle style = (PointStyle) result;
return style.value();
}
// default result
return getDefaultValues().getElements().getPoint().getPointStyle().value();
}
}