Merge pull request #182 from xdev-software/scale-rework

Scale rework

Author: AB-xdev

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 2.0.0
+* Scales have been reworked and are now nearly identical to the [types defined in ChartJS](https://github.com/chartjs/Chart.js/blob/v4.4.3/src/types/index.d.ts)
+* The use of ``Color`` for various coloring related options is no longer required. 
+  * It's now possible to use e.g. strings
+
 ## 1.5.0
 * Added ``JsonIgnore`` to certain fields to help prevent infinite loops #174
 * Corrected model for ``Title`` and ``Font`` #175

chartjs-java-model-demo/pom.xml

@@ -6,7 +6,7 @@
 
 	<groupId>software.xdev</groupId>
 	<artifactId>chartjs-java-model-demo</artifactId>
-	<version>1.5.1-SNAPSHOT</version>
+	<version>2.0.0-SNAPSHOT</version>
 	<packaging>jar</packaging>
 
 	<organization>

chartjs-java-model/pom.xml

@@ -6,7 +6,7 @@
 
 	<groupId>software.xdev</groupId>
 	<artifactId>chartjs-java-model</artifactId>
-	<version>1.5.1-SNAPSHOT</version>
+	<version>2.0.0-SNAPSHOT</version>
 	<packaging>jar</packaging>
 
 	<name>chartjs-java-model</name>

chartjs-java-model/src/main/java/software/xdev/chartjs/model/dataset/PointDataset.java

@@ -18,7 +18,6 @@
 import java.util.ArrayList;
 import java.util.List;
 
-import software.xdev.chartjs.model.color.Color;
 import software.xdev.chartjs.model.enums.BorderCapStyle;
 import software.xdev.chartjs.model.enums.BorderJoinStyle;
 import software.xdev.chartjs.model.enums.PointStyle;
@@ -34,11 +33,11 @@ public abstract class PointDataset<T extends Dataset<T, O>, O> extends Dataset<T
 
 	private Float lineTension;
 
-	private Color backgroundColor;
+	private Object backgroundColor;
 
 	private Integer borderWidth;
 
-	private Color borderColor;
+	private Object borderColor;
 
 	private BorderCapStyle borderCapStyle;
 
@@ -48,9 +47,9 @@ public abstract class PointDataset<T extends Dataset<T, O>, O> extends Dataset<T
 
 	private BorderJoinStyle borderJoinStyle;
 
-	private final List<Color> pointBorderColor = new OptionalArray<>();
+	private final List<Object> pointBorderColor = new OptionalArray<>();
 
-	private final List<Color> pointBackgroundColor = new OptionalArray<>();
+	private final List<Object> pointBackgroundColor = new OptionalArray<>();
 
 	private final List<Integer> pointBorderWidth = new OptionalArray<>();
 
@@ -60,9 +59,9 @@ public abstract class PointDataset<T extends Dataset<T, O>, O> extends Dataset<T
 
 	private final List<Integer> pointHitRadius = new OptionalArray<>();
 
-	private final List<Color> pointHoverBackgroundColor = new OptionalArray<>();
+	private final List<Object> pointHoverBackgroundColor = new OptionalArray<>();
 
-	private final List<Color> pointHoverBorderColor = new OptionalArray<>();
+	private final List<Object> pointHoverBorderColor = new OptionalArray<>();
 
 	private final List<Integer> pointHoverBorderWidth = new OptionalArray<>();
 
@@ -117,17 +116,17 @@ public T setLineTension(final Float lineTension)
 	}
 
 	/**
-	 * @see #setBackgroundColor(Color)
+	 * @see #setBackgroundColor(Object)
 	 */
-	public Color getBackgroundColor()
+	public Object getBackgroundColor()
 	{
 		return this.backgroundColor;
 	}
 
 	/**
 	 * The fill color under the line.
 	 */
-	public T setBackgroundColor(final Color backgroundColor)
+	public T setBackgroundColor(final Object backgroundColor)
 	{
 		this.backgroundColor = backgroundColor;
 		return this.self();
@@ -151,17 +150,17 @@ public T setBorderWidth(final Integer borderWidth)
 	}
 
 	/**
-	 * @see #setBorderColor(Color)
+	 * @see #setBorderColor(Object)
 	 */
-	public Color getBorderColor()
+	public Object getBorderColor()
 	{
 		return this.borderColor;
 	}
 
 	/**
 	 * The color of the line.
 	 */
-	public T setBorderColor(final Color borderColor)
+	public T setBorderColor(final Object borderColor)
 	{
 		this.borderColor = borderColor;
 		return this.self();
@@ -275,15 +274,15 @@ public T setBorderJoinStyle(final BorderJoinStyle borderJoinStyle)
 	/**
 	 * @see #setPointBorderColor(List)
 	 */
-	public List<Color> getPointBorderColor()
+	public List<Object> getPointBorderColor()
 	{
 		return this.pointBorderColor;
 	}
 
 	/**
 	 * @see #setPointBorderColor(List)
 	 */
-	public T addPointBorderColor(final Color pointBorderColor)
+	public T addPointBorderColor(final Object pointBorderColor)
 	{
 		this.pointBorderColor.add(pointBorderColor);
 		return this.self();
@@ -292,7 +291,7 @@ public T addPointBorderColor(final Color pointBorderColor)
 	/**
 	 * The border color for points.
 	 */
-	public T setPointBorderColor(final List<Color> pointBorderColor)
+	public T setPointBorderColor(final List<Object> pointBorderColor)
 	{
 		this.pointBorderColor.clear();
 		if(pointBorderColor != null)
@@ -305,15 +304,15 @@ public T setPointBorderColor(final List<Color> pointBorderColor)
 	/**
 	 * @see #setPointBackgroundColor(List)
 	 */
-	public List<Color> getPointBackgroundColor()
+	public List<Object> getPointBackgroundColor()
 	{
 		return this.pointBackgroundColor;
 	}
 
 	/**
 	 * @see #setPointBackgroundColor(List)
 	 */
-	public T addPointBackgroundColor(final Color pointBackgroundColor)
+	public T addPointBackgroundColor(final Object pointBackgroundColor)
 	{
 		this.pointBackgroundColor.add(pointBackgroundColor);
 		return this.self();
@@ -322,7 +321,7 @@ public T addPointBackgroundColor(final Color pointBackgroundColor)
 	/**
 	 * The fill color for points
 	 */
-	public T setPointBackgroundColor(final List<Color> pointBackgroundColor)
+	public T setPointBackgroundColor(final List<Object> pointBackgroundColor)
 	{
 		this.pointBackgroundColor.clear();
 		if(pointBackgroundColor != null)
@@ -455,15 +454,15 @@ public T setPointHitRadius(final List<Integer> pointHitRadius)
 	/**
 	 * @see #setPointHoverBackgroundColor(List)
 	 */
-	public List<Color> getPointHoverBackgroundColor()
+	public List<Object> getPointHoverBackgroundColor()
 	{
 		return this.pointHoverBackgroundColor;
 	}
 
 	/**
 	 * @see #setPointHoverBackgroundColor(List)
 	 */
-	public T addPointHoverBackgroundColor(final Color pointHoverBackgroundColor)
+	public T addPointHoverBackgroundColor(final Object pointHoverBackgroundColor)
 	{
 		this.pointHoverBackgroundColor.add(pointHoverBackgroundColor);
 		return this.self();
@@ -472,7 +471,7 @@ public T addPointHoverBackgroundColor(final Color pointHoverBackgroundColor)
 	/**
 	 * Point background color when hovered
 	 */
-	public T setPointHoverBackgroundColor(final List<Color> pointHoverBackgroundColor)
+	public T setPointHoverBackgroundColor(final List<Object> pointHoverBackgroundColor)
 	{
 		this.pointHoverBackgroundColor.clear();
 		if(pointHoverBackgroundColor != null)
@@ -485,15 +484,15 @@ public T setPointHoverBackgroundColor(final List<Color> pointHoverBackgroundColo
 	/**
 	 * @see #setPointHoverBorderColor(List)
 	 */
-	public List<Color> getPointHoverBorderColor()
+	public List<Object> getPointHoverBorderColor()
 	{
 		return this.pointHoverBorderColor;
 	}
 
 	/**
 	 * @see #setPointHoverBorderColor(List)
 	 */
-	public T addPointHoverBorderColor(final Color pointHoverBorderColor)
+	public T addPointHoverBorderColor(final Object pointHoverBorderColor)
 	{
 		this.pointHoverBorderColor.add(pointHoverBorderColor);
 		return this.self();
@@ -502,7 +501,7 @@ public T addPointHoverBorderColor(final Color pointHoverBorderColor)
 	/**
 	 * Point border color when hovered
 	 */
-	public T setPointHoverBorderColor(final List<Color> pointHoverBorderColor)
+	public T setPointHoverBorderColor(final List<Object> pointHoverBorderColor)
 	{
 		this.pointHoverBorderColor.clear();
 		if(pointHoverBorderColor != null)

chartjs-java-model/src/main/java/software/xdev/chartjs/model/options/scales/Font.java renamed to chartjs-java-model/src/main/java/software/xdev/chartjs/model/options/Font.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package software.xdev.chartjs.model.options.scales;
+package software.xdev.chartjs.model.options;
 
 import software.xdev.chartjs.model.enums.FontStyle;
 

chartjs-java-model/src/main/java/software/xdev/chartjs/model/options/LegendLabels.java

@@ -15,7 +15,6 @@
  */
 package software.xdev.chartjs.model.options;
 
-import software.xdev.chartjs.model.color.Color;
 import software.xdev.chartjs.model.enums.FontStyle;
 import software.xdev.chartjs.model.javascript.JavaScriptFunction;
 
@@ -25,7 +24,7 @@ public class LegendLabels
 	protected Integer boxWidth;
 	protected Integer fontSize;
 	protected FontStyle fontStyle;
-	protected Color fontColor;
+	protected Object fontColor;
 	protected String fontFamily;
 	protected Integer padding;
 	protected JavaScriptFunction generateLabels;
@@ -101,9 +100,9 @@ public LegendLabels setFontStyle(final FontStyle fontStyle)
 	}
 
 	/**
-	 * @see #setFontColor(Color)
+	 * @see #setFontColor(Object)
 	 */
-	public Color getFontColor()
+	public Object getFontColor()
 	{
 		return this.fontColor;
 	}
@@ -117,7 +116,7 @@ public Color getFontColor()
 	 * Default {@code "#666"}
 	 * </p>
 	 */
-	public LegendLabels setFontColor(final Color fontColor)
+	public LegendLabels setFontColor(final Object fontColor)
 	{
 		this.fontColor = fontColor;
 		return this;

chartjs-java-model/src/main/java/software/xdev/chartjs/model/options/LegendTitle.java

@@ -15,23 +15,21 @@
  */
 package software.xdev.chartjs.model.options;
 
-import software.xdev.chartjs.model.color.Color;
 import software.xdev.chartjs.model.options.layout.Padding;
-import software.xdev.chartjs.model.options.scales.Font;
 
 
 public class LegendTitle
 {
-	protected Color color;
+	protected Object color;
 	protected Boolean display;
 	protected Font font;
 	protected Padding padding;
 	protected String text;
 
 	/**
-	 * @see #setColor(Color)
+	 * @see #setColor(Object)
 	 */
-	public Color getColor()
+	public Object getColor()
 	{
 		return this.color;
 	}
@@ -41,7 +39,7 @@ public Color getColor()
 	 * <p/>
 	 * Color of text
 	 */
-	public LegendTitle setColor(final Color color)
+	public LegendTitle setColor(final Object color)
 	{
 		this.color = color;
 		return this;

chartjs-java-model/src/main/java/software/xdev/chartjs/model/options/Options.java

@@ -23,7 +23,7 @@
 import software.xdev.chartjs.model.options.animation.Animation;
 import software.xdev.chartjs.model.options.animation.Animations;
 import software.xdev.chartjs.model.options.layout.Layout;
-import software.xdev.chartjs.model.options.scales.Scales;
+import software.xdev.chartjs.model.options.scale.Scales;
 
 
 public class Options<T extends Options<T, A>, A extends Animation<A>>

chartjs-java-model/src/main/java/software/xdev/chartjs/model/options/PolarOptions.java

@@ -17,42 +17,40 @@
 
 import software.xdev.chartjs.model.options.animation.PolarAnimation;
 import software.xdev.chartjs.model.options.elements.ArcElements;
-import software.xdev.chartjs.model.options.scales.RadialLinearScale;
-import software.xdev.chartjs.model.options.scales.Scale;
+import software.xdev.chartjs.model.options.scale.radial.RadialLinearScaleOptions;
 
 
 public class PolarOptions extends Options<PolarOptions, PolarAnimation>
 {
-	
 	/**
-	 * @see #setScale(RadialLinearScale scale)
+	 * @see #setScale(RadialLinearScaleOptions scale)
 	 */
-	protected RadialLinearScale<?> scale;
+	protected RadialLinearScaleOptions scale;
 
 	protected ArcElements elements;
 
 	/**
-	 * Static factory, constructs a {@link Scale} implementation appropriate for a {@link PolarOptions} instance.
+	 * Static factory, constructs a Scale implementation appropriate for a {@link PolarOptions} instance.
 	 *
-	 * @return a new {@link RadialLinearScale} instance
+	 * @return a new {@link RadialLinearScaleOptions} instance
 	 */
-	public static RadialLinearScale scales()
+	public static RadialLinearScaleOptions scales()
 	{
-		return new RadialLinearScale<>();
+		return new RadialLinearScaleOptions();
 	}
 
 	/**
-	 * @see #setScale(RadialLinearScale)
+	 * @see #setScale(RadialLinearScaleOptions)
 	 */
-	public RadialLinearScale getScale()
+	public RadialLinearScaleOptions getScale()
 	{
 		return this.scale;
 	}
 
 	/**
 	 * Options for the one scale used on the chart. Use this to style the ticks, labels, and grid.
 	 */
-	public PolarOptions setScale(final RadialLinearScale<?> scale)
+	public PolarOptions setScale(final RadialLinearScaleOptions scale)
 	{
 		this.scale = scale;
 		return this;