org.fujion.highcharts

Class PlotPyramid

java.lang.Object

org.fujion.ancillary.Options

org.fujion.highcharts.PlotOptions

org.fujion.highcharts.PlotPyramid

All Implemented Interfaces:

OptionMap.IOptionMapConverter, IClientTransform

public class PlotPyramid
extends PlotOptions

Options for pyramid series.

A pyramid series is a special type of funnel, without neck and reversed by default.

Field Summary

Fields

Modifier and Type	Field and Description
List<String>	center The center of the series.
Integer	depth The thickness of a 3D pie.
Integer	endAngle The end angle of the pie in degrees where 0 is top and 90 is right.
String	height The height of the funnel or pyramid.
String	innerSize The size of the inner diameter for the pie.
Integer	minSize The minimum size for a pie in response to auto margins.
String	neckHeight The pyramid neck width is zero by default, as opposed to the funnel, which shares the same layout logic.
String	neckWidth The pyramid neck width is zero by default, as opposed to the funnel, which shares the same layout logic.
Boolean	reversed The pyramid is reversed by default, as opposed to the funnel, which shares the layout engine, and is not reversed.
Integer	startAngle The start angle of the pie slices in degrees where 0 is top and 90 right.
String	width The width of the funnel compared to the width of the plot area, or the pixel width if it is a number.

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
PlotPyramid()

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

center

@Option
public final List<String> center

The center of the series. By default, it is centered in the middle of the plot area, so it fills the plot area height. Defaults to ["50%", "50%"].

depth

@Option
public Integer depth

The thickness of a 3D pie. Requires highcharts-3d.js Defaults to 0.

endAngle

@Option
public Integer endAngle

The end angle of the pie in degrees where 0 is top and 90 is right. Defaults to startAngle plus 360. Defaults to null.

height

@Option
public String height

The height of the funnel or pyramid. If it is a number it defines the pixel height, if it is a percentage string it is the percentage of the plot area height. Defaults to 100%.

innerSize

@Option
public String innerSize

The size of the inner diameter for the pie. A size greater than 0 renders a donut chart. Can be a percentage or pixel value. Percentages are relative to the pie size. Pixel values are given as integers. Note: in Highcharts < 4.1.2, the percentage was relative to the plot area, not the pie size. Defaults to 0.

minSize

@Option
public Integer minSize

The minimum size for a pie in response to auto margins. The pie will try to shrink to make room for data labels in side the plot area, but only to this size. Defaults to 80.

neckHeight

@Option
public String neckHeight

The pyramid neck width is zero by default, as opposed to the funnel, which shares the same layout logic. Defaults to 0%.

neckWidth

@Option
public String neckWidth

The pyramid neck width is zero by default, as opposed to the funnel, which shares the same layout logic. Defaults to 0%.

reversed

@Option
public Boolean reversed

The pyramid is reversed by default, as opposed to the funnel, which shares the layout engine, and is not reversed. Defaults to true.

startAngle

@Option
public Integer startAngle

The start angle of the pie slices in degrees where 0 is top and 90 right. Defaults to 0.

width

@Option
public String width

The width of the funnel compared to the width of the plot area, or the pixel width if it is a number. Defaults to 90%.

Constructor Detail

PlotPyramid

public PlotPyramid()