HyJavaApex Full Documentation

the java api for apexcharts

OVERVIEW

The HyJavaApex Java library is a pure Java wrapper for the ApexCharts Javascript library.
It allows your Java-based web applications to configure ApexCharts charts using only Java methods. There is no need to write any Javascript.
The library will generate the required Javascript code that ApexCharts needs to render the charts.

The Apexchart class is the starting point for all charts.

To define the contents of a chart, you simply have to instantiate the Apexchart class and use its setter methods to define the chart options and chart data as required. For details on the effects of each chart option refer to the ApexCharts API reference. The naming of the chart options in the HyJavaApex library in most cases exactly follows the ApexCharts Javascript API.

In the example below we are defining a bar chart.
Instantiate the Apexchart class and then get a reference to ChartOptions. You then set the chart options as required.

public class YourBarChart {

    public Apexchart configure() {
        Apexchart apexchart = new Apexchart();
        ChartOptions chartOptions = apexchart.getChartOptions();

        chartOptions.getChart().setHeight(450).setType(ChartType.BAR);
        chartOptions.getPlotOptions().getBar().setHorizontal(true);
        chartOptions.getDataLabels().setEnabled(false);

        set all your required chart options......

        return apexchart;
    }

}

JAVADOC API

In most cases the HyJavaApex API exactly matches the ApexCharts API. There is no need to learn another API. The HyJavaApex API can be viewed online or refer to the API jar provided in the product download.

DEMO WEB APPLICATION

To give you a kick start using the library, the demo web application provides thorough examples of more than 60 different charts including Java source code for each example. Most of the ApexCharts Demos from the ApexCharts Demos page are included in this application.
The Java source code for the demo application including all chart examples is available from the Other Downloads page.

HOW TO USE THE LIBRARY

Java

Include the HyJavaApex jar in your project.

Configure your chart and generate the Javascript code for the chart options.

Apexchart apexchart = new YourBarChart().configure();
String chartOptionsJs = apexchart.chartOptionsToJs();


The YourBarChart class will look something like this:

public class YourBarChart {

    public Apexchart configure() {
        Apexchart apexchart = new Apexchart();
        ChartOptions chartOptions = apexchart.getChartOptions();

        chartOptions.getChart().setHeight(450).setType(ChartType.BAR);
        chartOptions.getPlotOptions().getBar().setHorizontal(true);
        chartOptions.getDataLabels().setEnabled(false);

        set all your required chart options......

        return apexchart;
    }

}
Javascript

Include required Javascript on your page as per ApexCharts documentation.

var chart = new ApexCharts(document.querySelector("#chart"), ${chartOptionsJs});
chart.render();

Your Java code will pass the chartOptionsJs strings to the markup variable ${chartOptionsJs}.
The method used to pass the generated chart options from the java to the web page will vary depending on your java web framework. (Refer to Java Web Frameworks below).

Web Page

Your markup will look something like this:

<script src="https://cdn.jsdelivr.net/npm/apexcharts"></script>

<div id="chart" style="max-width: 650px; margin: 35px auto; height: 800px;"></div>

<script>
var chart = new ApexCharts(document.querySelector("#chart"), ${chartOptionsJs});
chart.render();
</script>


That is all that is required to get a working Bar chart example.

MAIN LIBRARY CLASSES

ChartOptions Class

The ChartOptions class maps directly to the ApexCharts chart options in the ApexCharts API.
All ApexCharts chart options will be configured using setter methods on this class.

Apexchart Class

The Apexchart class wraps ChartOptions classes into one convenient class to make usage as simple as possible.
This class handles chart theming; the setting of chart options; generates Javascript for ChartOptions.
All ApexCharts chart options can be configured by getting a reference to ChartOptions from this class via getChartOptions().
Usage of the Apexchart class has been described in examples above.

ApexchartRenderer Class

The HyJavaApex library performance is extremely fast right out of the box.
In cases where thousands of charts are generated, for example batch processes, some improvements can be found using ApexchartRenderer.toJs(…) rather than the Apexchart.chartOptionsToJs().
Instantiate the ApexchartRenderer class once and then use it to generate the chart options Javascript for multiple charts.
Note that there are no improvements when generating single charts.

JAVA WEB FRAMEWORKS

The HyJavaApex library is a pure Java library so can be used by any Java web framework.

As long as your framework can add the generated Javascript chart options to your markup at page build time then you can use this library.
Most (if not all) Java web frameworks will offer some method of adding javascript to a page.

We have included several example applications showing usage of the HyJavaApex library with various frameworks. These include:-

  • a Spring MVC demo web application;
  • a JSF demo web application;
  • a Struts2 demo web application;
  • a GWT demo web application;
  • a basic servlet demo web application;
  • a JSP servlet demo web application;
  • a Wicket demo web application;
  • a Vaadin framework 8 demo web application;
  • a Vaadin platform (14+) demo web application;
  • a JavaFX demo application;
  • a Java Swing demo application.

  • The Java source code for these example applications is available from the Other Downloads page.

    OPTIONS WITH MULTIPLE DATA TYPES

    Where a chart option has more than one data type, eg. Number and String the Java API will include one method per type.
    Setter methods will be overloaded. Getter methods will include a suffix.

    chartOptions.getChart().setWidth(25);
    chartOptions.getChart().setWidth("50%");
    
    chartOptions.getChart().getWidthAsNumber();
    chartOptions.getChart().getWidthAsString();

    MAIN OPTION DATA TYPES

    Color Class

    To set a color string value use: new Color(“#55BF3B”); or new Color().setColor(“#55BF3B”);
    To set a javascript color value use: new Color().setColorValue(“jsvalue”);
    To set a RGB color value use: new Color(255, 255, 255); or new Color().setRGB(255, 255, 255);
    To set a RGBA color value use: new Color(255, 255, 255, 0.5); or new Color().setRGBA(255, 255, 255, 0.5);
    140 Web color code strings are also defined in this class. Eg. new Color(Color.ALICEBLUE).

    Function Class

    To set the body of a Function use: new Function(“functionbodystring”); or new Function().setFunctionBody(“functionbodystring”);
    To add parameters to the function use: new Function(“functionbodystring”, “parameter”); or addParameter(“parameter”);

    General Class

    To set a javascript value use: new General(“jsvalue”); or new General().setJsValue(“jsValue”);

    ARRAYS

    There are methods for each chart option array to help simplify usage where there is only 1 element in the array.
    In the example the getYaxisSingle() method will add a new Yaxis object to the yaxis array and operate on that object.

    Yaxis yaxis = new Yaxis();
    yaxis.setReversed(true);
    chartOptions.getYaxis().add(yaxis);
       OR
    chartOptions.getYaxisSingle().setReversed(true);

    THEMES

    If your Java code uses the chartOptions.getColors() method you will also need to set the Theme in your Java prior to calling the method.
    eg. apexchart.setTheme(ApexchartTheme.DEFAULT);

    If you have created your own theme you will need to create a Theme class as follows:
    (1) create a new theme class implementing Theme.
    (2) add the method getColors() to the class returning your theme colors.

    public class YourNewTheme implements Theme {
      public List<Color> getColors() {
       return new ArrayList(Arrays.asList(
         new Color(Color.LIGHTSKYBLUE), new Color(Color.LIGHTGREEN), new Color(Color.LIGHTSALMON), 
         new Color(Color.LIGHTCORAL), new Color(Color.LIGHTSTEELBLUE), new Color(Color.LIGHTGRAY),
         new Color(Color.LIGHTPINK), new Color(Color.LIGHTSEAGREEN), new Color(Color.LIGHTCYAN),
         new Color(Color.LIGHTBLUE), new Color(Color.LIGHTYELLOW), new Color(Color.LIGHTSLATEGRAY)
         ));
       }
     }


    You can also use color strings ie. new Color(“#87cefa”).
    To use the theme: apexchart.setTheme(new YourNewTheme());

    CHART DATA SOURCES

    Chart data sources can be databases, web services, files or any resource your application server has access to.

    JAVA VERSION

    The HyJavaApex library requires Java 8 or greater. There are no external dependencies.

    API ISSUES

    Every endeavor has been made to ensure the HyJavaApex Java API matches the Highcharts javascript API.
    Please contact us if there is a chart option missing from the Java API or if an option data type does not match the Highcharts API.
    We will publish an updated API as soon as possible.

    Generic Chart Options

    To allow the developer to continue until the Java API is updated, generic options that can have any property name and value are available on every ApexChart model class.
    eg. If an option “allowAnimation” Boolean was missing from Chart in the API or the data type is incorrect you can still include the option as shown below.

    chartOptions.getChart().get_genericOption()
        .add(new GenericOption("allowAnimation", "true"));
    OR
    chartOptions.getChart().get_genericOption()
        .add(new GenericOption()
            .setPropertyName("allowAnimation")
            .setPropertyValue("true"));

    SUPPORT

    For any questions or issues on the HyJavaApex API please contact our support team via the “Contact Us” area on the home page.
    Please refer to the ApexCharts API for usage of each chart option or contact ApexCharts for support of the ApexCharts product.

    The Java API’s fully support all chart types and chart options in Highcharts v5.x, v6.x, v7.x, v8.x;  Highcharts Stock v8.x and ApexCharts v3.x.


    Current versions supported are:

    HyJavaCharts

    HyJavaStock

    HyJavaApex

    Start the HyJavaCharts demo Java web application


    Start the HyJavaStock demo Java web application


    Start the HyJavaApex demo Java web application