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

Interface CommonHighchartBuilder

All Superinterfaces:

GenericHcObject

All Known Subinterfaces:

CustomHighchartBuilder, HighchartBuilder

public interface CommonHighchartBuilder
extends GenericHcObject

Since:

3.10.2

Method Summary

Modifier and Type	Method	Description
void	render(HtmlContentBuilder builder, Integer height, Integer width)	Renders chart to parent builder.
BasicRenderer	render(Integer height, Integer width)	Renders chart. This method can be useful in Velocity.
CommonHighchartBuilder	useRelativeWidth(Double width)	Specifies relative width of the chart.

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

addCustomStringAttribute, addRawAttribute

Method Details

render

void render(@NotNull
 HtmlContentBuilder builder,
 @NotNull
 Integer height,
 @Nullable
 Integer width)

Renders chart to parent builder.

Warning: Using null for width will make the chart non exportable to PDF. If used inside Rich Page Widget then RichPageWidgetCommonContext.columnWidth() should be called instead. RichPageWidgetRenderingContext.target().isPdf() can be used for PDF export detection.

Parameters:

builder - parent builder

height - height of chart in pixels

width - width of chart in pixels or null to make the chart as wide as possible (but see warning above). This parameter will be ignored for rendering in browser if useRelativeWidth(Double) was used

render

@NotNull
BasicRenderer render(@NotNull
 Integer height,
 @Nullable
 Integer width)

Renders chart.
This method can be useful in Velocity.

 #set($chart = $widgetContext.createChartBuilder())
 #set($pie = $chart.pie().name("Name"))
 ##...
 $!chart.build().render(300, $widgetContext.columnWidth)

Warning: Using null for width will make the chart non exportable to PDF. If used inside Rich Page Widget then RichPageWidgetCommonContext.columnWidth() should be called instead. RichPageWidgetRenderingContext.target().isPdf() can be used for PDF export detection.

Parameters:

height - height of chart

width - width of chart in pixels or null to make the chart as wide as possible (but see warning above). This parameter will be ignored for rendering in browser if useRelativeWidth(Double) was used

useRelativeWidth

@NotNull
CommonHighchartBuilder useRelativeWidth(@Nullable
 Double width)

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

Parameters:

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

Returns:

this