HIPyramid3d

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

```
public class HIPyramid3d
extends HISeries
```
A `pyramid3d` 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 `pyramid3d` series are defined in `plotOptions.pyramid3d`. 3. Options for one single series are given in `the series instance array`. ``` Highcharts.chart('container', { plotOptions: { series: { // general options for all series }, pyramid3d: { // shared options for all pyramid3d series } }, series: [{ // specific options for this series instance type: 'pyramid3d' }] }); ```

Constructor Summary

Constructors
Constructor and Description

HIPyramid3d()

Constructors
Constructor and Description
`HIPyramid3d()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HIColor`	`getBorderColor()`
`HIBorderRadiusOptionsObject`	`getBorderRadius()`
`java.lang.Number`	`getBorderWidth()`
`java.lang.Boolean`	`getCenterInCategory()`
`java.lang.Boolean`	`getColorByPoint()`
`java.util.ArrayList<java.lang.String>`	`getColors()`
`java.lang.Number`	`getDepth()`
`HIColor`	`getEdgeColor()`
`java.lang.Number`	`getEdgeWidth()`
`java.lang.Boolean`	`getGradientForSides()`
`java.lang.Boolean`	`getGrouping()`
`java.lang.Number`	`getGroupPadding()`
`java.lang.Number`	`getGroupZPadding()`
`java.lang.Object`	`getHeight()`
`java.lang.Number`	`getMaxPointWidth()`
`java.lang.Number`	`getMinPointLength()`
`java.util.HashMap<java.lang.String,java.lang.Object>`	`getParams()`
`java.lang.Number`	`getPointPadding()`
`java.lang.Number`	`getPointRange()`
`java.lang.Number`	`getPointWidth()`
`java.lang.Boolean`	`getReversed()`
`java.lang.Object`	`getWidth()`
`void`	`setBorderColor(HIColor borderColor)` The color of the border surrounding each column or bar.
`void`	`setBorderRadius(HIBorderRadiusOptionsObject borderRadius)` The corner radius of the border surrounding each column or bar.
`void`	`setBorderWidth(java.lang.Number borderWidth)` The width of the border surrounding each column or bar.
`void`	`setCenterInCategory(java.lang.Boolean centerInCategory)` When `true`, the columns will center in the category, ignoring null or missing points.
`void`	`setColorByPoint(java.lang.Boolean colorByPoint)` /** * description: When using automatic point colors pulled from the global `colors` or series-specific `plotOptions.column.colors` collections, this option determines whether the chart should receive one color per series or one color per point.
`void`	`setColors(java.util.ArrayList<java.lang.String> colors)` A series specific or series type specific color set to apply instead of the global `colors` when `colorByPoint` is true.
`void`	`setDepth(java.lang.Number depth)` Depth of the columns in a 3D column chart.
`void`	`setEdgeColor(HIColor edgeColor)` 3D columns only.
`void`	`setEdgeWidth(java.lang.Number edgeWidth)` /** * description: 3D columns only.
`void`	`setGradientForSides(java.lang.Boolean gradientForSides)` By defaults sides fill is set to a gradient through this option being set to `true`.
`void`	`setGrouping(java.lang.Boolean grouping)` Whether to group non-stacked columns or to let them render independent of each other.
`void`	`setGroupPadding(java.lang.Number groupPadding)` Padding between each value groups, in x axis units.
`void`	`setGroupZPadding(java.lang.Number groupZPadding)` The spacing between columns on the Z Axis in a 3D chart.
`void`	`setHeight(java.lang.Object height)` The height of the series.
`void`	`setMaxPointWidth(java.lang.Number maxPointWidth)` The maximum allowed pixel width for a column, translated to the height of a bar in a bar chart.
`void`	`setMinPointLength(java.lang.Number minPointLength)` The minimal height for a column or width for a bar.
`void`	`setPointPadding(java.lang.Number pointPadding)` Padding between each column or bar, in x axis units.
`void`	`setPointRange(java.lang.Number pointRange)` The X axis range that each point is valid for.
`void`	`setPointWidth(java.lang.Number pointWidth)` A pixel value specifying a fixed width for each column or bar point.
`void`	`setReversed(java.lang.Boolean reversed)` /** * description: A reversed pyramid3d is funnel3d, but the latter supports neck related options: neckHeight and neckWidth defaults: True
`void`	`setWidth(java.lang.Object width)` The max width of the series 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
  - HIPyramid3d
```
public HIPyramid3d()
```
- Method Detail
  - getBorderColor
```
public HIColor getBorderColor()
```
  - getBorderRadius
```
public HIBorderRadiusOptionsObject getBorderRadius()
```
  - getBorderWidth
```
public java.lang.Number getBorderWidth()
```
  - getCenterInCategory
```
public java.lang.Boolean getCenterInCategory()
```
  - getColorByPoint
```
public java.lang.Boolean getColorByPoint()
```
  - getColors
```
public java.util.ArrayList<java.lang.String> getColors()
```
  - getDepth
```
public java.lang.Number getDepth()
```
  - getEdgeColor
```
public HIColor getEdgeColor()
```
  - getEdgeWidth
```
public java.lang.Number getEdgeWidth()
```
  - getGradientForSides
```
public java.lang.Boolean getGradientForSides()
```
  - getGrouping
```
public java.lang.Boolean getGrouping()
```
  - getGroupPadding
```
public java.lang.Number getGroupPadding()
```
  - getGroupZPadding
```
public java.lang.Number getGroupZPadding()
```
  - getHeight
```
public java.lang.Object getHeight()
```
  - getMaxPointWidth
```
public java.lang.Number getMaxPointWidth()
```
  - getMinPointLength
```
public java.lang.Number getMinPointLength()
```
  - getParams
```
public java.util.HashMap<java.lang.String,java.lang.Object> getParams()
```
    Overrides:
    
    getParams in class HISeries
  - getPointPadding
```
public java.lang.Number getPointPadding()
```
  - getPointRange
```
public java.lang.Number getPointRange()
```
  - getPointWidth
```
public java.lang.Number getPointWidth()
```
  - getReversed
```
public java.lang.Boolean getReversed()
```
  - getWidth
```
public java.lang.Object getWidth()
```
  - setBorderColor
```
public void setBorderColor(HIColor borderColor)
```
    The color of the border surrounding each column or bar. In styled mode, the border stroke can be set with the `.highcharts-point` rule.
    
    defaults:
    
    #ffffff
  - setBorderRadius
```
public void setBorderRadius(HIBorderRadiusOptionsObject borderRadius)
```
    The corner radius of the border surrounding each column or bar. A number signifies pixels. A percentage string, like for example `50%`, signifies a relative size. For columns this is relative to the column width, for pies it is relative to the radius and the inner radius.
    
    defaults:
    
    3
  - setBorderWidth
```
public void setBorderWidth(java.lang.Number borderWidth)
```
    The width of the border surrounding each column or bar. Defaults to `1` when there is room for a border, but to `0` when the columns are so dense that a border would cover the next column. In styled mode, the stroke width can be set with the `.highcharts-point` rule.
    
    defaults:
    
    undefined
  - setCenterInCategory
```
public void setCenterInCategory(java.lang.Boolean centerInCategory)
```
    When `true`, the columns will center in the category, ignoring null or missing points. When `false`, space will be reserved for null or missing points.
  - setColorByPoint
```
public void setColorByPoint(java.lang.Boolean colorByPoint)
```
    /** * description: When using automatic point colors pulled from the global `colors` or series-specific `plotOptions.column.colors` collections, this option determines whether the chart should receive one color per series or one color per point. In styled mode, the `colors` or `series.colors` arrays are not supported, and instead this option gives the points individual color class names on the form `highcharts-color-{n}`. * demo: * [False by defaults](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/column-colorbypoint-false/) * [True](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/column-colorbypoint-true/) defaults: True
  - setColors
```
public void setColors(java.util.ArrayList<java.lang.String> colors)
```
    A series specific or series type specific color set to apply instead of the global `colors` when `colorByPoint` is true.
  - setDepth
```
public void setDepth(java.lang.Number depth)
```
    Depth of the columns in a 3D column chart.
    
    defaults:
    
    25
  - setEdgeColor
```
public void setEdgeColor(HIColor edgeColor)
```
    3D columns only. The color of the edges. Similar to `borderColor`, except it defaultss to the same color as the column.
  - setEdgeWidth
```
public void setEdgeWidth(java.lang.Number edgeWidth)
```
    /** * description: 3D columns only. The width of the colored edges.
  - setGradientForSides
```
public void setGradientForSides(java.lang.Boolean gradientForSides)
```
    By defaults sides fill is set to a gradient through this option being set to `true`. Set to `false` to get solid color for the sides.
    
    defaults:
    
    True
  - setGrouping
```
public void setGrouping(java.lang.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:
    
    true
  - setGroupPadding
```
public void setGroupPadding(java.lang.Number groupPadding)
```
    Padding between each value groups, in x axis units.
    
    defaults:
    
    0.2
  - setGroupZPadding
```
public void setGroupZPadding(java.lang.Number groupZPadding)
```
    The spacing between columns on the Z Axis in a 3D chart.
    
    defaults:
    
    1
  - setHeight
```
public void setHeight(java.lang.Object height)
```
    The height of the series. 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%
  - setMaxPointWidth
```
public void setMaxPointWidth(java.lang.Number 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.
  - setMinPointLength
```
public void setMinPointLength(java.lang.Number minPointLength)
```
    The minimal height for a column or width for a bar. By defaults, 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.
  - setPointPadding
```
public void setPointPadding(java.lang.Number pointPadding)
```
    Padding between each column or bar, in x axis units.
    
    defaults:
    
    0.1
  - setPointRange
```
public void setPointRange(java.lang.Number 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 defaults (one category unit). On linear and datetime axes, the range will be computed as the distance between the two closest data points. The defaults `null` means it is computed automatically, but this option can be used to override the automatic value. This option is set by defaults to 1 if data sorting is enabled.
  - setPointWidth
```
public void setPointWidth(java.lang.Number pointWidth)
```
    A pixel value specifying a fixed width for each column or bar point. When set to `undefined`, the width is calculated from the `pointPadding` and `groupPadding`. The width effects the dimension that is not based on the point value. For column series it is the horizontal length and for bar series it is the vertical length.
  - setReversed
```
public void setReversed(java.lang.Boolean reversed)
```
    /** * description: A reversed pyramid3d is funnel3d, but the latter supports neck related options: neckHeight and neckWidth defaults: True
  - setWidth
```
public void setWidth(java.lang.Object width)
```
    The max width of the series compared to the width of the plot area, or the pixel width if it is a number.
    
    defaults:
    
    90%

Class HIPyramid3d

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

HIPyramid3d

Method Detail

getBorderColor

getBorderRadius

getBorderWidth

getCenterInCategory

getColorByPoint

getColors

getDepth

getEdgeColor

getEdgeWidth

getGradientForSides

getGrouping

getGroupPadding

getGroupZPadding

getHeight

getMaxPointWidth

getMinPointLength

getParams

getPointPadding

getPointRange

getPointWidth

getReversed

getWidth

setBorderColor

setBorderRadius

setBorderWidth

setCenterInCategory

setColorByPoint

setColors

setDepth

setEdgeColor

setEdgeWidth

setGradientForSides

setGrouping

setGroupPadding

setGroupZPadding

setHeight

setMaxPointWidth

setMinPointLength

setPointPadding

setPointRange

setPointWidth

setReversed

setWidth