HIFunnel

java.lang.Object
- java.util.Observable
- - com.highsoft.highcharts.core.HIFoundation
  - - com.highsoft.highcharts.common.hichartsclasses.HISeries
    - - com.highsoft.highcharts.common.hichartsclasses.HIFunnel

```
public class HIFunnel
extends HISeries
```
A `funnel` series. If the `type` option is not specified, it is inherited from `chart.type`. In TypeScript the `type` option must always be set. Configuration options for the series are given in three levels: 1. Options for all series in a chart are defined in the `plotOptions.series` object. 2. Options for all `funnel` series are defined in `plotOptions.funnel`. 3. Options for one single series are given in `the series instance array`. ``` Highcharts.chart('container', { plotOptions: { series: { // general options for all series }, funnel: { // shared options for all funnel series } }, series: [{ // specific options for this series instance type: 'funnel' }] }); ```

Constructor Summary

Constructors
Constructor and Description

HIFunnel()

Constructors
Constructor and Description
`HIFunnel()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HIColor`	`getBorderColor()`
`java.lang.Number`	`getBorderRadius()`
`java.lang.Number`	`getBorderWidth()`
`java.util.ArrayList`	`getCenter()`
`java.util.ArrayList<java.lang.String>`	`getColors()`
`java.lang.Number`	`getDepth()`
`java.lang.Number`	`getEndAngle()`
`HIColor`	`getFillColor()`
`java.lang.Object`	`getHeight()`
`java.lang.Boolean`	`getIgnoreHiddenPoint()`
`java.lang.Object`	`getMinSize()`
`java.lang.Object`	`getNeckHeight()`
`java.lang.Object`	`getNeckWidth()`
`java.util.HashMap<java.lang.String,java.lang.Object>`	`getParams()`
`java.lang.Boolean`	`getReversed()`
`java.lang.Number`	`getSlicedOffset()`
`java.lang.Number`	`getStartAngle()`
`java.lang.Number`	`getThickness()`
`java.lang.Object`	`getWidth()`
`void`	`setBorderColor(HIColor borderColor)` The color of the border surrounding each slice.
`void`	`setBorderRadius(java.lang.Number borderRadius)` /** * description: The corner radius of the border surrounding all points or series.
`void`	`setBorderWidth(java.lang.Number borderWidth)` The width of the border surrounding each slice.
`void`	`setCenter(java.util.ArrayList center)` /** * description: The center of the series.
`void`	`setColors(java.util.ArrayList<java.lang.String> colors)` A series specific or series type specific color set to use instead of the global `colors`.
`void`	`setDepth(java.lang.Number depth)` The thickness of a 3D pie.
`void`	`setEndAngle(java.lang.Number endAngle)` The end angle of the pie in degrees where 0 is top and 90 is right.
`void`	`setFillColor(HIColor fillColor)` If the total sum of the pie's values is 0, the series is represented as an empty circle .
`void`	`setHeight(java.lang.Object height)` The height of the funnel or pyramid.
`void`	`setIgnoreHiddenPoint(java.lang.Boolean ignoreHiddenPoint)` Equivalent to `chart.ignoreHiddenSeries`, this option tells whether the series shall be redrawn as if the hidden point were `null`.
`void`	`setMinSize(java.lang.Object minSize)` The minimum size for a pie in response to auto margins.
`void`	`setNeckHeight(java.lang.Object neckHeight)` The height of the neck, the lower part of the funnel.
`void`	`setNeckWidth(java.lang.Object neckWidth)` The width of the neck, the lower part of the funnel.
`void`	`setReversed(java.lang.Boolean reversed)` A reversed funnel has the widest area down.
`void`	`setSlicedOffset(java.lang.Number slicedOffset)` If a point is sliced, moved out from the center, how many pixels should it be moved?.
`void`	`setStartAngle(java.lang.Number startAngle)` The start angle of the pie slices in degrees where 0 is top and 90 right.
`void`	`setThickness(java.lang.Number thickness)` Thickness describing the ring size for a donut type chart, overriding `innerSize`.
`void`	`setWidth(java.lang.Object width)` The width of the funnel compared to the width of the plot area, or the pixel width if it is a number.

Methods inherited from class com.highsoft.highcharts.common.hichartsclasses.HISeries
addPoint, addPoint, addPoint, addPoint, animate, drawGraph, drawPoints, getAccessibility, getAllowPointSelect, getAnimation, getAnimationLimit, getBoostBlending, getBoostThreshold, getClassName, getClip, getColor, getColorAxis, getColorIndex, getColorKey, getConnectEnds, getConnectNulls, getCrisp, getCropThreshold, getCursor, getCustom, getDashStyle, getData, getDataLabels, getDataSorting, getDefinition, getDescribeSingleSeries, getDescriptionFormat, getDescriptionFormatter, getDragDrop, getEnableMouseTracking, getEvents, getFindNearestPointBy, getGetExtremesFromAll, getId, getInactiveOtherPoints, getIncludeInDataExport, getIndex, getKeys, getLabel, getLegendIndex, getLegendSymbol, getLinecap, getLineWidth, getLinkedTo, getMarker, getName, getNegativeColor, getNullPointValue, getOnPoint, getOpacity, getPoint, getPointAnnotationsDescription, getPointDescriptionEnabledThreshold, getPointDescriptionFormat, getPointDescriptionFormatter, getPointInterval, getPointIntervalUnit, getPointPlacement, getPointStart, getRelativeXValue, getSelected, getShadow, getShowCheckbox, getShowInLegend, getSkipKeyboardNavigation, getSoftThreshold, getSonification, getStack, getStacking, getStates, getStep, getStickyTracking, getSummary, getThreshold, getTooltip, getTurboThreshold, getType, getVisible, getXAxis, getXAxisDescription, getYAxis, getYAxisDescription, getZIndex, getZoneAxis, getZones, hide, onMouseOut, onMouseOver, remove, remove, remove, remove, removePoint, removePoint, removePoint, render, select, select, setAccessibility, setAllowPointSelect, setAnimation, setAnimationLimit, setBoostBlending, setBoostThreshold, setClassName, setClip, setColor, setColorAxis, setColorIndex, setColorKey, setConnectEnds, setConnectNulls, setCrisp, setCropThreshold, setCursor, setCustom, setDashStyle, setData, setDataLabels, setDataSorting, setDefinition, setDescribeSingleSeries, setDescriptionFormat, setDescriptionFormatter, setDragDrop, setEnableMouseTracking, setEvents, setFindNearestPointBy, setGetExtremesFromAll, setId, setInactiveOtherPoints, setIncludeInDataExport, setIndex, setKeys, setLabel, setLegendIndex, setLegendSymbol, setLinecap, setLineWidth, setLinkedTo, setMarker, setName, setNegativeColor, setNullPointValue, setOnPoint, setOpacity, setOptions, setPoint, setPointAnnotationsDescription, setPointDescriptionEnabledThreshold, setPointDescriptionFormat, setPointDescriptionFormatter, setPointInterval, setPointIntervalUnit, setPointPlacement, setPointStart, setProperty, setRelativeXValue, setSelected, setSeriesData, setSeriesData, setSeriesData, setSeriesData, setSeriesVisible, setSeriesVisible, setSeriesVisible, setShadow, setShowCheckbox, setShowInLegend, setSkipKeyboardNavigation, setSoftThreshold, setSonification, setStack, setStacking, setState, setState, setStates, setStep, setStickyTracking, setSummary, setThreshold, setTooltip, setTurboThreshold, setType, setVisible, setXAxis, setXAxisDescription, setYAxis, setYAxisDescription, setZIndex, setZoneAxis, setZones, show, sonify, translate, update, update

Methods inherited from class java.util.Observable
addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HIFunnel
```
public HIFunnel()
```
- Method Detail
  - getBorderColor
```
public HIColor getBorderColor()
```
  - getBorderRadius
```
public java.lang.Number getBorderRadius()
```
  - getBorderWidth
```
public java.lang.Number getBorderWidth()
```
  - getCenter
```
public java.util.ArrayList getCenter()
```
  - getColors
```
public java.util.ArrayList<java.lang.String> getColors()
```
  - getDepth
```
public java.lang.Number getDepth()
```
  - getEndAngle
```
public java.lang.Number getEndAngle()
```
  - getFillColor
```
public HIColor getFillColor()
```
  - getHeight
```
public java.lang.Object getHeight()
```
  - getIgnoreHiddenPoint
```
public java.lang.Boolean getIgnoreHiddenPoint()
```
  - getMinSize
```
public java.lang.Object getMinSize()
```
  - getNeckHeight
```
public java.lang.Object getNeckHeight()
```
  - getNeckWidth
```
public java.lang.Object getNeckWidth()
```
  - getParams
```
public java.util.HashMap<java.lang.String,java.lang.Object> getParams()
```
    Overrides:
    
    getParams in class HISeries
  - getReversed
```
public java.lang.Boolean getReversed()
```
  - getSlicedOffset
```
public java.lang.Number getSlicedOffset()
```
  - getStartAngle
```
public java.lang.Number getStartAngle()
```
  - getThickness
```
public java.lang.Number getThickness()
```
  - getWidth
```
public java.lang.Object getWidth()
```
  - setBorderColor
```
public void setBorderColor(HIColor borderColor)
```
    The color of the border surrounding each slice. When `null`, the border takes the same color as the slice fill. This can be used together with a `borderWidth` to fill drawing gaps created by antialiazing artefacts in borderless pies. In styled mode, the border stroke is given in the `.highcharts-point` class.
    
    defaults:
    
    #ffffff
  - setBorderRadius
```
public void setBorderRadius(java.lang.Number borderRadius)
```
    /** * description: The corner radius of the border surrounding all points or series. A number signifies pixels. A percentage string, like for example `50%`, signifies a size relative to the series width. * demo: * [Funnel and pyramid with rounded border](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/funnel-border-radius)
  - setBorderWidth
```
public void setBorderWidth(java.lang.Number borderWidth)
```
    The width of the border surrounding each slice. When setting the border width to 0, there may be small gaps between the slices due to SVG antialiasing artefacts. To work around this, keep the border width at 0.5 or 1, but set the `borderColor` to `null` instead. In styled mode, the border stroke width is given in the `.highcharts-point` class.
    
    defaults:
    
    1
  - setCenter
```
public void setCenter(java.util.ArrayList center)
```
    /** * description: The center of the series. By defaults, it is centered in the middle of the plot area, so it fills the plot area height. * demo: * [Centered at 100, 100](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/pie-center/) defaults: ["50%", "50%"]
  - setColors
```
public void setColors(java.util.ArrayList<java.lang.String> colors)
```
    A series specific or series type specific color set to use instead of the global `colors`.
  - setDepth
```
public void setDepth(java.lang.Number depth)
```
    The thickness of a 3D pie.
    
    defaults:
    
    0
  - setEndAngle
```
public void setEndAngle(java.lang.Number endAngle)
```
    The end angle of the pie in degrees where 0 is top and 90 is right. Defaults to `startAngle` plus 360.
  - setFillColor
```
public void setFillColor(HIColor fillColor)
```
    If the total sum of the pie's values is 0, the series is represented as an empty circle . The `fillColor` option defines the color of that circle. Use `pie.borderWidth` to set the border thickness.
    
    defaults:
    
    undefined
  - setHeight
```
public void setHeight(java.lang.Object 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:
    
    100%
  - setIgnoreHiddenPoint
```
public void setIgnoreHiddenPoint(java.lang.Boolean ignoreHiddenPoint)
```
    Equivalent to `chart.ignoreHiddenSeries`, this option tells whether the series shall be redrawn as if the hidden point were `null`. The defaults value changed from `false` to `true` with Highcharts 3.0.
    
    defaults:
    
    True
  - setMinSize
```
public void setMinSize(java.lang.Object 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:
    
    80
  - setNeckHeight
```
public void setNeckHeight(java.lang.Object neckHeight)
```
    The height of the neck, the lower part of the funnel. A number defines pixel width, a percentage string defines a percentage of the plot area height.
    
    defaults:
    
    25%
  - setNeckWidth
```
public void setNeckWidth(java.lang.Object neckWidth)
```
    The width of the neck, the lower part of the funnel. A number defines pixel width, a percentage string defines a percentage of the plot area width.
    
    defaults:
    
    30%
  - setReversed
```
public void setReversed(java.lang.Boolean reversed)
```
    A reversed funnel has the widest area down. A reversed funnel with no neck width and neck height is a pyramid.
  - setSlicedOffset
```
public void setSlicedOffset(java.lang.Number slicedOffset)
```
    If a point is sliced, moved out from the center, how many pixels should it be moved?.
    
    defaults:
    
    10
  - setStartAngle
```
public void setStartAngle(java.lang.Number startAngle)
```
    The start angle of the pie slices in degrees where 0 is top and 90 right.
    
    defaults:
    
    0
  - setThickness
```
public void setThickness(java.lang.Number thickness)
```
    Thickness describing the ring size for a donut type chart, overriding `innerSize`.
    
    defaults:
    
    undefined
  - setWidth
```
public void setWidth(java.lang.Object width)
```
    The width of the funnel compared to the width of the plot area, or the pixel width if it is a number.
    
    defaults:
    
    90%

Class HIFunnel

Constructor Summary

Method Summary

Methods inherited from class com.highsoft.highcharts.common.hichartsclasses.HISeries

Methods inherited from class java.util.Observable

Methods inherited from class java.lang.Object

Constructor Detail

HIFunnel

Method Detail

getBorderColor

getBorderRadius

getBorderWidth

getCenter

getColors

getDepth

getEndAngle

getFillColor

getHeight

getIgnoreHiddenPoint

getMinSize

getNeckHeight

getNeckWidth

getParams

getReversed

getSlicedOffset

getStartAngle

getThickness

getWidth

setBorderColor

setBorderRadius

setBorderWidth

setCenter

setColors

setDepth

setEndAngle

setFillColor

setHeight

setIgnoreHiddenPoint

setMinSize

setNeckHeight

setNeckWidth

setReversed

setSlicedOffset

setStartAngle

setThickness

setWidth