Class PlotOptionsPyramid
- All Implemented Interfaces:
Serializable
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds color to the colors arrayvoid
Adds key to the keys arrayvoid
Adds zone to the zones arrayString[]
getClip()
Color[]
getCrisp()
getDepth()
String[]
getKeys()
getWidth()
Zones[]
getZones()
void
removeColor
(Color color) Removes first occurrence of color in colors arrayvoid
Removes first occurrence of key in keys arrayvoid
removeZone
(Zones zone) Removes first occurrence of zone in zones arrayvoid
setAllowPointSelect
(Boolean allowPointSelect) Allow this series' points to be selected by clicking on the markers, bars or pie slices.void
setAnimationLimit
(Number animationLimit) For some series, there is a limit that shuts down initial animation by default when the total number of points in the chart is too high.void
setBorderColor
(Color borderColor) The color of the border surrounding each slice.void
setBorderWidth
(Number borderWidth) The width of the border surrounding each slice.void
The center of the series.void
void
setClassName
(String className) A class name to apply to the series' graphical elements.void
Disable this option to allow series rendering in the whole plotting area.void
setColorIndex
(Number colorIndex) Styled mode only.void
setColorKey
(String colorKey) Determines what data value should be used to calculate point color ifcolorAxis
is used.void
A series specific or series type specific color set to use instead of the global colors.void
When true, each point or column edge is rounded to its nearest pixel in order to render sharp on screen.void
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.void
setDataLabels
(DataLabelsFunnel dataLabels) Specific data labels configuration for a series typevoid
The thickness of a 3D pie.void
setDescription
(String description) Requires Accessibility modulevoid
setEnableMouseTracking
(Boolean enableMouseTracking) Enable or disable the mouse tracking for a specific series.void
setExposeElementToA11y
(Boolean exposeElementToA11y) By default, series are exposed to screen readers as regions.void
setFindNearestPointBy
(Dimension findNearestPointBy) Determines whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series.void
setGetExtremesFromAll
(Boolean getExtremesFromAll) Whether to use the Y extremes of the total chart width or only the zoomed area when zooming in on parts of the X axis.void
The height of the funnel or pyramid.void
setIgnoreHiddenPoint
(Boolean ignoreHiddenPoint) This option tells whether the series shall be redrawn as if the hidden point were null.void
An array specifying which option maps to which key in the data point array.void
setLinkedTo
(String linkedTo) The id of another series to link to.void
setMinSize
(Number minSize) The minimum size for a pie in response to auto margins.void
setOpacity
(Number opacity) Opacity of a series parts: line, fill (e.g.void
setPointDescriptionFormatter
(String _fn_pointDescriptionFormatter) void
setReversed
(Boolean reversed) The pyramid is reversed by default, as opposed to the funnel, which shares the layout engine, and is not reversed.void
setSelected
(Boolean selected) Whether to select the series initially.void
Whether to apply a drop shadow to the graph line.void
setShowInLegend
(Boolean showInLegend) Whether to display this particular series or series type in the legend.void
setSkipKeyboardNavigation
(Boolean skipKeyboardNavigation) If set toTrue
, the accessibility module will skip past the points in this series for keyboard navigation.void
setSlicedOffset
(Number slicedOffset) If a point is sliced, moved out from the center, how many pixels should it be moved?.void
A wrapper object for all the series options in specific states.void
setStickyTracking
(Boolean stickyTracking) Sticky tracking of mouse events.void
setTooltip
(SeriesTooltip tooltip) A configuration object for the tooltip rendering of each single series.void
setVisible
(Boolean visible) Set the initial visibility of the series.void
The width of the funnel compared to the width of the plot area, or the pixel width if it is a number.void
setZoneAxis
(ZoneAxis zoneAxis) Defines the Axis on which the zones are applied.void
An array defining zones within a series.
-
Constructor Details
-
PlotOptionsPyramid
public PlotOptionsPyramid()
-
-
Method Details
-
getChartType
- Specified by:
getChartType
in classPyramidOptions
-
getAllowPointSelect
- Specified by:
getAllowPointSelect
in classPyramidOptions
- See Also:
-
setAllowPointSelect
Allow this series' points to be selected by clicking on the markers, bars or pie slices.Defaults to: false
- Specified by:
setAllowPointSelect
in classPyramidOptions
-
getAnimationLimit
- Specified by:
getAnimationLimit
in classPyramidOptions
- See Also:
-
setAnimationLimit
For some series, there is a limit that shuts down initial animation by default when the total number of points in the chart is too high. For example, for a column chart and its derivatives, animation doesn't run if there is more than 250 points totally. To disable this cap, setanimationLimit
toInfinity
.- Specified by:
setAnimationLimit
in classPyramidOptions
-
getBorderColor
- See Also:
-
setBorderColor
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 aborderWidth
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 to: #ffffff
-
getBorderWidth
- See Also:
-
setBorderWidth
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
tonull
instead.In styled mode, the border stroke width is given in the
.highcharts-point
class.Defaults to: 1
-
setCenter
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%"]
- Specified by:
setCenter
in classPyramidOptions
-
getClassName
- Specified by:
getClassName
in classPyramidOptions
- See Also:
-
setClassName
A class name to apply to the series' graphical elements.- Specified by:
setClassName
in classPyramidOptions
-
getClip
- Specified by:
getClip
in classPyramidOptions
- See Also:
-
setClip
Disable this option to allow series rendering in the whole plotting area. Note that clipping should be always enabled when chart.zoomType is set.Defaults to
false
.- Specified by:
setClip
in classPyramidOptions
-
getColorIndex
- Specified by:
getColorIndex
in classPyramidOptions
- See Also:
-
setColorIndex
Styled mode only. A specific color index to use for the series, so its graphic representations are given the class namehighcharts-color-{n}
.- Specified by:
setColorIndex
in classPyramidOptions
-
getColorKey
- Specified by:
getColorKey
in classPyramidOptions
- See Also:
-
setColorKey
Determines what data value should be used to calculate point color ifcolorAxis
is used. Requires to setmin
andmax
if some custom point property is used or if approximation for data grouping is set to'sum'
.Defaults to
y
.- Specified by:
setColorKey
in classPyramidOptions
-
getColors
- Specified by:
getColors
in classPyramidOptions
- See Also:
-
setColors
A series specific or series type specific color set to use instead of the global colors.- Specified by:
setColors
in classPyramidOptions
-
addColor
Adds color to the colors array- Specified by:
addColor
in classPyramidOptions
- Parameters:
color
- to add- See Also:
-
removeColor
Removes first occurrence of color in colors array- Specified by:
removeColor
in classPyramidOptions
- Parameters:
color
- to remove- See Also:
-
getCrisp
- Specified by:
getCrisp
in classPyramidOptions
- See Also:
-
setCrisp
When true, each point or column edge is rounded to its nearest pixel in order to render sharp on screen. In some cases, when there are a lot of densely packed columns, this leads to visible difference in column widths or distance between columns. In these cases, settingcrisp
tofalse
may look better, even though each column is rendered blurry.Defaults to
true
.- Specified by:
setCrisp
in classPyramidOptions
-
getCursor
- Specified by:
getCursor
in classPyramidOptions
- See Also:
-
setCursor
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.- Specified by:
setCursor
in classPyramidOptions
-
getDataLabels
- Specified by:
getDataLabels
in classPyramidOptions
- See Also:
-
setDataLabels
Description copied from class:PyramidOptions
Specific data labels configuration for a series type- Specified by:
setDataLabels
in classPyramidOptions
-
getDepth
- Specified by:
getDepth
in classPyramidOptions
- See Also:
-
setDepth
The thickness of a 3D pie. Requireshighcharts-3d.js
Defaults to: 0
- Specified by:
setDepth
in classPyramidOptions
-
getDescription
- Specified by:
getDescription
in classPyramidOptions
- See Also:
-
setDescription
Requires Accessibility module
A description of the series to add to the screen reader information about the series.
Defaults to: undefined
- Specified by:
setDescription
in classPyramidOptions
-
getEnableMouseTracking
- Specified by:
getEnableMouseTracking
in classPyramidOptions
- See Also:
-
setEnableMouseTracking
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.Defaults to: true
- Specified by:
setEnableMouseTracking
in classPyramidOptions
-
getExposeElementToA11y
- Specified by:
getExposeElementToA11y
in classPyramidOptions
- See Also:
-
setExposeElementToA11y
By default, series are exposed to screen readers as regions. By enabling this option, the series element itself will be exposed in the same way as the data points. This is useful if the series is not used as a grouping entity in the chart, but you still want to attach a description to the series.
Requires the Accessibility module.
Defaults to: undefined
- Specified by:
setExposeElementToA11y
in classPyramidOptions
-
getFindNearestPointBy
- Specified by:
getFindNearestPointBy
in classPyramidOptions
- See Also:
-
setFindNearestPointBy
Determines whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series. Defaults to
'xy'
for scatter series and'x'
for most other series. If the data has duplicate x-values, it is recommended to set this to'xy'
to allow hovering over all points.Applies only to series types using nearest neighbor search (not direct hover) for tooltip.
- Specified by:
setFindNearestPointBy
in classPyramidOptions
-
getGetExtremesFromAll
- Specified by:
getGetExtremesFromAll
in classPyramidOptions
- See Also:
-
setGetExtremesFromAll
Whether to use the Y extremes of the total chart width or only the zoomed area when zooming in on parts of the X axis. By default, the Y axis adjusts to the min and max of the visible data. Cartesian series only.Defaults to: false
- Specified by:
setGetExtremesFromAll
in classPyramidOptions
-
getHeight
- Specified by:
getHeight
in classPyramidOptions
- See Also:
-
setHeight
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.- Specified by:
setHeight
in classPyramidOptions
- Parameters:
height
- CSS style string representation
-
getIgnoreHiddenPoint
- Specified by:
getIgnoreHiddenPoint
in classPyramidOptions
- See Also:
-
setIgnoreHiddenPoint
This option tells whether the series shall be redrawn as if the hidden point were null.Defaults to
true
.- Specified by:
setIgnoreHiddenPoint
in classPyramidOptions
-
getKeys
- Specified by:
getKeys
in classPyramidOptions
- See Also:
-
setKeys
An array specifying which option maps to which key in the data point array. This makes it convenient to work with unstructured data arrays from different sources.- Specified by:
setKeys
in classPyramidOptions
-
addKey
Adds key to the keys array- Specified by:
addKey
in classPyramidOptions
- Parameters:
key
- to add- See Also:
-
removeKey
Removes first occurrence of key in keys array- Specified by:
removeKey
in classPyramidOptions
- Parameters:
key
- to remove- See Also:
-
getLinkedTo
- Specified by:
getLinkedTo
in classPyramidOptions
- See Also:
-
setLinkedTo
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.- Specified by:
setLinkedTo
in classPyramidOptions
-
getMinSize
- Specified by:
getMinSize
in classPyramidOptions
- See Also:
-
setMinSize
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
- Specified by:
setMinSize
in classPyramidOptions
-
getOpacity
- Specified by:
getOpacity
in classPyramidOptions
- See Also:
-
setOpacity
Opacity of a series parts: line, fill (e.g. area) and dataLabels.Defaults to
1
.- Specified by:
setOpacity
in classPyramidOptions
-
getPointDescriptionFormatter
- Specified by:
getPointDescriptionFormatter
in classPyramidOptions
-
setPointDescriptionFormatter
- Specified by:
setPointDescriptionFormatter
in classPyramidOptions
-
getReversed
- Specified by:
getReversed
in classPyramidOptions
- See Also:
-
setReversed
The pyramid is reversed by default, as opposed to the funnel, which shares the layout engine, and is not reversed.Defaults to: true
- Specified by:
setReversed
in classPyramidOptions
-
getSelected
- Specified by:
getSelected
in classPyramidOptions
- See Also:
-
setSelected
Whether to select the series initially. IfshowCheckbox
is true, the checkbox next to the series name will be checked for a selected series.Defaults to: false
- Specified by:
setSelected
in classPyramidOptions
-
getShadow
- Specified by:
getShadow
in classPyramidOptions
- See Also:
-
setShadow
Whether to apply a drop shadow to the graph line. Since 2.3 the shadow can be an object configuration containingcolor
,offsetX
,offsetY
,opacity
andwidth
.Defaults to: false
- Specified by:
setShadow
in classPyramidOptions
-
getShowInLegend
- Specified by:
getShowInLegend
in classPyramidOptions
- See Also:
-
setShowInLegend
Whether to display this particular series or series type in the legend. Since 2.1, pies are not shown in the legend by default.Defaults to: false
- Specified by:
setShowInLegend
in classPyramidOptions
-
getSlicedOffset
- Specified by:
getSlicedOffset
in classPyramidOptions
- See Also:
-
setSlicedOffset
If a point is sliced, moved out from the center, how many pixels should it be moved?.Defaults to: 10
- Specified by:
setSlicedOffset
in classPyramidOptions
-
getStates
- Specified by:
getStates
in classPyramidOptions
- See Also:
-
setStates
A wrapper object for all the series options in specific states.- Specified by:
setStates
in classPyramidOptions
-
getStickyTracking
- Specified by:
getStickyTracking
in classPyramidOptions
- See Also:
-
setStickyTracking
Sticky tracking of mouse events. When true, themouseOut
event on a series isn't triggered until the mouse moves over another series, or out of the plot area. When false, themouseOut
event on a series is triggered when the mouse leaves the area around the series' graph or markers. This also implies the tooltip. WhenstickyTracking
is false andtooltip.shared
is false, the tooltip will be hidden when moving the mouse between series.Defaults to: false
- Specified by:
setStickyTracking
in classPyramidOptions
-
getTooltip
- Specified by:
getTooltip
in classPyramidOptions
- See Also:
-
setTooltip
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.- Specified by:
setTooltip
in classPyramidOptions
-
getVisible
- Specified by:
getVisible
in classPyramidOptions
- See Also:
-
setVisible
Set the initial visibility of the series.Defaults to: true
- Specified by:
setVisible
in classPyramidOptions
-
getWidth
- Specified by:
getWidth
in classPyramidOptions
- See Also:
-
setWidth
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%
- Specified by:
setWidth
in classPyramidOptions
- Parameters:
width
- CSS style string representation
-
getZoneAxis
- Specified by:
getZoneAxis
in classPyramidOptions
- See Also:
-
setZoneAxis
Defines the Axis on which the zones are applied.Defaults to: y
- Specified by:
setZoneAxis
in classPyramidOptions
-
getZones
- Specified by:
getZones
in classPyramidOptions
- See Also:
-
setZones
An array defining zones within a series. Zones can be applied to the X axis, Y axis or Z axis for bubbles, according to the
zoneAxis
option.In styled mode, the color zones are styled with the
.highcharts-zone-{n}
class, or custom classed from theclassName
option (view live demo).- Specified by:
setZones
in classPyramidOptions
-
addZone
Adds zone to the zones array- Specified by:
addZone
in classPyramidOptions
- Parameters:
zone
- to add- See Also:
-
removeZone
Removes first occurrence of zone in zones array- Specified by:
removeZone
in classPyramidOptions
- Parameters:
zone
- to remove- See Also:
-
setCenter
- Specified by:
setCenter
in classPyramidOptions
-
getCenter
- Specified by:
getCenter
in classPyramidOptions
-