com.github.highcharts4gwt.model.highcharts.option.api.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;



/**
 * The Data module provides a simplified interface for adding data to a chart from sources like CVS, HTML tables or grid views. See also the tutorial article on the Data module.
 * 
 * It requires the modules/data.js file to be loaded.
 * 
 * Please note that the default way of adding data in Highcharts, without the need of a module, is through the series.data option.
 * 
 */
public interface Data {


    /**
     * A comma delimited string to be parsed. Related options are startRow, endRow, startColumn and endColumn to delimit what part of the table is used. The lineDelimiter and itemDelimiter options define the CSV delimiter formats.
     * 
     */
    String csv();

    /**
     * A comma delimited string to be parsed. Related options are startRow, endRow, startColumn and endColumn to delimit what part of the table is used. The lineDelimiter and itemDelimiter options define the CSV delimiter formats.
     * 
     */
    Data csv(String csv);

    /**
     * Which of the predefined date formats in Date.prototype.dateFormats to use to parse date values. Defaults to a best guess based on what format gives valid and ordered dates.
     * 
     * Valid options include:
     * 

     * YYYY-mm-dd
     * dd/mm/YYYY
     * mm/dd/YYYY
     * dd/mm/YY
     * mm/dd/YY
     * 
     * 
     * 
     */
    String dateFormat();

    /**
     * Which of the predefined date formats in Date.prototype.dateFormats to use to parse date values. Defaults to a best guess based on what format gives valid and ordered dates.
     * 
     * Valid options include:
     * 

     * YYYY-mm-dd
     * dd/mm/YYYY
     * mm/dd/YYYY
     * dd/mm/YY
     * mm/dd/YY
     * 
     * 
     * 
     */
    Data dateFormat(String dateFormat);

    /**
     * The decimal point used for parsing numbers in the CSV.
     * 
     */
    String decimalPoint();

    /**
     * The decimal point used for parsing numbers in the CSV.
     * 
     */
    Data decimalPoint(String decimalPoint);

    /**
     * In tabular input data, the last column (indexed by 0) to use. Defaults to the last column containing data.
     * 
     */
    double endColumn();

    /**
     * In tabular input data, the last column (indexed by 0) to use. Defaults to the last column containing data.
     * 
     */
    Data endColumn(double endColumn);

    /**
     * In tabular input data, the last row (indexed by 0) to use. Defaults to the last row containing data.
     * 
     */
    double endRow();

    /**
     * In tabular input data, the last row (indexed by 0) to use. Defaults to the last row containing data.
     * 
     */
    Data endRow(double endRow);

    /**
     * Whether to use the first row in the data set as series names.
     * 
     */
    boolean firstRowAsNames();

    /**
     * Whether to use the first row in the data set as series names.
     * 
     */
    Data firstRowAsNames(boolean firstRowAsNames);

    /**
     * The key for a Google Spreadsheet to load. See general information on GS.
     * 
     */
    String googleSpreadsheetKey();

    /**
     * The key for a Google Spreadsheet to load. See general information on GS.
     * 
     */
    Data googleSpreadsheetKey(String googleSpreadsheetKey);

    /**
     * The Google Spreadsheet worksheet to use in combination with googleSpreadsheetKey. The available id's from your sheet can be read from https://spreadsheets.google.com/feeds/worksheets/{key}/public/basic
     * 
     */
    String googleSpreadsheetWorksheet();

    /**
     * The Google Spreadsheet worksheet to use in combination with googleSpreadsheetKey. The available id's from your sheet can be read from https://spreadsheets.google.com/feeds/worksheets/{key}/public/basic
     * 
     */
    Data googleSpreadsheetWorksheet(String googleSpreadsheetWorksheet);

    /**
     * Item or cell delimiter for parsing CSV. Defaults to the tab character \t if a tab character is found in the CSV string, if not it defaults to ,.
     * 
     */
    String itemDelimiter();

    /**
     * Item or cell delimiter for parsing CSV. Defaults to the tab character \t if a tab character is found in the CSV string, if not it defaults to ,.
     * 
     */
    Data itemDelimiter(String itemDelimiter);

    /**
     * Line delimiter for parsing CSV.
     * 
     */
    String lineDelimiter();

    /**
     * Line delimiter for parsing CSV.
     * 
     */
    Data lineDelimiter(String lineDelimiter);

    /**
     * An array containing object with Point property names along with what column id the property should be taken from.
     * 
     */
    String seriesMapping();

    /**
     * An array containing object with Point property names along with what column id the property should be taken from.
     * 
     */
    Data seriesMapping(String seriesMappingAsJsonStringArray);

    /**
     * In tabular input data, the first column (indexed by 0) to use.
     * 
     */
    double startColumn();

    /**
     * In tabular input data, the first column (indexed by 0) to use.
     * 
     */
    Data startColumn(double startColumn);

    /**
     * In tabular input data, the first row (indexed by 0) to use.
     * 
     */
    double startRow();

    /**
     * In tabular input data, the first row (indexed by 0) to use.
     * 
     */
    Data startRow(double startRow);

    /**
     * Switch rows and columns of the input data, so that this.columns effectively becomes the rows of the data set, and the rows are interpreted as series.
     * 
     */
    boolean switchRowsAndColumns();

    /**
     * Switch rows and columns of the input data, so that this.columns effectively becomes the rows of the data set, and the rows are interpreted as series.
     * 
     */
    Data switchRowsAndColumns(boolean switchRowsAndColumns);

    /**
     * A HTML table or the id of such to be parsed as input data. Related options are startRow, endRow, startColumn and endColumn to delimit what part of the table is used.
     * 
     */
    String table();

    /**
     * A HTML table or the id of such to be parsed as input data. Related options are startRow, endRow, startColumn and endColumn to delimit what part of the table is used.
     * 
     */
    Data table(String table);

    String getFieldAsJsonObject(String fieldName);

    Data setFieldAsJsonObject(String fieldName, String fieldValueAsJonObject);

    String getFunctionAsString(String fieldName);

    Data setFunctionAsString(String fieldName, String functionAsString);

}