org.pepstock.charba.client.items.DatasetViewItem 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.items;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import org.pepstock.charba.client.Defaults;
import org.pepstock.charba.client.colors.ColorBuilder;
import org.pepstock.charba.client.colors.IsColor;
import org.pepstock.charba.client.commons.ArrayListHelper;
import org.pepstock.charba.client.commons.ArrayString;
import org.pepstock.charba.client.commons.Key;
import org.pepstock.charba.client.commons.NativeObject;
import org.pepstock.charba.client.commons.NativeObjectContainer;
import org.pepstock.charba.client.commons.ObjectType;
import org.pepstock.charba.client.enums.BorderSkipped;
import org.pepstock.charba.client.enums.PointStyle;
/**
* This item provides all information about the view where a dataset has been displayed.
* This object has been created and passed to event handler or callbacks to apply own logic.
* This is a wrapper of the CHART.JS item with all needed info.
*
* @author Andrea "Stock" Stocchero
*
*/
public final class DatasetViewItem extends NativeObjectContainer {
/**
* Name of properties of native object.
*/
private enum Property implements Key
{
DATASET_LABEL("datasetLabel"),
LABEL("label"),
BORDER_SKIPPED("borderSkipped"),
BACKGROUND_COLOR("backgroundColor"),
BORDER_COLOR("borderColor"),
BORDER_WIDTH("borderWidth"),
HORIZONTAL("horizontal"),
BASE("base"),
X("x"),
Y("y"),
WIDTH("width"),
HEIGHT("height"),
SKIP("skip"),
RADIUS("radius"),
POINT_STYLE("pointStyle"),
TENSION("tension"),
HIT_RADIUS("hitRadius"),
CONTROL_POINT_PREVIOUS_X("controlPointPreviousX"),
CONTROL_POINT_PREVIOUS_Y("controlPointPreviousY"),
CONTROL_POINT_NEXT_X("controlPointNextX"),
CONTROL_POINT_NEXT_Y("controlPointNextY"),
STEPPED_LINE("steppedLine"),
START_ANGLE("startAngle"),
END_ANGLE("endAngle"),
CIRCUMFERENCE("circumference"),
OUTER_RADIUS("outerRadius"),
INNER_RADIUS("innerRadius");
// 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;
}
}
/**
* Creates the item using a native java script object which contains all properties.
*
* @param nativeObject native java script object which contains all properties.
*/
DatasetViewItem(NativeObject nativeObject) {
super(nativeObject);
}
/**
* Returns the dataset label.
*
* @return the dataset label. Default is {@link UndefinedValues#STRING}.
*/
public String getDatasetLabel() {
return getValue(Property.DATASET_LABEL, UndefinedValues.STRING);
}
/**
* Returns the label.
*
* @return the label. Default is {@link UndefinedValues#STRING}.
*/
public String getLabel() {
return getValue(Property.LABEL, UndefinedValues.STRING);
}
/**
* Returns the edge to skip drawing the border for.
*
* @return the edge to skip drawing the border for. Default is {@link org.pepstock.charba.client.enums.BorderSkipped#FALSE}.
*/
public BorderSkipped getBorderSkipped() {
// checks if 'false' has been set
if (ObjectType.BOOLEAN.equals(type(Property.BORDER_SKIPPED))) {
// returns is false
return BorderSkipped.FALSE;
}
// otherwise returns the enum value as string
return getValue(Property.BORDER_SKIPPED, BorderSkipped.values(), BorderSkipped.FALSE);
}
/**
* Returns the fill color of the dataset item.
*
* @return list of the fill color of the dataset item.
*/
public String getBackgroundColorAsString() {
return getValue(Property.BACKGROUND_COLOR, Defaults.get().getGlobal().getDefaultColorAsString());
}
/**
* Returns the fill color of the dataset item.
*
* @return list of the fill color of the dataset item.
*/
public IsColor getBackgroundColor() {
return ColorBuilder.parse(getBackgroundColorAsString());
}
/**
* Returns the color of the dataset item border
*
* @return list of the color of the dataset item border.
*/
public String getBorderColorAsString() {
return getValue(Property.BORDER_COLOR, Defaults.get().getGlobal().getDefaultColorAsString());
}
/**
* Returns the color of the dataset item border
*
* @return list of the color of the dataset item border
*/
public IsColor getBorderColor() {
return ColorBuilder.parse(getBorderColorAsString());
}
/**
* Returns the stroke width of the dataset item in pixels.
*
* @return list of the stroke width of the dataset item in pixels. Default is {@link UndefinedValues#INTEGER}.
*/
public int getBorderWidth() {
return getValue(Property.BORDER_WIDTH, UndefinedValues.INTEGER);
}
/**
* Returns if is an horizontal view.
*
* @return true if is an horizontal view. Default is {@link UndefinedValues#BOOLEAN}.
*/
public boolean isHorizontal() {
return getValue(Property.HORIZONTAL, UndefinedValues.BOOLEAN);
}
/**
* Returns the base value of dataset.
*
* @return the base value of dataset. Default is {@link UndefinedValues#DOUBLE}.
*/
public double getBase() {
return getValue(Property.BASE, UndefinedValues.DOUBLE);
}
/**
* Returns the X location of dataset item in pixel.
*
* @return the X location of dataset item in pixel. Default is {@link UndefinedValues#DOUBLE}.
*/
public double getX() {
return getValue(Property.X, UndefinedValues.DOUBLE);
}
/**
* Returns the Y location of dataset item in pixel.
*
* @return the Y location of dataset item in pixel. Default is {@link UndefinedValues#DOUBLE}.
*/
public double getY() {
return getValue(Property.Y, UndefinedValues.DOUBLE);
}
/**
* Returns the width of dataset item in pixel.
*
* @return the width of dataset item in pixel. Default is {@link UndefinedValues#DOUBLE}.
*/
public double getWidth() {
return getValue(Property.WIDTH, UndefinedValues.DOUBLE);
}
/**
* Returns the height of dataset item in pixel.
*
* @return the height of dataset item in pixel. Default is {@link UndefinedValues#DOUBLE}.
*/
public double getHeight() {
return getValue(Property.HEIGHT, UndefinedValues.DOUBLE);
}
/**
* Returns true if skipped.
*
* @return true if skipped. Default is {@link UndefinedValues#BOOLEAN}.
*/
public boolean isSkipped() {
return getValue(Property.SKIP, UndefinedValues.BOOLEAN);
}
/**
* Returns the radius of dataset item in pixel.
*
* @return the radius of dataset item in pixel. Default is {@link UndefinedValues#DOUBLE}.
*/
public double getRadius() {
return getValue(Property.RADIUS, Defaults.get().getGlobal().getElements().getPoint().getRadius());
}
/**
* Returns the style of the dataset item.
*
* @return the style of the dataset item.
*/
public List getPointStyle() {
// checks if the property is an array
if (ObjectType.ARRAY.equals(type(Property.POINT_STYLE))) {
// if array, maps into array
ArrayString array = getArrayValue(Property.POINT_STYLE);
// returns list
return ArrayListHelper.unmodifiableList(PointStyle.values(), array);
} else {
// the property is a string or missing
return Collections.unmodifiableList(Arrays.asList(getValue(Property.POINT_STYLE, PointStyle.values(), Defaults.get().getGlobal().getElements().getPoint().getPointStyle())));
}
}
/**
* Returns the B\u00e9zier curve tension (0 for no B\u00e9zier curves).
*
* @return the B\u00e9zier curve tension (0 for no B\u00e9zier curves).
*/
public double getTension() {
return getValue(Property.TENSION, Defaults.get().getGlobal().getElements().getLine().getTension());
}
/**
* Returns the hit radius.
*
* @return the hit radius.
*/
public double getHitRadius() {
return getValue(Property.HIT_RADIUS, Defaults.get().getGlobal().getElements().getPoint().getHitRadius());
}
/**
* Returns the previous X control point of dataset item in pixel.
*
* @return the previous X control point of dataset item in pixel. Default is {@link UndefinedValues#DOUBLE}.
*/
public double getControlPointPreviousX() {
return getValue(Property.CONTROL_POINT_PREVIOUS_X, UndefinedValues.DOUBLE);
}
/**
* Returns the previous Y control point of dataset item in pixel.
*
* @return the previous Y control point of dataset item in pixel. Default is {@link UndefinedValues#DOUBLE}.
*/
public double getControlPointPreviousY() {
return getValue(Property.CONTROL_POINT_PREVIOUS_Y, UndefinedValues.DOUBLE);
}
/**
* Returns the next X control point of dataset item in pixel.
*
* @return the next X control point of dataset item in pixel. Default is {@link UndefinedValues#DOUBLE}.
*/
public double getControlPointNextX() {
return getValue(Property.CONTROL_POINT_NEXT_X, UndefinedValues.DOUBLE);
}
/**
* Returns the next Y control point of dataset item in pixel.
*
* @return the next Y control point of dataset item in pixel. Default is {@link UndefinedValues#DOUBLE}.
*/
public double getControlPointNextY() {
return getValue(Property.CONTROL_POINT_NEXT_Y, UndefinedValues.DOUBLE);
}
/**
* Returns true if stepped line has been selected.
*
* @return true if stepped line has been selected.
*/
public boolean isSteppedLine() {
return getValue(Property.STEPPED_LINE, Defaults.get().getGlobal().getElements().getLine().isStepped());
}
/**
* Returns the start angle of dataset item.
*
* @return the start angle of dataset item. Default is {@link UndefinedValues#DOUBLE}.
*/
public double getStartAngle() {
return getValue(Property.START_ANGLE, UndefinedValues.DOUBLE);
}
/**
* Returns the end angle of dataset item.
*
* @return the end angle of dataset item. Default is {@link UndefinedValues#DOUBLE}.
*/
public double getEndAngle() {
return getValue(Property.END_ANGLE, UndefinedValues.DOUBLE);
}
/**
* Returns the circumference of dataset item.
*
* @return the circumference of dataset item.
*/
public double getCircumference() {
return getValue(Property.CIRCUMFERENCE, Defaults.get().getGlobal().getCircumference());
}
/**
* Returns the outer radius of dataset item in pixel.
*
* @return the outer radius of dataset item in pixel. Default is {@link UndefinedValues#DOUBLE}.
*/
public double getOuterRadius() {
return getValue(Property.OUTER_RADIUS, UndefinedValues.DOUBLE);
}
/**
* Returns the inner radius of dataset item in pixel.
*
* @return the inner radius of dataset item in pixel. Default is {@link UndefinedValues#DOUBLE}.
*/
public double getInnerRadius() {
return getValue(Property.INNER_RADIUS, UndefinedValues.DOUBLE);
}
}