com.github.highcharts4gwt.model.highcharts.option.api.seriesscatter.Data Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of highcharts Show documentation
GWT wrapper for highcharts library.
There is a newer version: 0.0.7

package com.github.highcharts4gwt.model.highcharts.option.api.seriesscatter;

import com.github.highcharts4gwt.model.highcharts.option.api.seriesscatter.data.DataClickHandler;
import com.github.highcharts4gwt.model.highcharts.option.api.seriesscatter.data.DataMouseOutHandler;
import com.github.highcharts4gwt.model.highcharts.option.api.seriesscatter.data.DataMouseOverHandler;
import com.github.highcharts4gwt.model.highcharts.option.api.seriesscatter.data.DataRemoveHandler;
import com.github.highcharts4gwt.model.highcharts.option.api.seriesscatter.data.DataSelectHandler;
import com.github.highcharts4gwt.model.highcharts.option.api.seriesscatter.data.DataUnselectHandler;
import com.github.highcharts4gwt.model.highcharts.option.api.seriesscatter.data.DataUpdateHandler;
import com.github.highcharts4gwt.model.highcharts.option.api.seriesscatter.data.Marker;


/**
 * An array of data points for the series. For the scatter series type, points can be given in the following ways:
 *  
 *  	An array of numerical values. In this case, the numerical values will 
 *  	be interpreted as y options. The x values will be automatically calculated,
 *  	either starting at 0 and incremented by 1, or from pointStart 
 *  	and pointInterval given in the series options. If the axis
 *  	has categories, these will be used.  Example:
 * data: [0, 5, 3, 5]
 *  	
 *  	An array of arrays with 2 values. In this case, the values correspond to x,y. If the first value is a string, it is
 *  	applied as the name of the point, and the x value is inferred. 
data: [
 *     [0, 0], 
 *     [1, 8], 
 *     [2, 9]
 * ]
 * 
 * 
 * An array of objects with named values. The objects are
 *  	point configuration objects as seen below. If the total number of data points exceeds the series' turboThreshold, this option is not available.
 * 
 * data: [{
 *     x: 1,
 *     y: 2,
 *     name: "Point2",
 *     color: "#00FF00"
 * }, {
 *     x: 1,
 *     y: 4,
 *     name: "Point1",
 *     color: "#FF00FF"
 * }]
 *  
 * 
 */
public interface Data {


    /**
     * Individual color for the point. By default the color is pulled from the global colors array.
     * 
     */
    String color();

    /**
     * Individual color for the point. By default the color is pulled from the global colors array.
     * 
     */
    Data color(String color);

    /**
     * Individual data label for each point. The options are the same as the ones for  plotOptions.series.dataLabels
     * 
     */
    String dataLabels();

    /**
     * Individual data label for each point. The options are the same as the ones for  plotOptions.series.dataLabels
     * 
     */
    Data dataLabels(String dataLabelsAsJsonString);

    /**
     * The id of a series in the drilldown.series array to use for a drilldown for this point.
     * 
     */
    String drilldown();

    /**
     * The id of a series in the drilldown.series array to use for a drilldown for this point.
     * 
     */
    Data drilldown(String drilldown);

    void addDataClickHandler(DataClickHandler dataClickHandler);

    void addDataMouseOutHandler(DataMouseOutHandler dataMouseOutHandler);

    void addDataMouseOverHandler(DataMouseOverHandler dataMouseOverHandler);

    void addDataRemoveHandler(DataRemoveHandler dataRemoveHandler);

    void addDataSelectHandler(DataSelectHandler dataSelectHandler);

    void addDataUnselectHandler(DataUnselectHandler dataUnselectHandler);

    void addDataUpdateHandler(DataUpdateHandler dataUpdateHandler);

    /**
     * An id for the point. This can be used after render time to get a pointer to the point object through chart.get().
     * 
     */
    String id();

    /**
     * An id for the point. This can be used after render time to get a pointer to the point object through chart.get().
     * 
     */
    Data id(String id);

    /**
     * 
     */
    Marker marker();

    /**
     * 
     */
    Data marker(Marker marker);

    /**
     * The name of the point as shown in the legend, tooltip, dataLabel etc.
     * 
     * If the xAxis.type is set to category, and no categories option exists, the category will be pulled from the point.name of the last series defined. For multiple series, best practice however is to define xAxis.categories.
     * 
     */
    String name();

    /**
     * The name of the point as shown in the legend, tooltip, dataLabel etc.
     * 
     * If the xAxis.type is set to category, and no categories option exists, the category will be pulled from the point.name of the last series defined. For multiple series, best practice however is to define xAxis.categories.
     * 
     */
    Data name(String name);

    /**
     * Whether the data point is selected initially.
     * 
     */
    boolean selected();

    /**
     * Whether the data point is selected initially.
     * 
     */
    Data selected(boolean selected);

    /**
     * The x value of the point. For datetime axes, the X value is the timestamp in milliseconds since 1970.
     * 
     */
    double x();

    /**
     * The x value of the point. For datetime axes, the X value is the timestamp in milliseconds since 1970.
     * 
     */
    Data x(double x);

    /**
     * The y value of the point.
     * 
     */
    double y();

    /**
     * The y value of the point.
     * 
     */
    Data y(double y);

    String getFieldAsJsonObject(String fieldName);

    Data setFieldAsJsonObject(String fieldName, String fieldValueAsJonObject);

    String getFunctionAsString(String fieldName);

    Data setFunctionAsString(String fieldName, String functionAsString);

}