com.highsoft.highcharts.common.hichartsclasses

Class HICsv

java.lang.Object

java.util.Observable

com.highsoft.highcharts.core.HIFoundation

com.highsoft.highcharts.common.hichartsclasses.HICsv

public class HICsv
extends HIFoundation

Constructor Summary

Constructors

Constructor and Description
HICsv()

Method Summary

Modifier and Type	Method and Description
HIAnnotations	getAnnotations()
HIFunction	getColumnHeaderFormatter()
java.lang.String	getDateFormat()
java.lang.String	getDecimalPoint()
java.lang.String	getItemDelimiter()
java.lang.String	getLineDelimiter()
java.util.HashMap<java.lang.String,java.lang.Object>	getParams()
void	setAnnotations(HIAnnotations annotations) Options for annotations in the export-data table.
void	setColumnHeaderFormatter(HIFunction columnHeaderFormatter) Formatter callback for the column headers.
void	setDateFormat(java.lang.String dateFormat) Which date format to use for exported dates on a datetime X axis.
void	setDecimalPoint(java.lang.String decimalPoint) Which decimal point to use for exported CSV.
void	setItemDelimiter(java.lang.String itemDelimiter) The item delimiter in the exported data.
void	setLineDelimiter(java.lang.String lineDelimiter) The line delimiter in the exported data, defaultss to a newline.

Methods inherited from class java.util.Observable

addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HICsv

public HICsv()

Method Detail

getAnnotations

public HIAnnotations getAnnotations()

getColumnHeaderFormatter

public HIFunction getColumnHeaderFormatter()

getDateFormat

public java.lang.String getDateFormat()

getDecimalPoint

public java.lang.String getDecimalPoint()

getItemDelimiter

public java.lang.String getItemDelimiter()

getLineDelimiter

public java.lang.String getLineDelimiter()

getParams

public java.util.HashMap<java.lang.String,java.lang.Object> getParams()

Specified by:

getParams in class HIFoundation

setAnnotations

public void setAnnotations(HIAnnotations annotations)

Options for annotations in the export-data table.

setColumnHeaderFormatter

public void setColumnHeaderFormatter(HIFunction columnHeaderFormatter)

Formatter callback for the column headers. Parameters are: - `item` - The series or axis object) - `key` - The point key, for example y or z - `keyLength` - The amount of value keys for this item, for example a range series has the keys `low` and `high` so the key length is 2. If `useMultiLevelHeaders` is true, columnHeaderFormatter by defaults returns an object with columnTitle and topLevelColumnTitle for each key. Columns with the same topLevelColumnTitle have their titles merged into a single cell with colspan for table/Excel export. If `useMultiLevelHeaders` is false, or for CSV export, it returns the series name, followed by the key if there is more than one key. For the axis it returns the axis title or "Category" or "DateTime" by defaults. Return `false` to use Highcharts' proposed header.

setDateFormat

public void setDateFormat(java.lang.String dateFormat)

Which date format to use for exported dates on a datetime X axis. See `Highcharts.dateFormat`.

defaults:

 %Y-%m-%d %H:%M:%S

setDecimalPoint

public void setDecimalPoint(java.lang.String decimalPoint)

Which decimal point to use for exported CSV. Defaults to the same as the browser locale, typically `.` (English) or `,` (German, French etc).

setItemDelimiter

public void setItemDelimiter(java.lang.String itemDelimiter)

The item delimiter in the exported data. Use `;` for direct exporting to Excel. Defaults to a best guess based on the browser locale. If the locale _decimal point_ is `,`, the `itemDelimiter` defaultss to `;`, otherwise the `itemDelimiter` defaultss to `,`.

setLineDelimiter

public void setLineDelimiter(java.lang.String lineDelimiter)

The line delimiter in the exported data, defaultss to a newline.

defaults: