org.dashbuilder.displayer

Interface ChartSettingsBuilder<T extends ChartSettingsBuilder>

All Superinterfaces:

org.dashbuilder.dataset.DataSetLookupBuilder<T>, DisplayerSettingsBuilder<T>

All Known Subinterfaces:

AreaChartSettingsBuilder<T>, BarChartSettingsBuilder<T>, BubbleChartSettingsBuilder<T>, LineChartSettingsBuilder<T>, MapChartSettingsBuilder<T>, MeterChartSettingsBuilder<T>, MetricSettingsBuilder<T>, PieChartSettingsBuilder<T>, XAxisChartSettingsBuilder<T>

All Known Implementing Classes:

AbstractChartSettingsBuilder, AbstractXAxisChartSettingsBuilder, AreaChartSettingsBuilderImpl, BarChartSettingsBuilderImpl, BubbleChartSettingsBuilderImpl, LineChartSettingsBuilderImpl, MapChartSettingsBuilderImpl, MeterChartSettingsBuilderImpl, MetricSettingsBuilderImpl, PieChartSettingsBuilderImpl

public interface ChartSettingsBuilder<T extends ChartSettingsBuilder>
extends DisplayerSettingsBuilder<T>

A displayer settings builder for the assembly of Chart based data displayer instances.

Method Summary

Modifier and Type	Method and Description
T	height(int height) Sets the height of the chart.
T	legendOff() Hides off the char legend.
T	legendOn(Position position)
T	legendOn(String position) Turns on the char legend display.
T	margins(int top, int bottom, int left, int right) Set the margins for this chart.
T	resizableOff() Set the chart as no resizable, it cannot change its size from the original one, defined by width and height attributes.
T	resizableOn(int maxWidth, int maxHeight) Set the chart as resizable, it can change its size from the original one, defined by width and height attributes.
T	width(int width) Sets the width of the chart.

Methods inherited from interface org.dashbuilder.displayer.DisplayerSettingsBuilder

backgroundColor, buildSettings, dataset, expression, expression, filterOff, filterOn, format, format, format, htmlTemplate, jsTemplate, refreshOff, refreshOn, refreshOn, renderer, subtype, title, titleVisible, uuid

Methods inherited from interface org.dashbuilder.dataset.DataSetLookupBuilder

asc, buildLookup, column, column, column, column, column, dataset, desc, dynamic, dynamic, dynamic, filter, filter, firstDay, firstMonth, fixed, group, group, join, rowNumber, rowOffset, select, sort, sort

Method Detail

width

T width(int width)

Sets the width of the chart.

Parameters:

width - The width of the chart.

Returns:

The DisplayerSettingsBuilder instance that is being used to configure a Chart data displayer.

height

T height(int height)

Sets the height of the chart.

Parameters:

height - The height of the chart.

Returns:

The DisplayerSettingsBuilder instance that is being used to configure a Chart data displayer.

margins

T margins(int top,
          int bottom,
          int left,
          int right)

Set the margins for this chart.

Parameters:

top - The top margin.

bottom - The bottom margin.

left - The left margin.

right - The right margin.

Returns:

The DisplayerSettingsBuilder instance that is being used to configure a Chart data displayer.

legendOff

T legendOff()

Hides off the char legend.

Returns:

The DisplayerSettingsBuilder instance that is being used to configure a Chart data displayer.

legendOn

T legendOn(String position)

Turns on the char legend display.

Parameters:

position - The display position.

Returns:

The DisplayerSettingsBuilder instance that is being used to configure a Chart data displayer.

legendOn

T legendOn(Position position)

resizableOn

T resizableOn(int maxWidth,
              int maxHeight)

Set the chart as resizable, it can change its size from the original one, defined by width and height attributes.

Parameters:

maxWidth - The maximum width value.

maxHeight - The maximum height value.

Returns:

The DisplayerSettingsBuilder instance that is being used to configure a Chart data displayer.

resizableOff

T resizableOff()

Set the chart as no resizable, it cannot change its size from the original one, defined by width and height attributes.

Returns:

The DisplayerSettingsBuilder instance that is being used to configure a Chart data displayer.