com.github.highcharts4gwt.model.highcharts.option.api.plotoptions.Bar Maven / Gradle / Ivy
Show all versions of highcharts Show documentation
package com.github.highcharts4gwt.model.highcharts.option.api.plotoptions;
import com.github.highcharts4gwt.model.array.api.ArrayNumber;
import com.github.highcharts4gwt.model.array.api.ArrayString;
import com.github.highcharts4gwt.model.highcharts.option.api.plotoptions.bar.BarAfterAnimateHandler;
import com.github.highcharts4gwt.model.highcharts.option.api.plotoptions.bar.BarCheckboxClickHandler;
import com.github.highcharts4gwt.model.highcharts.option.api.plotoptions.bar.BarClickHandler;
import com.github.highcharts4gwt.model.highcharts.option.api.plotoptions.bar.BarHideHandler;
import com.github.highcharts4gwt.model.highcharts.option.api.plotoptions.bar.BarLegendItemClickHandler;
import com.github.highcharts4gwt.model.highcharts.option.api.plotoptions.bar.BarMouseOutHandler;
import com.github.highcharts4gwt.model.highcharts.option.api.plotoptions.bar.BarMouseOverHandler;
import com.github.highcharts4gwt.model.highcharts.option.api.plotoptions.bar.BarShowHandler;
import com.github.highcharts4gwt.model.highcharts.option.api.plotoptions.bar.DataLabels;
import com.github.highcharts4gwt.model.highcharts.option.api.plotoptions.bar.Point;
import com.github.highcharts4gwt.model.highcharts.option.api.plotoptions.bar.States;
import com.github.highcharts4gwt.model.highcharts.option.api.plotoptions.bar.Tooltip;
/**
*
*/
public interface Bar {
/**
* Allow this series' points to be selected by clicking on the markers, bars or pie slices.
*
*/
boolean allowPointSelect();
/**
* Allow this series' points to be selected by clicking on the markers, bars or pie slices.
*
*/
Bar allowPointSelect(boolean allowPointSelect);
/**
* Enable or disable the initial animation when a series is displayed. The animation can also be set as a configuration object. Please note that this option only applies to the initial animation of the series itself. For other animations, see chart.animation and the animation parameter under the API methods. The following properties are supported:
*
* - duration
* - The duration of the animation in milliseconds.
* - easing
* - When using jQuery as the general framework, the easing can be set to
linear or swing. More easing functions are available with the use of jQuery plug-ins, most notably the jQuery UI suite. See the jQuery docs. When using MooTools as the general framework, use the property name transition instead of easing.
*
*
* Due to poor performance, animation is disabled in old IE browsers for column charts and polar charts.
*
*/
boolean animation();
/**
* Enable or disable the initial animation when a series is displayed. The animation can also be set as a configuration object. Please note that this option only applies to the initial animation of the series itself. For other animations, see chart.animation and the animation parameter under the API methods. The following properties are supported:
*
* - duration
* - The duration of the animation in milliseconds.
* - easing
* - When using jQuery as the general framework, the easing can be set to
linear or swing. More easing functions are available with the use of jQuery plug-ins, most notably the jQuery UI suite. See the jQuery docs. When using MooTools as the general framework, use the property name transition instead of easing.
*
*
* Due to poor performance, animation is disabled in old IE browsers for column charts and polar charts.
*
*/
Bar animation(boolean animation);
/**
* The color of the border surrounding each column or bar.
*
*/
String borderColor();
/**
* The color of the border surrounding each column or bar.
*
*/
Bar borderColor(String borderColor);
/**
* The corner radius of the border surrounding each column or bar.
*
*/
double borderRadius();
/**
* The corner radius of the border surrounding each column or bar.
*
*/
Bar borderRadius(double borderRadius);
/**
* The width of the border surrounding each column or bar.
*
*/
double borderWidth();
/**
* The width of the border surrounding each column or bar.
*
*/
Bar borderWidth(double borderWidth);
/**
* The main color or the series. In line type series it applies to the line and the point markers unless otherwise specified. In bar type series it applies to the bars unless a color is specified per point. The default value is pulled from the options.colors array.
*
*/
String color();
/**
* The main color or the series. In line type series it applies to the line and the point markers unless otherwise specified. In bar type series it applies to the bars unless a color is specified per point. The default value is pulled from the options.colors array.
*
*/
Bar color(String color);
/**
* When using automatic point colors pulled from the options.colors
collection, this option determines whether the chart should receive
one color per series or one color per point.
*
*/
boolean colorByPoint();
/**
* When using automatic point colors pulled from the options.colors
collection, this option determines whether the chart should receive
one color per series or one color per point.
*
*/
Bar colorByPoint(boolean colorByPoint);
/**
* A series specific or series type specific color set to apply instead of the global colors when colorByPoint is true.
*
*/
ArrayString colors();
/**
* A series specific or series type specific color set to apply instead of the global colors when colorByPoint is true.
*
*/
Bar colors(ArrayString colors);
/**
* When the series contains less points than the crop threshold, all points are drawn, event if the points fall outside the visible plot area at the current zoom. The advantage of drawing all points (including markers and columns), is that animation is performed on updates. On the other hand, when the series contains more points than the crop threshold, the series data is cropped to only contain points that fall within the plot area. The advantage of cropping away invisible points is to increase performance on large series. .
*
*/
double cropThreshold();
/**
* When the series contains less points than the crop threshold, all points are drawn, event if the points fall outside the visible plot area at the current zoom. The advantage of drawing all points (including markers and columns), is that animation is performed on updates. On the other hand, when the series contains more points than the crop threshold, the series data is cropped to only contain points that fall within the plot area. The advantage of cropping away invisible points is to increase performance on large series. .
*
*/
Bar cropThreshold(double cropThreshold);
/**
* You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.
*
*/
String cursor();
/**
* You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.
*
*/
Bar cursor(String cursor);
/**
*
*/
DataLabels dataLabels();
/**
*
*/
Bar dataLabels(DataLabels dataLabels);
/**
* Depth of the columns in a 3D column chart. Requires highcharts-3d.js.
*
*/
double depth();
/**
* Depth of the columns in a 3D column chart. Requires highcharts-3d.js.
*
*/
Bar depth(double depth);
/**
* 3D columns only. The color of the edges. Similar to borderColor, except it defaults to the same color as the column.
*
*/
String edgeColor();
/**
* 3D columns only. The color of the edges. Similar to borderColor, except it defaults to the same color as the column.
*
*/
Bar edgeColor(String edgeColor);
/**
* 3D columns only. The width of the colored edges.
*
*/
double edgeWidth();
/**
* 3D columns only. The width of the colored edges.
*
*/
Bar edgeWidth(double edgeWidth);
/**
* Enable or disable the mouse tracking for a specific series. This includes point tooltips and click events on graphs and points. For large datasets it improves performance.
*
*/
boolean enableMouseTracking();
/**
* Enable or disable the mouse tracking for a specific series. This includes point tooltips and click events on graphs and points. For large datasets it improves performance.
*
*/
Bar enableMouseTracking(boolean enableMouseTracking);
void addBarAfterAnimateHandler(BarAfterAnimateHandler barAfterAnimateHandler);
void addBarCheckboxClickHandler(BarCheckboxClickHandler barCheckboxClickHandler);
void addBarClickHandler(BarClickHandler barClickHandler);
void addBarHideHandler(BarHideHandler barHideHandler);
void addBarLegendItemClickHandler(BarLegendItemClickHandler barLegendItemClickHandler);
void addBarMouseOutHandler(BarMouseOutHandler barMouseOutHandler);
void addBarMouseOverHandler(BarMouseOverHandler barMouseOverHandler);
void addBarShowHandler(BarShowHandler barShowHandler);
/**
* Padding between each value groups, in x axis units.
*
*/
double groupPadding();
/**
* Padding between each value groups, in x axis units.
*
*/
Bar groupPadding(double groupPadding);
/**
* The spacing between columns on the Z Axis in a 3D chart. Requires highcharts-3d.js.
*
*/
double groupZPadding();
/**
* The spacing between columns on the Z Axis in a 3D chart. Requires highcharts-3d.js.
*
*/
Bar groupZPadding(double groupZPadding);
/**
* Whether to group non-stacked columns or to let them render independent of each other. Non-grouped columns will be laid out individually and overlap each other.
*
*/
boolean grouping();
/**
* Whether to group non-stacked columns or to let them render independent of each other. Non-grouped columns will be laid out individually and overlap each other.
*
*/
Bar grouping(boolean grouping);
/**
* The id of another series to link to. Additionally, the value can be ":previous" to link to the previous series. When two series are linked, only the first one appears in the legend. Toggling the visibility of this also toggles the linked series.
*
*/
String linkedTo();
/**
* The id of another series to link to. Additionally, the value can be ":previous" to link to the previous series. When two series are linked, only the first one appears in the legend. Toggling the visibility of this also toggles the linked series.
*
*/
Bar linkedTo(String linkedTo);
/**
* The minimal height for a column or width for a bar. By default, 0 values are not shown. To visualize a 0 (or close to zero) point, set the minimal point length to a pixel value like 3. In stacked column charts, minPointLength might not be respected for tightly packed values.
*
*/
double minPointLength();
/**
* The minimal height for a column or width for a bar. By default, 0 values are not shown. To visualize a 0 (or close to zero) point, set the minimal point length to a pixel value like 3. In stacked column charts, minPointLength might not be respected for tightly packed values.
*
*/
Bar minPointLength(double minPointLength);
/**
* The color for the parts of the graph or points that are below the threshold.
*
*/
String negativeColor();
/**
* The color for the parts of the graph or points that are below the threshold.
*
*/
Bar negativeColor(String negativeColor);
/**
* Properties for each single point
*
*/
Point point();
/**
* Properties for each single point
*
*/
Bar point(Point point);
/**
* If no x values are given for the points in a series, pointInterval defines
* the interval of the x values. For example, if a series contains one value
* every decade starting from year 0, set pointInterval to 10.
* Since Highcharts 4.1, it can be combined with pointIntervalUnit to draw irregular intervals.
*
*/
double pointInterval();
/**
* If no x values are given for the points in a series, pointInterval defines
* the interval of the x values. For example, if a series contains one value
* every decade starting from year 0, set pointInterval to 10.
* Since Highcharts 4.1, it can be combined with pointIntervalUnit to draw irregular intervals.
*
*/
Bar pointInterval(double pointInterval);
/**
* On datetime series, this allows for setting the pointInterval to the two irregular time units, month and year. Combine it with pointInterval to draw quarters, 6 months, 10 years etc.
*
*/
String pointIntervalUnit();
/**
* On datetime series, this allows for setting the pointInterval to the two irregular time units, month and year. Combine it with pointInterval to draw quarters, 6 months, 10 years etc.
*
*/
Bar pointIntervalUnit(String pointIntervalUnit);
/**
* Padding between each column or bar, in x axis units.
*
*/
double pointPadding();
/**
* Padding between each column or bar, in x axis units.
*
*/
Bar pointPadding(double pointPadding);
/**
* Possible values: null, "on", "between".
* In a column chart, when pointPlacement is "on", the point will not create any padding of the X axis. In a polar column chart this means that the first column points directly north. If the pointPlacement is "between", the columns will be laid out between ticks. This is useful for example for visualising an amount between two points in time or in a certain sector of a polar chart.
* Since Highcharts 3.0.2, the point placement can also be numeric, where 0 is on the axis value, -0.5 is between this value and the previous, and 0.5 is between this value and the next. Unlike the textual options, numeric point placement options won't affect axis padding.
* Defaults to null in cartesian charts, "between" in polar charts.
*
*/
String pointPlacementAsString();
/**
*
Possible values: null, "on", "between".
* In a column chart, when pointPlacement is "on", the point will not create any padding of the X axis. In a polar column chart this means that the first column points directly north. If the pointPlacement is "between", the columns will be laid out between ticks. This is useful for example for visualising an amount between two points in time or in a certain sector of a polar chart.
* Since Highcharts 3.0.2, the point placement can also be numeric, where 0 is on the axis value, -0.5 is between this value and the previous, and 0.5 is between this value and the next. Unlike the textual options, numeric point placement options won't affect axis padding.
* Defaults to null in cartesian charts, "between" in polar charts.
*
*/
Bar pointPlacementAsString(String pointPlacementAsString);
/**
*
Possible values: null, "on", "between".
* In a column chart, when pointPlacement is "on", the point will not create any padding of the X axis. In a polar column chart this means that the first column points directly north. If the pointPlacement is "between", the columns will be laid out between ticks. This is useful for example for visualising an amount between two points in time or in a certain sector of a polar chart.
* Since Highcharts 3.0.2, the point placement can also be numeric, where 0 is on the axis value, -0.5 is between this value and the previous, and 0.5 is between this value and the next. Unlike the textual options, numeric point placement options won't affect axis padding.
* Defaults to null in cartesian charts, "between" in polar charts.
*
*/
double pointPlacementAsNumber();
/**
*
Possible values: null, "on", "between".
* In a column chart, when pointPlacement is "on", the point will not create any padding of the X axis. In a polar column chart this means that the first column points directly north. If the pointPlacement is "between", the columns will be laid out between ticks. This is useful for example for visualising an amount between two points in time or in a certain sector of a polar chart.
* Since Highcharts 3.0.2, the point placement can also be numeric, where 0 is on the axis value, -0.5 is between this value and the previous, and 0.5 is between this value and the next. Unlike the textual options, numeric point placement options won't affect axis padding.
* Defaults to null in cartesian charts, "between" in polar charts.
*
*/
Bar pointPlacementAsNumber(double pointPlacementAsNumber);
/**
* The X axis range that each point is valid for. This determines the width of the column. On a categorized axis, the range will be 1 by default (one category unit). On linear and datetime axes, the range will be computed as the distance between the two closest data points.
*
*/
double pointRange();
/**
* The X axis range that each point is valid for. This determines the width of the column. On a categorized axis, the range will be 1 by default (one category unit). On linear and datetime axes, the range will be computed as the distance between the two closest data points.
*
*/
Bar pointRange(double pointRange);
/**
* If no x values are given for the points in a series, pointStart defines on what value to start. For example, if a series contains one yearly value starting from 1945, set pointStart to 1945.
*
*/
double pointStart();
/**
* If no x values are given for the points in a series, pointStart defines on what value to start. For example, if a series contains one yearly value starting from 1945, set pointStart to 1945.
*
*/
Bar pointStart(double pointStart);
/**
* A pixel value specifying a fixed width for each column or bar. When null, the width is calculated from the pointPadding and groupPadding.
*
*/
double pointWidth();
/**
* A pixel value specifying a fixed width for each column or bar. When null, the width is calculated from the pointPadding and groupPadding.
*
*/
Bar pointWidth(double pointWidth);
/**
* Whether to select the series initially. If showCheckbox is true, the checkbox next to the series name will be checked for a selected series.
*
*/
boolean selected();
/**
* Whether to select the series initially. If showCheckbox is true, the checkbox next to the series name will be checked for a selected series.
*
*/
Bar selected(boolean selected);
/**
* Whether to apply a drop shadow to the graph line. Since 2.3 the shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.
*
*/
boolean shadowAsBoolean();
/**
* Whether to apply a drop shadow to the graph line. Since 2.3 the shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.
*
*/
Bar shadowAsBoolean(boolean shadowAsBoolean);
/**
* Whether to apply a drop shadow to the graph line. Since 2.3 the shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.
*
*/
String shadowAsJsonString();
/**
* Whether to apply a drop shadow to the graph line. Since 2.3 the shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.
*
*/
Bar shadowAsJsonString(String shadowAsJsonString);
/**
* If true, a checkbox is displayed next to the legend item to allow selecting the series. The state of the checkbox is determined by the selected option.
*
*/
boolean showCheckbox();
/**
* If true, a checkbox is displayed next to the legend item to allow selecting the series. The state of the checkbox is determined by the selected option.
*
*/
Bar showCheckbox(boolean showCheckbox);
/**
* Whether to display this particular series or series type in the legend. The default value is true for standalone series, false for linked series.
*
*/
boolean showInLegend();
/**
* Whether to display this particular series or series type in the legend. The default value is true for standalone series, false for linked series.
*
*/
Bar showInLegend(boolean showInLegend);
/**
* Whether to stack the values of each series on top of each other. Possible values are null to disable, "normal" to stack by value or "percent".
*
*/
String stacking();
/**
* Whether to stack the values of each series on top of each other. Possible values are null to disable, "normal" to stack by value or "percent".
*
*/
Bar stacking(String stacking);
/**
* A wrapper object for all the series options in specific states.
*
*/
States states();
/**
* A wrapper object for all the series options in specific states.
*
*/
Bar states(States states);
/**
* Sticky tracking of mouse events. When true, the mouseOut event
on a series isn't triggered until the mouse moves over another series, or out
of the plot area. When false, the mouseOut event on a series is
triggered when the mouse leaves the area around the series' graph or markers.
This also implies the tooltip. When stickyTracking is false and tooltip.shared is false, the
tooltip will be hidden when moving the mouse between series. Defaults to true for line and area type series, but to false for columns, pies etc.
*
*/
boolean stickyTracking();
/**
* Sticky tracking of mouse events. When true, the mouseOut event
on a series isn't triggered until the mouse moves over another series, or out
of the plot area. When false, the mouseOut event on a series is
triggered when the mouse leaves the area around the series' graph or markers.
This also implies the tooltip. When stickyTracking is false and tooltip.shared is false, the
tooltip will be hidden when moving the mouse between series. Defaults to true for line and area type series, but to false for columns, pies etc.
*
*/
Bar stickyTracking(boolean stickyTracking);
/**
* The Y axis value to serve as the base for the columns, for distinguishing between values above and below a threshold. If null, the columns extend from the padding Y axis minimum.
*
*/
double threshold();
/**
* The Y axis value to serve as the base for the columns, for distinguishing between values above and below a threshold. If null, the columns extend from the padding Y axis minimum.
*
*/
Bar threshold(double threshold);
/**
* A configuration object for the tooltip rendering of each single series. Properties are inherited from tooltip, but only the following properties can be defined on a series level.
*
*/
Tooltip tooltip();
/**
* A configuration object for the tooltip rendering of each single series. Properties are inherited from tooltip, but only the following properties can be defined on a series level.
*
*/
Bar tooltip(Tooltip tooltip);
/**
* When a series contains a data array that is longer than this, only one dimensional arrays of numbers,
or two dimensional arrays with x and y values are allowed. Also, only the first
point is tested, and the rest are assumed to be the same format. This saves expensive
data checking and indexing in long series. Set it to 0 disable.
*
*/
double turboThreshold();
/**
* When a series contains a data array that is longer than this, only one dimensional arrays of numbers,
or two dimensional arrays with x and y values are allowed. Also, only the first
point is tested, and the rest are assumed to be the same format. This saves expensive
data checking and indexing in long series. Set it to 0 disable.
*
*/
Bar turboThreshold(double turboThreshold);
/**
* Set the initial visibility of the series.
*
*/
boolean visible();
/**
* Set the initial visibility of the series.
*
*/
Bar visible(boolean visible);
/**
* Defines the Axis on which the zones are applied.
*
*/
String zoneAxis();
/**
* Defines the Axis on which the zones are applied.
*
*/
Bar zoneAxis(String zoneAxis);
/**
* An array defining zones within a series.
*
*/
ArrayNumber zones();
/**
* An array defining zones within a series.
*
*/
Bar zones(ArrayNumber zones);
String getFieldAsJsonObject(String fieldName);
Bar setFieldAsJsonObject(String fieldName, String fieldValueAsJonObject);
String getFunctionAsString(String fieldName);
Bar setFunctionAsString(String fieldName, String functionAsString);
}