org.fujion.highcharts

Class PlotWindbarb

java.lang.Object

org.fujion.ancillary.Options

org.fujion.highcharts.PlotOptions

org.fujion.highcharts.PlotWindbarb

All Implemented Interfaces:

OptionMap.IOptionMapConverter, IClientTransform

public class PlotWindbarb
extends PlotOptions

Options for windbarb plot.

Wind barbs are a convenient way to represent wind speed and direction in one graphical form. Wind direction is given by the stem direction, and wind speed by the number and shape of barbs.

Field Summary

Fields

Modifier and Type	Field and Description
String	edgeColor 3D columns only.
Integer	edgeWidth 3D columns only.
Boolean	grouping Whether to group non-stacked columns or to let them render independent of each other.
Integer	groupZPadding The spacing between columns on the Z Axis in a 3D chart.
Integer	maxPointWidth The maximum allowed pixel width for a column, translated to the height of a bar in a bar chart.
String	onSeries The id of another series in the chart that the wind barbs are projected on.
Integer	pointWidth A pixel value specifying a fixed width for each column or bar.
Integer	vectorLength Pixel length of the stems.
Integer	yOffset Vertical offset from the cartesian position, in pixels.

Fields inherited from class org.fujion.highcharts.PlotOptions

allowPointSelect, animation, animationLimit, boostThreshold, className, color, colorByPoint, colorIndex, colors, connectEnds, connectNulls, cropThreshold, cursor, dashStyle, dataLabels, description, enableMouseTracking, exposeElementToA11y, findNearestPointBy, getExtremesFromAll, id, keys, label, linecap, lineWidth, linkedTo, marker, negativeColor, pointInterval, pointIntervalUnit, pointPlacement, pointStart, selected, shadow, showCheckbox, showInLegend, skipKeyboardNavigation, softThreshold, stacking, step, stickyTracking, threshold, tooltip, turboThreshold, type, visible, zoneAxis, zones

Constructor Summary

Constructors

Constructor and Description
PlotWindbarb()

Method Summary

Methods inherited from class org.fujion.highcharts.PlotOptions

toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.fujion.ancillary.OptionMap.IOptionMapConverter

transformForClient

Field Detail

edgeColor

@Option
public String edgeColor

3D columns only. The color of the edges. Similar to borderColor, except it defaults to the same color as the column. Defaults to undefined.

edgeWidth

@Option
public Integer edgeWidth

3D columns only. The width of the colored edges. Defaults to 1.

grouping

@Option
public 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. Defaults to true.

groupZPadding

@Option
public Integer groupZPadding

The spacing between columns on the Z Axis in a 3D chart. Requires highcharts-3d.js. Defaults to 1.

maxPointWidth

@Option
public Integer maxPointWidth

The maximum allowed pixel width for a column, translated to the height of a bar in a bar chart. This prevents the columns from becoming too wide when there is a small number of points in the chart. Defaults to null.

onSeries

@Option
public String onSeries

The id of another series in the chart that the wind barbs are projected on. When null, the wind symbols are drawn on the X axis, but offset up or down by the yOffset setting. Defaults to null.

pointWidth

@Option
public Integer pointWidth

A pixel value specifying a fixed width for each column or bar. When null, the width is calculated from the pointPadding and groupPadding. Defaults to null.

vectorLength

@Option
public Integer vectorLength

Pixel length of the stems. Defaults to 20.

yOffset

@Option
public Integer yOffset

Vertical offset from the cartesian position, in pixels. The default value makes sure the symbols don't overlap the X axis when onSeries is null, and that they don't overlap the linked series when onSeries is given. Defaults to -20.

Constructor Detail

PlotWindbarb

public PlotWindbarb()