ChartOptionsImpl.java

  1. /*
  2.  * Copyright 2010-2025 James Pether Sörling
  3.  *
  4.  * Licensed under the Apache License, Version 2.0 (the "License");
  5.  * you may not use this file except in compliance with the License.
  6.  * You may obtain a copy of the License at
  7.  *
  8.  *   http://www.apache.org/licenses/LICENSE-2.0
  9.  *
  10.  * Unless required by applicable law or agreed to in writing, software
  11.  * distributed under the License is distributed on an "AS IS" BASIS,
  12.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13.  * See the License for the specific language governing permissions and
  14.  * limitations under the License.
  15.  *
  16.  *  $Id$
  17.  *  $HeadURL$
  18.  */
  19. package com.hack23.cia.web.impl.ui.application.views.common.chartfactory.impl;

  21. import org.dussan.vaadin.dcharts.base.elements.XYaxis;
  22. import org.dussan.vaadin.dcharts.metadata.DataLabels;
  23. import org.dussan.vaadin.dcharts.metadata.LegendPlacements;
  24. import org.dussan.vaadin.dcharts.metadata.SeriesToggles;
  25. import org.dussan.vaadin.dcharts.metadata.TooltipAxes;
  26. import org.dussan.vaadin.dcharts.metadata.XYaxes;
  27. import org.dussan.vaadin.dcharts.metadata.locations.LegendLocations;
  28. import org.dussan.vaadin.dcharts.metadata.locations.TooltipLocations;
  29. import org.dussan.vaadin.dcharts.metadata.renderers.AxisRenderers;
  30. import org.dussan.vaadin.dcharts.metadata.renderers.LegendRenderers;
  31. import org.dussan.vaadin.dcharts.metadata.renderers.SeriesRenderers;
  32. import org.dussan.vaadin.dcharts.options.Axes;
  33. import org.dussan.vaadin.dcharts.options.Cursor;
  34. import org.dussan.vaadin.dcharts.options.Grid;
  35. import org.dussan.vaadin.dcharts.options.Highlighter;
  36. import org.dussan.vaadin.dcharts.options.Legend;
  37. import org.dussan.vaadin.dcharts.options.Options;
  38. import org.dussan.vaadin.dcharts.options.Series;
  39. import org.dussan.vaadin.dcharts.options.SeriesDefaults;
  40. import org.dussan.vaadin.dcharts.renderers.legend.EnhancedLegendRenderer;
  41. import org.dussan.vaadin.dcharts.renderers.series.DonutRenderer;
  42. import org.dussan.vaadin.dcharts.renderers.series.PieRenderer;
  43. import org.dussan.vaadin.dcharts.renderers.tick.AxisTickRenderer;
  44. import org.springframework.stereotype.Component;

  46. import com.hack23.cia.web.impl.ui.application.views.common.chartfactory.api.ChartOptions;

  48. /**
  49.  * The Class ChartOptionsImpl.
  50.  */
  51. @Component
  52. public final class ChartOptionsImpl implements ChartOptions {

  54.     /** The Constant BACKGROUND_COLOR. */
  55.     private static final String BACKGROUND_COLOR = "#13303f";

  57.     /** The Constant BORDER_COLOR. */
  58.     private static final String BORDER_COLOR = "#83898c";

  60.     /** The Constant FLOAT_FORMAT. */
  61.     private static final String FLOAT_FORMAT = "%.2f";

  63.     /** The Constant FONT_FAMILY. */
  64.     private static final String FONT_FAMILY = "Arial";

  66.     /** The Constant FONT_SIZE. */
  67.     private static final String FONT_SIZE = "8px";

  69.     /** The Constant GRIDLINE_COLOR. */
  70.     private static final String GRIDLINE_COLOR = "#213f49";

  72.     /** The Constant LEGEND_COLUMNS. */
  73.     private static final int LEGEND_COLUMNS = 3;

  75.     /** The Constant LEGEND_FONT_SIZE. */
  76.     private static final String LEGEND_FONT_SIZE = "10px";

  78.     /** The Constant LEGEND_ROWS. */
  79.     private static final int LEGEND_ROWS = 20;

  81.     /** The Constant NUMBER_TICKS. */
  82.     private static final int NUMBER_TICKS = 5;

  84.     /** The Constant NUMBER_TICKS_DATE. */
  85.     public static final int NUMBER_TICKS_DATE = 8;

  87.     /** The Constant ONE_COLUMN_NUMBER_OF_COLUMNS. */
  88.     private static final int ONE_COLUMN_NUMBER_OF_COLUMNS = 1;

  90.     /** The Constant ONE_COLUMN_NUMBER_OF_ROWS. */
  91.     private static final int ONE_COLUMN_NUMBER_OF_ROWS = 12;

  93.     /** The Constant ONE_ROW_NUMBER_OF_COLUMNS. */
  94.     private static final int ONE_ROW_NUMBER_OF_COLUMNS = 10;

  96.     /** The Constant ONE_ROW_NUMBER_OF_ROWS. */
  97.     private static final int ONE_ROW_NUMBER_OF_ROWS = 1;

  99.     /** The Constant SLICE_MARGIN. */
  100.     private static final int SLICE_MARGIN = 3;

  102.     /** The Constant START_ANGLE. */
  103.     private static final int START_ANGLE = -90;

  105.     /** The Constant TEXT_COLOR. */
  106.     private static final String TEXT_COLOR = "#ffffff";

  108.     /** The Constant YEAR_MONTH_DAY_FORMAT. */
  109.     public static final String YEAR_MONTH_DAY_FORMAT = "%F";

  111.     /**
  112.      * Instantiates a new chart options impl.
  113.      */
  114.     private ChartOptionsImpl() {
  115.         super();
  116.     }

  118.     /**
  119.      * Creates the axes XY date float.
  120.      *
  121.      * @return the axes
  122.      */
  123.     private static Axes createAxesXYDateFloat() {
  124.         return new Axes()
  125.                 .addAxis(new XYaxis().setRenderer(AxisRenderers.DATE)
  126.                         .setTickOptions(new AxisTickRenderer().setFormatString(YEAR_MONTH_DAY_FORMAT).setFontFamily(FONT_FAMILY).setTextColor(TEXT_COLOR).setFontSize(FONT_SIZE))
  127.                         .setNumberTicks(NUMBER_TICKS_DATE))
  128.                 .addAxis(new XYaxis(XYaxes.Y).setRenderer(AxisRenderers.LINEAR).setTickOptions(new AxisTickRenderer().setFormatString(FLOAT_FORMAT).setFontFamily(FONT_FAMILY).setTextColor(TEXT_COLOR).setFontSize(FONT_SIZE)).setNumberTicks(NUMBER_TICKS));
  129.     }

  131.     /**
  132.      * Creates the axes XY date float log.
  133.      *
  134.      * @return the axes
  135.      */
  136.     private static Axes createAxesXYDateFloatLog() {
  137.         return new Axes()
  138.                 .addAxis(new XYaxis().setRenderer(AxisRenderers.DATE)
  139.                         .setTickOptions(new AxisTickRenderer().setFormatString(YEAR_MONTH_DAY_FORMAT).setFontFamily(FONT_FAMILY).setTextColor(TEXT_COLOR).setFontSize(FONT_SIZE))
  140.                         .setNumberTicks(NUMBER_TICKS_DATE))
  141.                 .addAxis(new XYaxis(XYaxes.Y).setRenderer(AxisRenderers.LOG).setTickOptions(new AxisTickRenderer().setFormatString(FLOAT_FORMAT).setFontFamily(FONT_FAMILY).setTextColor(TEXT_COLOR).setFontSize(FONT_SIZE)).setNumberTicks(NUMBER_TICKS));
  142.     }


  145.     /**
  146.      * Creates the cursor.
  147.      *
  148.      * @return the cursor
  149.      */
  150.     private static Cursor createCursor() {
  151.         return new Cursor().setZoom(true).setLooseZoom(true).setShow(true);
  152.     }

  154.     /**
  155.      * Creates the default grid.
  156.      *
  157.      * @return the grid
  158.      */
  159.     private static Grid createDefaultGrid() {
  160.         final Grid grid = new Grid();
  161.         grid.setBackground(BACKGROUND_COLOR);
  162.         grid.setGridLineColor(GRIDLINE_COLOR);
  163.         grid.setBorderColor(BORDER_COLOR);
  164.         return grid;
  165.     }

  167.     /**
  168.      * Created legend enhanced inside north west.
  169.      *
  170.      * @return the legend
  171.      */
  172.     private static Legend createdLegendEnhancedInsideNorthWest() {
  173.         return setLegendStyling(new Legend().setShow(true)
  174.                 .setRendererOptions(
  175.                         new EnhancedLegendRenderer().setSeriesToggle(SeriesToggles.NORMAL).setSeriesToggleReplot(true).setNumberColumns(LEGEND_COLUMNS).setNumberRows(LEGEND_ROWS))
  176.                 .setPlacement(LegendPlacements.INSIDE_GRID).setLocation(LegendLocations.NORTH_WEST));
  177.     }

  179.     /**
  180.      * Created legend enhanced inside west.
  181.      *
  182.      * @return the legend
  183.      */
  184.     private static Legend createdLegendEnhancedInsideWest() {
  185.         return setLegendStyling(
  186.                 new Legend().setShow(true).setPlacement(LegendPlacements.INSIDE_GRID).setLocation(LegendLocations.WEST)
  187.                         .setRenderer(LegendRenderers.ENHANCED).setRendererOptions(new EnhancedLegendRenderer()
  188.                                 .setSeriesToggle(SeriesToggles.NORMAL).setSeriesToggleReplot(true).setNumberColumns(LEGEND_COLUMNS).setNumberRows(LEGEND_ROWS)));
  189.     }

  191.     /**
  192.      * Creates the donout series default.
  193.      *
  194.      * @return the series defaults
  195.      */
  196.     private static SeriesDefaults createDonoutSeriesDefault() {
  197.         return new SeriesDefaults().setRenderer(SeriesRenderers.DONUT)
  198.                 .setRendererOptions(new DonutRenderer().setSliceMargin(SLICE_MARGIN).setStartAngle(START_ANGLE).setShowDataLabels(true)
  199.                         .setDataLabels(DataLabels.VALUE));
  200.     }

  202.     /**
  203.      * Creates the high lighter.
  204.      *
  205.      * @return the highlighter
  206.      */
  207.     private static Highlighter createHighLighter() {
  208.         return new Highlighter().setShow(true).setShowTooltip(true).setTooltipAlwaysVisible(true)
  209.                 .setKeepTooltipInsideChart(true);
  210.     }

  212.     /**
  213.      * Creates the high lighter north.
  214.      *
  215.      * @return the highlighter
  216.      */
  217.     private static Highlighter createHighLighterNorth() {
  218.         return new Highlighter().setShow(true).setShowTooltip(true).setTooltipAlwaysVisible(true)
  219.                 .setKeepTooltipInsideChart(true).setTooltipLocation(TooltipLocations.NORTH)
  220.                 .setTooltipAxes(TooltipAxes.XY_BAR).setShowMarker(true).setBringSeriesToFront(true);
  221.     }

  223.     /**
  224.      * Creates the legend outside.
  225.      *
  226.      * @return the legend
  227.      */
  228.     private static Legend createLegendInsideOneRow() {
  229.         return setLegendStyling(new Legend().setShow(true)
  230.                 .setRendererOptions(
  231.                         new EnhancedLegendRenderer().setSeriesToggle(SeriesToggles.NORMAL).setSeriesToggleReplot(true).setNumberColumns(ONE_ROW_NUMBER_OF_COLUMNS).setNumberRows(ONE_ROW_NUMBER_OF_ROWS))
  232.                 .setPlacement(LegendPlacements.INSIDE_GRID));
  233.     }

  235.     /**
  236.      * Creates the legend outside.
  237.      *
  238.      * @return the legend
  239.      */
  240.     private static Legend createLegendOutside() {
  241.         return setLegendStyling(new Legend().setShow(true)
  242.                 .setRendererOptions(
  243.                         new EnhancedLegendRenderer().setSeriesToggle(SeriesToggles.NORMAL).setSeriesToggleReplot(true).setNumberColumns(LEGEND_COLUMNS).setNumberRows(LEGEND_ROWS))
  244.                 .setPlacement(LegendPlacements.OUTSIDE_GRID));
  245.     }

  247.     /**
  248.      * Creates the legend outside one column.
  249.      *
  250.      * @return the legend
  251.      */
  252.     private static Legend createLegendOutsideOneColumn() {
  253.         return setLegendStyling(new Legend().setShow(true)
  254.                 .setRendererOptions(
  255.                         new EnhancedLegendRenderer().setSeriesToggle(SeriesToggles.NORMAL).setSeriesToggleReplot(true).setNumberColumns(ONE_COLUMN_NUMBER_OF_COLUMNS).setNumberRows(ONE_COLUMN_NUMBER_OF_ROWS))
  256.                 .setPlacement(LegendPlacements.OUTSIDE_GRID));
  257.     }


  260.     /**
  261.      * Creates the series default pie chart.
  262.      *
  263.      * @return the series defaults
  264.      */
  265.     private static SeriesDefaults createSeriesDefaultPieChart() {
  266.         return new SeriesDefaults().setRenderer(SeriesRenderers.PIE)
  267.                 .setRendererOptions(new PieRenderer().setShowDataLabels(true)).setShadow(true);
  268.     }

  270.     /**
  271.      * Sets the legend styling.
  272.      *
  273.      * @param legend
  274.      *            the legend
  275.      * @return the legend
  276.      */
  277.     private static Legend setLegendStyling(final Legend legend) {
  278.         legend.setBackground(BACKGROUND_COLOR).setFontFamily(FONT_FAMILY).setTextColor(TEXT_COLOR).setFontSize(LEGEND_FONT_SIZE);
  279.         return legend;
  280.     }

  282.     /**
  283.      * Creates the options country line chart.
  284.      *
  285.      * @param chartSeries the chart series
  286.      * @return the options
  287.      */
  288.     @Override
  289.     public Options createOptionsCountryLineChart(final Series chartSeries) {
  290.         final Axes chartAxes = new Axes().addAxis(new XYaxis().setRenderer(AxisRenderers.DATE)
  291.                 .setTickOptions(new AxisTickRenderer().setFormatString(YEAR_MONTH_DAY_FORMAT).setFontFamily(FONT_FAMILY).setTextColor(TEXT_COLOR).setFontSize(FONT_SIZE))
  292.                 .setNumberTicks(NUMBER_TICKS_DATE)).addAxis(new XYaxis(XYaxes.Y).setTickOptions(new AxisTickRenderer().setFontFamily(FONT_FAMILY).setTextColor(TEXT_COLOR).setFontSize(FONT_SIZE)).setNumberTicks(NUMBER_TICKS));

  294.         return new Options().addOption(new SeriesDefaults()).addOption(chartAxes)
  295.                 .addOption(createHighLighterNorth()).addOption(chartSeries).addOption(createLegendInsideOneRow())
  296.                 .addOption(createDefaultGrid()).addOption(createCursor());
  297.     }

  299.     /**
  300.      * Creates the options donout chart.
  301.      *
  302.      * @return the options
  303.      */
  304.     @Override
  305.     public Options createOptionsDonoutChart() {
  306.         return new Options().setSeriesDefaults(createDonoutSeriesDefault()).setLegend(createdLegendEnhancedInsideNorthWest())
  307.                 .setHighlighter(createHighLighter()).addOption(createDefaultGrid()).addOption(createCursor());
  308.     }

  310.     /**
  311.      * Creates the options donout chart with series.
  312.      *
  313.      * @param chartSeries the chart series
  314.      * @return the options
  315.      */
  316.     @Override
  317.     public Options createOptionsDonoutChartWithSeries(final Series chartSeries) {
  318.         return new Options().setSeriesDefaults(createDonoutSeriesDefault()).setLegend(createdLegendEnhancedInsideNorthWest())
  319.                 .setHighlighter(createHighLighter()).addOption(chartSeries).addOption(createDefaultGrid()).addOption(createCursor());
  320.     }

  322.     /**
  323.      * Creates the options party line chart.
  324.      *
  325.      * @param chartSeries the chart series
  326.      * @return the options
  327.      */
  328.     @Override
  329.     public Options createOptionsPartyLineChart(final Series chartSeries) {
  330.         return new Options().addOption(new SeriesDefaults()).addOption(createAxesXYDateFloat())
  331.                 .addOption(createHighLighterNorth()).addOption(createCursor()).addOption(chartSeries)
  332.                 .addOption(createLegendOutside()).addOption(createDefaultGrid());
  333.     }

  335.     /**
  336.      * Creates the options person line chart.
  337.      *
  338.      * @param chartSeries the chart series
  339.      * @return the options
  340.      */
  341.     @Override
  342.     public Options createOptionsPersonLineChart(final Series chartSeries) {
  343.         return new Options().addOption(new SeriesDefaults()).addOption(createAxesXYDateFloat())
  344.                 .addOption(createHighLighterNorth()).addOption(createCursor()).addOption(chartSeries)
  345.                 .addOption(createLegendOutside()).addOption(createDefaultGrid());
  346.     }

  348.     /**
  349.      * Creates the options pie chart.
  350.      *
  351.      * @return the options
  352.      */
  353.     @Override
  354.     public Options createOptionsPieChart() {
  355.         return new Options().setSeriesDefaults(createSeriesDefaultPieChart())
  356.                 .setLegend(createdLegendEnhancedInsideWest()).setHighlighter(createHighLighter())
  357.                 .addOption(createDefaultGrid()).addOption(createCursor());
  358.     }

  360.     /**
  361.      * Creates the options XY date float legend inside one column.
  362.      *
  363.      * @param chartSeries the chart series
  364.      * @return the options
  365.      */
  366.     @Override
  367.     public Options createOptionsXYDateFloatLegendInsideOneColumn(final Series chartSeries) {
  368.         return new Options().addOption(new SeriesDefaults()).addOption(createAxesXYDateFloat())
  369.                 .addOption(createHighLighterNorth()).addOption(chartSeries).addOption(createLegendOutsideOneColumn())
  370.                 .addOption(createDefaultGrid()).addOption(createCursor());
  371.     }

  373.     /**
  374.      * Creates the options XY date float log Y axis legend outside.
  375.      *
  376.      * @param chartSeries the chart series
  377.      * @return the options
  378.      */
  379.     @Override
  380.     public Options createOptionsXYDateFloatLogYAxisLegendOutside(final Series chartSeries) {
  381.         return new Options().addOption(new SeriesDefaults()).addOption(chartSeries).addOption(createAxesXYDateFloatLog())
  382.                 .addOption(createHighLighterNorth()).addOption(createLegendOutside())
  383.                 .addOption(createDefaultGrid()).addOption(createCursor());
  384.     }

  386. }
Created with JaCoCo 0.8.12.202403310830