class PlotOptionsMapbubble extends Object
- Annotations
- @RawJSType() @ScalaJSDefined()
- Note
JavaScript name:
plotOptions-mapbubble
- Alphabetic
- By Inheritance
- PlotOptionsMapbubble
- Object
- Any
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new PlotOptionsMapbubble()
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. Iftrue
, areas which don't correspond to a data point, are rendered asnull
points. Iffalse
, those areas are skipped.Example: -
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.
Allow select on map area, map bubble
Example: -
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
</dl>Math
object. See the easing demo.Due to poor performance, animation is disabled in old IE browsers for map series, but enabled 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
toInfinity
. -
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: -
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: -
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. This color affects both the fill and the stroke of the bubble. For enhanced control, use
marker
options.Example: -
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
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.
Pointer cursor on map area, map bubble
Example: -
val
dataLabels: UndefOr[CleanJsObject[PlotOptionsMapbubbleDataLabels]]
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.
- Since
5.0.0
Example: -
val
displayNegative: UndefOr[Boolean]
Whether to display negative sized bubbles.
Whether to display negative sized bubbles. The threshold is given by the zThreshold option, and negative bubbles can be visualized by setting negativeColor.
-
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: -
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val events: UndefOr[CleanJsObject[PlotOptionsMapbubbleEvents]]
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hasOwnProperty(v: String): Boolean
- Definition Classes
- Object
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
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'sproperties
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 thedata
.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. -
val
maxSize: UndefOr[String]
Maximum bubble size.
Maximum bubble size. Bubbles will automatically size between the
minSize
andmaxSize
to reflect thez
value of each bubble. Can be either pixels (when no unit is given), or a percentage of the smallest one of the plot width and height.Example: -
val
minSize: UndefOr[String]
Minimum bubble size.
Minimum bubble size. Bubbles will automatically size between the
minSize
andmaxSize
to reflect thez
value of each bubble. Can be either pixels (when no unit is given), or a percentage of the smallest one of the plot width and height.Example: -
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
val
negativeColor: UndefOr[|[String, Object]]
When a point's Z value is below the zThreshold setting, this color is used.
When a point's Z value is below the zThreshold setting, this color is used.
Example: -
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
val
point: UndefOr[CleanJsObject[PlotOptionsMapbubblePoint]]
Properties for each single point
-
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
andwidth
. -
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
sizeBy: UndefOr[String]
Whether the bubble's value should be represented by the area or the width of the bubble.
Whether the bubble's value should be represented by the area or the width of the bubble. The default,
area
, corresponds best to the human perception of the size of each bubble. -
val
sizeByAbsoluteValue: UndefOr[Boolean]
When this is true, the absolute value of z determines the size of the bubble.
When this is true, the absolute value of z determines the size of the bubble. This means that with the default
zThreshold
of 0, a bubble of value -1 will have the same size as a bubble of value 1, while a bubble of value 0 will have a smaller size according tominSize
.- Since
1.1.9
-
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, 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. -
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[PlotOptionsMapbubbleTooltip]]
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.
-
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.
-
val
zMax: UndefOr[Double]
The minimum for the Z value range.
The minimum for the Z value range. Defaults to the highest Z value in the data.
- Since
1.0.3
Example: -
val
zMin: UndefOr[Double]
The minimum for the Z value range.
The minimum for the Z value range. Defaults to the lowest Z value in the data.
- Since
1.0.3
Example: -
val
zThreshold: UndefOr[Double]
When displayNegative is
false
, bubbles with lower Z values are skipped.When displayNegative is
false
, bubbles with lower Z values are skipped. WhendisplayNegative
istrue
and a negativeColor is given, points with lower Z is colored.Example: