org.pepstock.charba.client.configuration.CartesianAxis 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
/**
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.configuration;
import org.pepstock.charba.client.IsChart;
import org.pepstock.charba.client.commons.Checker;
import org.pepstock.charba.client.enums.AxisKind;
import org.pepstock.charba.client.enums.AxisPosition;
import org.pepstock.charba.client.enums.AxisType;
import org.pepstock.charba.client.enums.Bounds;
import org.pepstock.charba.client.enums.DefaultScaleId;
import org.pepstock.charba.client.options.ScaleId;
/**
* Axes are an integral part of a chart. They are used to determine how data maps to a pixel value on the chart.
* In a cartesian chart, there is 1 or more X axis and 1 or more Y axis to map points onto the 2 dimensional canvas.
* These axes are know as 'cartesian axes'.
* Axes that follow a cartesian grid are known as 'Cartesian Axes'.
* Cartesian axes are used for line, bar, and bubble charts.
* Four cartesian axes are included by default.
*
* - linear
*
- logarithmic
*
- category
*
- time
*
*
* @author Andrea "Stock" Stocchero
*
* @param type of tick to apply to axis
*/
public abstract class CartesianAxis extends Axis {
private final Grid grid;
private final CartesianScaleTitle title;
/**
* Builds the object storing the chart instance and cartesian axis type.
*
* @param chart chart instance
* @param id axis id
* @param type axis type
* @param kind axis kind
*/
CartesianAxis(IsChart chart, ScaleId id, AxisType type, AxisKind kind) {
super(chart, id, type, kind);
// checks if scale id of scale is consistent
// used for cartesian, it must not be set to unknown
Checker.assertCheck(!DefaultScaleId.UNKNOWN.is(id.value()), "The scale id is invalid. It must not be " + id.value());
// checks if axis kind of scale is consistent
// used for cartesian, it must not be set to R
Checker.assertCheck(!AxisKind.R.equals(kind), "The axis kind is invalid. It must not be " + AxisKind.R.value());
// sets to the objects
grid = new Grid(this);
title = new CartesianScaleTitle(this);
}
/**
* Returns the scale title element
*
* @return the scale title element
*/
public CartesianScaleTitle getTitle() {
return title;
}
/**
* Returns the ticks element
*
* @return the ticks
*/
public abstract T getTicks();
/**
* Returns the grid element
*
* @return the grid
*/
public Grid getGrid() {
return grid;
}
/**
* Sets if the axis are stacked or not.
*
* @param stacked if the axis are stacked or not.
*/
public void setStacked(boolean stacked) {
getScale().setStacked(stacked);
}
/**
* Gets if the axis are stacked or not.
*
* @return if the axis are stacked or not.
*/
public boolean isStacked() {
return getScale().isStacked();
}
/**
* Sets if you might want to stack positive and negative values together.
*
* @param stacked if you might want to stack positive and negative values together
*/
public void setSingleStacked(boolean stacked) {
getScale().setSingleStacked(stacked);
}
/**
* Returns if you might want to stack positive and negative values together.
*
* @return if you might want to stack positive and negative values together
*/
public boolean isSingleStacked() {
return getScale().isSingleStacked();
}
/**
* If true, extra space is added to the both edges and the axis is scaled to fit in the the chart area.
* This is set to true in the bar chart by default.
*
* @param offset extra space of axis
*/
public void setOffset(boolean offset) {
getScale().setOffset(offset);
}
/**
* If true, extra space is added to the both edges and the axis is scaled to fit in the the chart area.
* This is set to true in the bar chart by default.
*
* @return extra space of axis.
*/
public boolean isOffset() {
return getScale().isOffset();
}
/**
* An axis can either be positioned at the edge of the chart, at the center of the chart area, or dynamically with respect to a data value.
* To position the axis at the edge of the chart, set the position option to one of: 'top', 'left', 'bottom', 'right'.
* To position the axis at the center of the chart area, set the position option to 'center'.
*
* @param position position of axis
*/
public void setPosition(AxisPosition position) {
getScale().setPosition(position);
}
/**
* An axis can either be positioned at the edge of the chart, at the center of the chart area, or dynamically with respect to a data value.
* To position the axis at the edge of the chart, set the position option to one of: 'top', 'left', 'bottom', 'right'.
* To position the axis at the center of the chart area, set the position option to 'center'.
*
* @return position of axis.
*/
public AxisPosition getPosition() {
return getScale().getPosition();
}
/**
* Sets the property controls the scale boundary strategy (bypassed by min/max time options).
*
* @param bounds property controls the scale boundary strategy (bypassed by min/max time options).
*/
public void setBounds(Bounds bounds) {
getScale().setBounds(bounds);
}
/**
* Returns the property controls the scale boundary strategy (bypassed by min/max time options).
*
* @return property controls the scale boundary strategy (bypassed by min/max time options).
*/
public Bounds getBounds() {
return getScale().getBounds();
}
}