SeriesMap

Instance Constructors

new SeriesMap()

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

Whether all areas of the map defined in mapData should be rendered.
Whether all areas of the map defined in mapData should be rendered. If true, areas which don't correspond to a data point, are rendered as null points. If false, those areas are skipped.
Example:
1. All areas set to false
val allowPointSelect: UndefOr[Boolean]

Allow this series' points to be selected by clicking on the shapes.
Allow this series' points to be selected by clicking on the shapes. Selected points can be read through the Chart.getSelectedPoints() method.
Example:
1. Allow select on map area, map bubble
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 map series, but enabled on mapbubble series.
Example:
1. Animation enabled on map series, disabled on mapbubble series
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 border color of the map areas.
The border color of the map areas.
In styled mode, the border stroke is given in the .highcharts-point class.
Example:
1. Borders demo
val borderWidth: UndefOr[Double]

The border width of each map area.
The border width of each map area.
In styled mode, the border stroke width is given in the .highcharts-point class.
Example:
1. Borders demo
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 maps, this color is rarely used, as most choropleth maps use the color to denote the value of each point. The series color can however be used in a map with multiple series holding categorized data. The default value is pulled from the options.colors array.
In styled mode, the color can be defined by the colorIndex option. Also, the series color can be set with the .highcharts-series, .highcharts-color-{n}, .highcharts-{type}-series or .highcharts-series-{n} class, or individual classes given by the className option.
Example:
1. Category map by multiple series
val colorAxis: UndefOr[Boolean]

Set this option to false to prevent a series from connecting to the global color axis.
Set this option to false to prevent a series from connecting to the global color axis. This will cause the series to have its own legend item.
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 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 map area, map bubble
val dashStyle: UndefOr[String]

A name for the dash style to use for the map area outline or the map line.
A name for the dash style to use for the map area outline or the map line. The value for the dashStyle include:
- Solid
- ShortDash
- ShortDot
- ShortDashDot
- ShortDashDotDot
- Dot
- Dash
- LongDash
- DashDot
- LongDashDot
- LongDashDotDot
Example:
1. Possible values demonstrated, dotted borders on a map.
val data: UndefOr[Array[CleanJsObject[SeriesMapData]]]

An array of data points for the series.
An array of data points for the series. For the map 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 arrays with 2 values. In this case, the values correspond to [hc-key, value]. Example:
```
data: [['us-ny', 0], ['us-mi', 5], ['us-tx', 3], ['us-ak', 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: 6,
    name: "Point2",
    color: "#00FF00"
}, {
    value: 6,
    name: "Point1",
    color: "#FF00FF"
}]
```
val dataLabels: UndefOr[CleanJsObject[SeriesMapDataLabels]]

Options for the series data labels, appearing next to each data point.
Options for the series data labels, appearing next to each data point.
In styled mode, the data labels can be styled wtih the .highcharts-data-label-box and .highcharts-data-label class names (see example).
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[SeriesMapEvents]]
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
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().
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.
final def isInstanceOf[T0]: Boolean

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

Definition Classes
Object
val joinBy: UndefOr[|[String, Array[String]]]

What property to join the mapData to the value data.
What property to join the mapData to the value data. For example, if joinBy is "code", the mapData items with a specific code is merged into the data with the same code. For maps loaded from GeoJSON, the keys may be held in each point's properties object.
The joinBy option can also be an array of two values, where the first points to a key in the mapData, and the second points to another key in the data.
When joinBy is null, the map items are joined by their position in the array, which performs much better in maps with many data points. This is the recommended option if you are printing more than a thousand data points and have a backend that can preprocess the data into a parallel array of the mapData.
Example:
1. Joined by "code", GeoJSON joined by an array, simple data joined by null.
val legendIndex: UndefOr[Double]

The sequential index of the series in the legend.
val mapData: UndefOr[Array[Object]]

An array of objects containing a path definition and optionally a code or property to join in the data as per the joinBy option.
An array of objects containing a path definition and optionally a code or property to join in the data as per the joinBy option.
Example:
1. Map data and joinBy
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 negativeColor: UndefOr[|[String, Object]]

The color for the parts of the graph or points that are below the threshold.
The color for the parts of the graph or points that are below the threshold.
Example:
1. Spline, area and column - arearange.
Since
3.0
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val nullColor: UndefOr[|[String, Object]]

The color to apply to null points.
The color to apply to null points.
In styled mode, the null point fill is set in the .highcharts-null-point class.
Example:
1. Null color
val nullInteraction: UndefOr[Boolean]

Whether to allow pointer interaction like tooltips and mouse events on null points.
Whether to allow pointer interaction like tooltips and mouse events on null points.

Since
4.2.7
val point: UndefOr[CleanJsObject[SeriesMapPoint]]

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.
val shadow: UndefOr[|[Boolean, Object]]

Whether to apply a drop shadow to the shapes.
Whether to apply a drop shadow to the shapes. The shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.
val showCheckbox: UndefOr[Boolean]

If true, and the series has a unique legend item, a checkbox is displayed next to the legend item to allow selecting the series.
If true, and the series has a unique legend item, 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. Note that if a colorAxis is defined, the color axis is represented in the legend, not the series.
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. Note that if a colorAxis is defined, the color axis is represented in the legend, not the series.
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 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[SeriesMapTooltip]]

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.
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. Multiple types in the same map
def valueOf(): Any

Definition Classes
Object
val visible: UndefOr[Boolean]

Set the initial visibility of the series.
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 zIndex: UndefOr[Double]

Define the z index of the series.

Related Docs: object SeriesMap | package config

class SeriesMap extends Object

Instance Constructors

new SeriesMap()

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val allAreas: UndefOr[Boolean]

val allowPointSelect: 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 colorAxis: UndefOr[Boolean]

val colorIndex: UndefOr[Double]

val cursor: UndefOr[String]

val dashStyle: UndefOr[String]

val data: UndefOr[Array[CleanJsObject[SeriesMapData]]]

val dataLabels: UndefOr[CleanJsObject[SeriesMapDataLabels]]

val description: UndefOr[String]

val enableMouseTracking: UndefOr[Boolean]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

val events: UndefOr[CleanJsObject[SeriesMapEvents]]

val exposeElementToA11y: UndefOr[Boolean]

def finalize(): Unit

val findNearestPointBy: UndefOr[String]

final def getClass(): Class[_]

def hasOwnProperty(v: String): Boolean

def hashCode(): Int

val id: UndefOr[String]

val index: UndefOr[Double]

final def isInstanceOf[T0]: Boolean

def isPrototypeOf(v: Object): Boolean

val joinBy: UndefOr[|[String, Array[String]]]

val legendIndex: UndefOr[Double]

val mapData: UndefOr[Array[Object]]

val name: UndefOr[String]

final def ne(arg0: AnyRef): Boolean

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

final def notify(): Unit

final def notifyAll(): Unit

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

val nullInteraction: UndefOr[Boolean]

val point: UndefOr[CleanJsObject[SeriesMapPoint]]

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 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[SeriesMapTooltip]]

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 zIndex: UndefOr[Double]

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped