com.technia.helium.chart

Interface ChartDef

All Known Implementing Classes:

ChartDefImpl

public interface ChartDef

Definition of a chart widget.

Since:

2015.2.0

Method Summary

Modifier and Type	Method and Description
Chart	create(Context context, boolean evaluateDataSet) Creates an instance of chart definition.
Chart	create(Context context, boolean isDraftConfig, java.util.Collection<java.util.HashMap<java.lang.String,java.lang.String>> dashboardData, boolean evaluateDataSet) Creates an instance of chart definition.
Chart	create(Context context, java.util.Collection<java.util.HashMap<java.lang.String,java.lang.String>> dashboardData, boolean evaluateDataSet) Creates an instance of chart definition.
java.lang.String	getAnimateOnLoad() Reference to a JavaScript function which registers a chart animation.
java.lang.String	getColors() Custom colors options for the chart specified by configurator of the*
java.util.Collection<DataSerieDef>	getDataSerieDefs() One or more data series to display in the chart.
java.lang.String	getDataType() Type of data in chart.
DrillDown	getDrillDown() Defines how drill downs are performed.
java.lang.String	getExternalSource() Reference to a String URL or aJavaScript function which provides request or string to pull the data from external source
java.lang.String	getExternalSourceDataFunction() Reference to a JavaScript function which converts the response to data in a way accepted by charts
java.lang.String	getFillColors() Custom colors options for the chart specified by configurator of the*
java.lang.String	getFnOptions() Custom function options for the chart specified by configurator of the system.
java.lang.String	getOnClick() Reference to javascript function which is invoked when user clicks on chart elements.
java.lang.String	getOptions() Custom options for the chart specified by configurator of the system.
java.lang.String	getResponsiveOptions() Custom responsive options for the chart specified by configurator of the system.
Sorting	getSorting() Controls how to sort the data.
java.lang.Integer	getTop() Defines the number of entries in the chart to display.
boolean	isStack() Controls if series should be stacked.
boolean	showLegend() Controls if legend should be displayed.
boolean	showTooltip() Controls if tooltips should be displayed.

Method Detail

getOptions

java.lang.String getOptions()

Custom options for the chart specified by configurator of the system. These always have highest priority.

Returns:

The custom settings

Since:

2015.2.0

getResponsiveOptions

java.lang.String getResponsiveOptions()

Custom responsive options for the chart specified by configurator of the system. Responsive options can control the layout based on media queries.

Returns:

The custom responsive settings

Since:

2015.2.0

getColors

java.lang.String getColors()

Custom colors options for the chart specified by configurator of the*

Returns:

The custom colors settings

Since:

2021.4.0

getFillColors

java.lang.String getFillColors()

Custom colors options for the chart specified by configurator of the*

Returns:

The custom colors to fill the path elements settings

Since:

2021.4.0

getDataSerieDefs

java.util.Collection<DataSerieDef> getDataSerieDefs()

One or more data series to display in the chart.

Returns:

The data series

Since:

2015.2.0

isStack

boolean isStack()

Controls if series should be stacked.

Returns:

True if stack is enabled

Since:

2015.2.0

showTooltip

boolean showTooltip()

Controls if tooltips should be displayed.

Returns:

Since:

2015.2.0

getTop

java.lang.Integer getTop()

Defines the number of entries in the chart to display. The ones with highest values are displayed and others are grouped together in the "other" section.

Returns:

The number of entries to display

Since:

2015.2.0

getOnClick

java.lang.String getOnClick()

Reference to javascript function which is invoked when user clicks on chart elements. This enables the possibility to drill down, exchange information in tables or something else.

Returns:

The callback js function

Since:

2015.2.0

getDrillDown

DrillDown getDrillDown()

Defines how drill downs are performed.

Returns:

The drive down behavior

Since:

2015.2.0

getSorting

Sorting getSorting()

Controls how to sort the data.

Returns:

The sorting

Since:

2015.2.0

getDataType

java.lang.String getDataType()

Type of data in chart. E.g. group by attribute on a set of objects.

Returns:

The data type

Since:

2015.2.0

getFnOptions

java.lang.String getFnOptions()

Custom function options for the chart specified by configurator of the system. These always have highest priority.

Returns:

The custom settings

Since:

2022.2.0

getExternalSource

java.lang.String getExternalSource()

Reference to a String URL or aJavaScript function which provides request or string to pull the data from external source

Returns:

A callback to function

Since:

2022.2.0

getExternalSourceDataFunction

java.lang.String getExternalSourceDataFunction()

Reference to a JavaScript function which converts the response to data in a way accepted by charts

Returns:

A callback to function

Since:

2022.2.0

create

Chart create(Context context,
             boolean evaluateDataSet)

Creates an instance of chart definition.

Parameters:

context - Objects user is looking at in UI

evaluateDataSet - Determines if the dataset is evaluated. Typicially not needed when doing drilldowns in dashboards.

Returns:

The chart instance

Since:

2015.2.0

create

Chart create(Context context,
             java.util.Collection<java.util.HashMap<java.lang.String,java.lang.String>> dashboardData,
             boolean evaluateDataSet)

Creates an instance of chart definition.

Parameters:

context - Objects user is looking at in UI

dashboardData - data from dashboard level ( hashmap of relationship_id / object_id)

evaluateDataSet - Determines if the dataset is evaluated. Typicially not needed when doing drilldowns in dashboards.

Returns:

The chart instance

Since:

2021.2.0

create

Chart create(Context context,
             boolean isDraftConfig,
             java.util.Collection<java.util.HashMap<java.lang.String,java.lang.String>> dashboardData,
             boolean evaluateDataSet)

Creates an instance of chart definition.

Parameters:

context - Objects user is looking at in UI

isDraftConfig - - the dashboard that loads this widget is draft or not

dashboardData - data from dashboard level ( hashmap of relationship_id / object_id)

evaluateDataSet - Determines if the dataset is evaluated. Typicially not needed when doing drilldowns in dashboards.

Returns:

The chart instance

Since:

2021.5.0

showLegend

boolean showLegend()

Controls if legend should be displayed.

Returns:

Since:

2017.3.0

getAnimateOnLoad

java.lang.String getAnimateOnLoad()

Reference to a JavaScript function which registers a chart animation.

Returns:

The callback js function

Since:

2018.1.0