SeriesFunnel

Instance Constructors

new SeriesFunnel()

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val allowPointSelect: UndefOr[Boolean]

Allow this series' points to be selected by clicking on the markers, bars or pie slices.
Allow this series' points to be selected by clicking on the markers, bars or pie slices.
Example:
1. Line, column, pie
Since
1.2.0
val animationLimit: UndefOr[Double]

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 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, set animationLimit to Infinity.
final def asInstanceOf[T0]: T0

Definition Classes
Any
val borderColor: UndefOr[|[String, Object]]

The color of the border surrounding each slice.
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.
Example:
1. Black border. Styled mode.
val borderWidth: UndefOr[Double]

The width of the border surrounding each slice.
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.
Example:
1. 3px border. Styled mode.
val center: UndefOr[Array[|[String, Double]]]

The center of the series.
The center of the series. By default, it is centered in the middle of the plot area, so it fills the plot area height.

Since
3.0
val className: UndefOr[String]

A class name to apply to the series' graphical elements.
A class name to apply to the series' graphical elements.

Since
5.0.0
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val colorIndex: UndefOr[Double]

Styled mode only.
Styled mode only. A specific color index to use for the series, so its graphic representations are given the class name highcharts-color-{n}.

Since
5.0.0
val colors: UndefOr[Array[|[String, Object]]]

A series specific or series type specific color set to use instead of the global colors.
A series specific or series type specific color set to use instead of the global colors.
Example:
1. Set default colors for all pies
Since
3.0
val cursor: UndefOr[String]

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.
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.
Example:
1. Pointer cursor on line graph, on columns, on scatter markers
val data: UndefOr[Array[|[CleanJsObject[SeriesFunnelData], Double]]]

An array of data points for the series.
An array of data points for the series. For the funnel series type, points can be given in the following ways:
- An array of numerical values. In this case, the numerical values will be interpreted as y options. Example:
```
data: [0, 5, 3, 5]
```
-
An array of objects with named values. The objects are point configuration objects as seen below. If the total number of data points exceeds the series' turboThreshold, this option is not available.
```
data: [{
    y: 3,
    name: "Point2",
    color: "#00FF00"
}, {
    y: 1,
    name: "Point1",
    color: "#FF00FF"
}]
```
Example:
1. The demos use a line series, but the principle is the same for all types.
  Numerical values
  Arrays of numeric x and y
  Arrays of datetime x and y
  Arrays of point.name and y
  Config objects
val dataLabels: UndefOr[CleanJsObject[SeriesFunnelDataLabels]]
val depth: UndefOr[Double]

The thickness of a 3D pie.
The thickness of a 3D pie. Requires highcharts-3d.js
Example:
1. Basic 3D pie chart
Since
4.0
val description: UndefOr[String]

Requires Accessibility module
Requires Accessibility module
A description of the series to add to the screen reader information about the series.
Example:
1. Accessible stock chart
Since
5.0.0
val enableMouseTracking: UndefOr[Boolean]

Enable or disable the mouse tracking for a specific series.
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.
Example:
1. No mouse tracking
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val events: UndefOr[CleanJsObject[SeriesFunnelEvents]]
val exposeElementToA11y: UndefOr[Boolean]

By default, series are exposed to screen readers as regions.
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.
Example:
1. Accessible data visualization
Since
5.0.12
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
val findNearestPointBy: UndefOr[String]

Determines whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series.
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.
Example:
1. Different hover behaviors
Since
5.0.10
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val getExtremesFromAll: UndefOr[Boolean]

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.
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.

Since
4.1.6
def hasOwnProperty(v: String): Boolean

Definition Classes
Object
def hashCode(): Int

Definition Classes
AnyRef → Any
val height: UndefOr[|[Double, String]]

The height of the funnel or pyramid.
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.
Example:
1. Funnel demo
Since
3.0
val id: UndefOr[String]

An id for the series.
An id for the series. This can be used after render time to get a pointer to the series object through chart.get().
Example:
1. Get series by id
Since
1.2.0
val index: UndefOr[Double]

The index of the series in the chart, affecting the internal index in the chart.series array, the visible Z index as well as the order in the legend.
The index of the series in the chart, affecting the internal index in the chart.series array, the visible Z index as well as the order in the legend.

Since
2.3.0
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isPrototypeOf(v: Object): Boolean

Definition Classes
Object
val keys: UndefOr[Array[String]]

An array specifying which option maps to which key in the data point array.
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.
Example:
1. An extended data array with keys
Since
4.1.6
val legendIndex: UndefOr[Double]

The sequential index of the series in the legend.
The sequential index of the series in the legend.
Try it: Legend in opposite order .
val linkedTo: UndefOr[String]

The id of another series to link to.
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.
Example:
1. Linked series
Since
3.0
val minSize: UndefOr[Double]

The minimum size for a pie in response to auto margins.
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.

Since
3.0
val name: UndefOr[String]

The name of the series as shown in the legend, tooltip etc.
The name of the series as shown in the legend, tooltip etc.
Example:
1. Series name
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val neckHeight: UndefOr[|[Double, String]]

The height of the neck, the lower part of the funnel.
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.
val neckWidth: UndefOr[|[Double, String]]

The width of the neck, the lower part of the funnel.
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.
Example:
1. Funnel demo
Since
3.0
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val point: UndefOr[CleanJsObject[SeriesFunnelPoint]]

Properties for each single point
val pointDescriptionFormatter: UndefOr[Function]

Same as accessibility.pointDescriptionFormatter, but for an individual series.
Same as accessibility.pointDescriptionFormatter, but for an individual series. Overrides the chart wide configuration.

Since
5.0.12
def propertyIsEnumerable(v: String): Boolean

Definition Classes
Object
val reversed: UndefOr[Boolean]

A reversed funnel has the widest area down.
A reversed funnel has the widest area down. A reversed funnel with no neck width and neck height is a pyramid.

Since
3.0.10
val selected: UndefOr[Boolean]

Whether to select the series initially.
Whether to select the series initially. If showCheckbox is true, the checkbox next to the series name will be checked for a selected series.
Example:
1. One out of two series selected
Since
1.2.0
val shadow: UndefOr[|[Boolean, Object]]

Whether to apply a drop shadow to the graph line.
Whether to apply a drop shadow to the graph line. Since 2.3 the shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.
Example:
1. Shadow enabled
val showInLegend: UndefOr[Boolean]

Whether to display this particular series or series type in the legend.
Whether to display this particular series or series type in the legend. Since 2.1, pies are not shown in the legend by default.
Example:
1. One series in the legend, one hidden
val skipKeyboardNavigation: UndefOr[Boolean]

If set to True, the accessibility module will skip past the points in this series for keyboard navigation.
If set to True, the accessibility module will skip past the points in this series for keyboard navigation.

Since
5.0.12
val slicedOffset: UndefOr[Double]

If a point is sliced, moved out from the center, how many pixels should it be moved?.
If a point is sliced, moved out from the center, how many pixels should it be moved?.
Example:
1. 20px offset
val states: UndefOr[CleanJsObject[PlotOptionsSeriesStates]]

A wrapper object for all the series options in specific states.
val stickyTracking: UndefOr[Boolean]

Sticky tracking of mouse events.
Sticky tracking of mouse events. When true, the mouseOut event on a series isn't triggered until the mouse moves over another series, or out of the plot area. When false, the mouseOut event on a series is triggered when the mouse leaves the area around the series' graph or markers. This also implies the tooltip. When stickyTracking is false and tooltip.shared is false, the tooltip will be hidden when moving the mouse between series.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toLocaleString(): String

Definition Classes
Object
def toString(): String

Definition Classes
AnyRef → Any
val tooltip: UndefOr[CleanJsObject[SeriesFunnelTooltip]]

A configuration object for the tooltip rendering of each single series.
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.

Since
2.3
val type: String

The type of series.
The type of series. Can be one of area, areaspline, bar, column, line, pie, scatter or spline. From version 2.3, arearange, areasplinerange and columnrange are supported with the highcharts-more.js component.
Example:
1. Line and column in the same chart
def valueOf(): Any

Definition Classes
Object
val visible: UndefOr[Boolean]

Set the initial visibility of the series.
Set the initial visibility of the series.
Example:
1. Two series, one hidden and one visible
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
val width: UndefOr[|[Double, String]]

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

Since
3.0
val zIndex: UndefOr[Double]

Define the visual z index of the series.
Define the visual z index of the series.
Example:
1. With no z index, the series defined last are on top, with a z index, the series with the highest z index is on top.
val zoneAxis: UndefOr[String]

Defines the Axis on which the zones are applied.
Defines the Axis on which the zones are applied.
Example:
1. Zones on the X-Axis
Since
4.1.0
val zones: UndefOr[Array[CleanJsObject[SeriesFunnelZones]]]

An array defining zones within a series.
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 the className option (view live demo).
Example:
1. Color zones
Since
4.1.0

Related Docs: object SeriesFunnel | package config

class SeriesFunnel extends Object

Instance Constructors

new SeriesFunnel()

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val allowPointSelect: UndefOr[Boolean]

val animationLimit: UndefOr[Double]

final def asInstanceOf[T0]: T0

val borderColor: UndefOr[|[String, Object]]

val borderWidth: UndefOr[Double]

val center: UndefOr[Array[|[String, Double]]]

val className: UndefOr[String]

def clone(): AnyRef

val colorIndex: UndefOr[Double]

val colors: UndefOr[Array[|[String, Object]]]

val cursor: UndefOr[String]

val data: UndefOr[Array[|[CleanJsObject[SeriesFunnelData], Double]]]

val dataLabels: UndefOr[CleanJsObject[SeriesFunnelDataLabels]]

val depth: UndefOr[Double]

val description: UndefOr[String]

val enableMouseTracking: UndefOr[Boolean]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

val events: UndefOr[CleanJsObject[SeriesFunnelEvents]]

val exposeElementToA11y: UndefOr[Boolean]

def finalize(): Unit

val findNearestPointBy: UndefOr[String]

final def getClass(): Class[_]

val getExtremesFromAll: UndefOr[Boolean]

def hasOwnProperty(v: String): Boolean

def hashCode(): Int

val height: UndefOr[|[Double, String]]

val id: UndefOr[String]

val index: UndefOr[Double]

final def isInstanceOf[T0]: Boolean

def isPrototypeOf(v: Object): Boolean

val keys: UndefOr[Array[String]]

val legendIndex: UndefOr[Double]

val linkedTo: UndefOr[String]

val minSize: UndefOr[Double]

val name: UndefOr[String]

final def ne(arg0: AnyRef): Boolean

val neckHeight: UndefOr[|[Double, String]]

val neckWidth: UndefOr[|[Double, String]]

final def notify(): Unit

final def notifyAll(): Unit

val point: UndefOr[CleanJsObject[SeriesFunnelPoint]]

val pointDescriptionFormatter: UndefOr[Function]

def propertyIsEnumerable(v: String): Boolean

val reversed: UndefOr[Boolean]

val selected: UndefOr[Boolean]

val shadow: UndefOr[|[Boolean, Object]]

val showInLegend: UndefOr[Boolean]

val skipKeyboardNavigation: UndefOr[Boolean]

val slicedOffset: UndefOr[Double]

val states: UndefOr[CleanJsObject[PlotOptionsSeriesStates]]

val stickyTracking: UndefOr[Boolean]

final def synchronized[T0](arg0: ⇒ T0): T0

def toLocaleString(): String

def toString(): String

val tooltip: UndefOr[CleanJsObject[SeriesFunnelTooltip]]

val type: String

def valueOf(): Any

val visible: UndefOr[Boolean]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

val width: UndefOr[|[Double, String]]

val zIndex: UndefOr[Double]

val zoneAxis: UndefOr[String]

val zones: UndefOr[Array[CleanJsObject[SeriesFunnelZones]]]

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped