Package com.polarion.alm.shared.api.utils.charts.highcharts

Interface HighchartBuilder

All Superinterfaces:

CommonHighchartBuilder, GenericHcObject

public interface HighchartBuilder
extends CommonHighchartBuilder

Low level API for defining Highcharts. It replicates javascript Highcharts API (http://api.highcharts.com/highcharts). Method CommonHighchartBuilder.render(HtmlContentBuilder, Integer, Integer) builds result in html/javascript.

Since:

3.9.0

Method Summary

Modifier and Type	Method	Description
HcChart	chart()
SharedContext	context()
HcCredits	credits()
HcExporting	exporting()
HcHorizontalAlignmentSelector	horizontalAlignment()	Returns chart's horizontal alignment selector.
HcLegend	legend()
HcPlotOptions	plotOptions()
HcSeries	series()
HcTitle	subtitle()
HcTitle	title()
HcTooltip	tooltip()
HighchartBuilder	useRelativeWidth(Double width)	Specifies relative width of the chart.
HcAxis	xAxis()
HcAxis	yAxis()

Methods inherited from interface com.polarion.alm.shared.api.utils.charts.highcharts.CommonHighchartBuilder

render, render

Methods inherited from interface com.polarion.alm.shared.api.utils.charts.highcharts.GenericHcObject

addCustomStringAttribute, addRawAttribute

Method Details

useRelativeWidth

@NotNull
HighchartBuilder useRelativeWidth(@Nullable
 Double width)

Description copied from interface: CommonHighchartBuilder

Specifies relative width of the chart. It is applicable only for case when chart is rendered in a browser.
Should be called before CommonHighchartBuilder.render(HtmlContentBuilder, Integer, Integer) or CommonHighchartBuilder.render(Integer, Integer)

Specified by:

useRelativeWidth in interface CommonHighchartBuilder

Parameters:

width - width in percentages, null means that relative width will not be used

Returns:

this

chart

@NotNull
HcChart chart()

credits

@NotNull
HcCredits credits()

exporting

@NotNull
HcExporting exporting()

legend

@NotNull
HcLegend legend()

Since:

3.9.3

plotOptions

@NotNull
HcPlotOptions plotOptions()

series

@NotNull
HcSeries series()

subtitle

@NotNull
HcTitle subtitle()

Since:

3.9.3

title

@NotNull
HcTitle title()

tooltip

@NotNull
HcTooltip tooltip()

xAxis

@NotNull
HcAxis xAxis()

yAxis

@NotNull
HcAxis yAxis()

context

@NotNull
SharedContext context()

Since:

3.9.1

horizontalAlignment

@NotNull
HcHorizontalAlignmentSelector horizontalAlignment()

Returns chart's horizontal alignment selector. Should be called before CommonHighchartBuilder.render(HtmlContentBuilder, Integer, Integer) or CommonHighchartBuilder.render(Integer, Integer)

Since:

3.10.0