SeriesTreemap

Instance Constructors

new SeriesTreemap()

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 allowDrillToNode: UndefOr[Boolean]

When enabled the user can click on a point which is a parent and zoom in on its children.
When enabled the user can click on a point which is a parent and zoom in on its children.
Example:
1. Enabled
Since
4.1.0
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 alternateStartingDirection: UndefOr[Boolean]

Enabling this option will make the treemap alternate the drawing direction between vertical and horizontal.
Enabling this option will make the treemap alternate the drawing direction between vertical and horizontal. The next levels starting direction will always be the opposite of the previous.
Example:
1. Enabled
Since
4.1.0
val animation: UndefOr[Boolean]

Enable or disable the initial animation when a series is displayed.
Enable or disable the initial animation when a series is displayed. The animation can also be set as a configuration object. Please note that this option only applies to the initial animation of the series itself. For other animations, see chart.animation and the animation parameter under the API methods. The following properties are supported: <dl> <dt>duration</dt>
The duration of the animation in milliseconds.
<dt>easing</dt>
A string reference to an easing function set on the Math object. See the easing demo.
</dl>
Due to poor performance, animation is disabled in old IE browsers for column charts and polar charts.
Example:
1. Animation disabled, slower animation, custom easing function.
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 tree map item.
val borderWidth: UndefOr[Double]

The width of the border surrounding each column or bar.
The width of the border surrounding each column or bar.
In styled mode, the stroke width can be set with the .highcharts-point rule.
Example:
1. 2px black border
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 color: UndefOr[|[String, Object]]

The main color of the series.
The main color of the series. In heat maps this color is rarely used, as we mostly use the color to denote the value of each point. Unless options are set in the colorAxis, the default value is pulled from the options.colors array.

Since
4.0
val colorByPoint: UndefOr[Boolean]

When using automatic point colors pulled from the options.colors collection, this option determines whether the chart should receive one color per series or one color per point.
When using automatic point colors pulled from the options.colors collection, this option determines whether the chart should receive one color per series or one color per point.
Example:
1. False by default, true
Since
2.0
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 apply instead of the global colors when colorByPoint is true.
A series specific or series type specific color set to apply instead of the global colors when colorByPoint is true.

Since
3.0
val crisp: UndefOr[Boolean]

When true, each column edge is rounded to its nearest pixel in order to render sharp on screen.
When true, each 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, setting crisp to false may look better, even though each column is rendered blurry.
Example:
1. Crisp is false.
Since
5.0.10
val cropThreshold: UndefOr[Double]

When the series contains less points than the crop threshold, all points are drawn, event if the points fall outside the visible plot area at the current zoom.
When the series contains less points than the crop threshold, all points are drawn, event if the points fall outside the visible plot area at the current zoom. The advantage of drawing all points (including markers and columns), is that animation is performed on updates. On the other hand, when the series contains more points than the crop threshold, the series data is cropped to only contain points that fall within the plot area. The advantage of cropping away invisible points is to increase performance on large series.

Since
4.1.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[SeriesTreemapData], Double]]]

An array of data points for the series.
An array of data points for the series. For the treemap 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 value 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: [{
    value: 7,
    name: "Point2",
    color: "#00FF00"
}, {
    value: 2,
    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[SeriesTreemapDataLabels]]
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[SeriesTreemapEvents]]
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 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 ignoreHiddenPoint: UndefOr[Boolean]

Whether to ignore hidden points when the layout algorithm runs.
Whether to ignore hidden points when the layout algorithm runs. If false, hidden points will leave open spaces.

Since
5.0.8
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
val interactByLeaf: UndefOr[Boolean]

This option decides if the user can interact with the parent nodes or just the leaf nodes.
This option decides if the user can interact with the parent nodes or just the leaf nodes. When this option is undefined, it will be true by default. However when allowDrillToNode is true, then it will be false by default.
Example:
1. false, interactByLeaf and allowDrillToNode is true
Since
4.1.2
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 layoutAlgorithm: UndefOr[String]

This option decides which algorithm is used for setting position and dimensions of the points.
This option decides which algorithm is used for setting position and dimensions of the points. Can be one of sliceAndDice, stripes, squarified or strip.
Example:
1. sliceAndDice by default, stripes, squarified, strip
Since
4.1.0
val layoutStartingDirection: UndefOr[String]

Defines which direction the layout algorithm will start drawing.
Defines which direction the layout algorithm will start drawing. Possible values are "vertical" and "horizontal".

Since
4.1.0
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 levelIsConstant: UndefOr[Boolean]

Used together with the levels and allowDrillToNode options.
Used together with the levels and allowDrillToNode options. When set to false the first level visible when drilling is considered to be level one. Otherwise the level will be the same as the tree structure.

Since
4.1.0
val levels: UndefOr[Array[CleanJsObject[SeriesTreemapLevels]]]

Set options on specific levels.
Set options on specific levels. Takes precedence over series options, but not point options.
Example:
1. Styling dataLabels and borders, Different layoutAlgorithm
Since
4.1.0
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 maxPointWidth: UndefOr[Double]

The maximum allowed pixel width for a column, translated to the height of a bar in a bar chart.
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.
Example:
1. Limited to 50
Since
4.1.8
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
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val opacity: UndefOr[Double]

The opacity of a point in treemap.
The opacity of a point in treemap. When a point has children, the visibility of the children is determined by the opacity.

Since
4.2.4
val point: UndefOr[CleanJsObject[SeriesTreemapPoint]]

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 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 showCheckbox: UndefOr[Boolean]

If true, a checkbox is displayed next to the legend item to allow selecting the series.
If true, a checkbox is displayed next to the legend item to allow selecting the series. The state of the checkbox is determined by the selected option.
Example:
1. Show select box
Since
1.2.0
val showInLegend: UndefOr[Boolean]

Whether to display this series type or specific series item in the legend.
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 sortIndex: UndefOr[Double]

The sort index of the point inside the treemap level.
The sort index of the point inside the treemap level.
Example:
1. Sort by years
Since
4.1.10
val states: UndefOr[CleanJsObject[SeriesTreemapStates]]

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. Defaults to true for line and area type series, but to false for columns, pies etc.
Example:
1. True by default, false
Since
2.0
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[SeriesTreemapTooltip]]
val turboThreshold: UndefOr[Double]

When a series contains a data array that is longer than this, only one dimensional arrays of numbers, or two dimensional arrays with x and y values are allowed.
When a series contains a data array that is longer than this, only one dimensional arrays of numbers, or two dimensional arrays with x and y values are allowed. Also, only the first point is tested, and the rest are assumed to be the same format. This saves expensive data checking and indexing in long series. Set it to 0 disable.

Since
2.2
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 xAxis: UndefOr[|[Double, String]]

When using dual or multiple x axes, this number defines which xAxis the particular series is connected to.
When using dual or multiple x axes, this number defines which xAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the xAxis array, with 0 being the first.
val yAxis: UndefOr[|[Double, String]]

When using dual or multiple y axes, this number defines which yAxis the particular series is connected to.
When using dual or multiple y axes, this number defines which yAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the yAxis array, with 0 being the first.
Example:
1. Apply the column series to the secondary Y axis
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[SeriesTreemapZones]]]

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 SeriesTreemap | package config

class SeriesTreemap extends Object

Instance Constructors

new SeriesTreemap()

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val allowDrillToNode: UndefOr[Boolean]

val allowPointSelect: UndefOr[Boolean]

val alternateStartingDirection: UndefOr[Boolean]

val animation: UndefOr[Boolean]

val animationLimit: UndefOr[Double]

final def asInstanceOf[T0]: T0

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

val borderWidth: UndefOr[Double]

val className: UndefOr[String]

def clone(): AnyRef

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

val colorByPoint: UndefOr[Boolean]

val colorIndex: UndefOr[Double]

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

val crisp: UndefOr[Boolean]

val cropThreshold: UndefOr[Double]

val cursor: UndefOr[String]

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

val dataLabels: UndefOr[CleanJsObject[SeriesTreemapDataLabels]]

val description: UndefOr[String]

val enableMouseTracking: UndefOr[Boolean]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

val events: UndefOr[CleanJsObject[SeriesTreemapEvents]]

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 id: UndefOr[String]

val ignoreHiddenPoint: UndefOr[Boolean]

val index: UndefOr[Double]

val interactByLeaf: UndefOr[Boolean]

final def isInstanceOf[T0]: Boolean

def isPrototypeOf(v: Object): Boolean

val keys: UndefOr[Array[String]]

val layoutAlgorithm: UndefOr[String]

val layoutStartingDirection: UndefOr[String]

val legendIndex: UndefOr[Double]

val levelIsConstant: UndefOr[Boolean]

val levels: UndefOr[Array[CleanJsObject[SeriesTreemapLevels]]]

val linkedTo: UndefOr[String]

val maxPointWidth: UndefOr[Double]

val name: UndefOr[String]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val opacity: UndefOr[Double]

val point: UndefOr[CleanJsObject[SeriesTreemapPoint]]

val pointDescriptionFormatter: UndefOr[Function]

def propertyIsEnumerable(v: String): Boolean

val selected: UndefOr[Boolean]

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

val showCheckbox: UndefOr[Boolean]

val showInLegend: UndefOr[Boolean]

val skipKeyboardNavigation: UndefOr[Boolean]

val sortIndex: UndefOr[Double]

val states: UndefOr[CleanJsObject[SeriesTreemapStates]]

val stickyTracking: UndefOr[Boolean]

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

def toLocaleString(): String

def toString(): String

val tooltip: UndefOr[CleanJsObject[SeriesTreemapTooltip]]

val turboThreshold: UndefOr[Double]

val type: String

def valueOf(): Any

val visible: UndefOr[Boolean]

final def wait(): Unit

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