PlotOptionsMapbubble

Value Members

1. final def !=(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

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

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

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

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

8. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

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

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

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

12. def clone(): AnyRef

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    1. Pink bubbles

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

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

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

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

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

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

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

21. final def eq(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

22. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

23. val events: UndefOr[CleanJsObject[PlotOptionsMapbubbleEvents]]

    

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

25. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

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

27. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

28. def hasOwnProperty(v: String): Boolean

    

    Definition Classes

    Object

29. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

30. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

31. def isPrototypeOf(v: Object): Boolean

    

    Definition Classes

    Object

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

33. val maxSize: UndefOr[String]

    

    Maximum bubble size.

    Maximum bubble size. Bubbles will automatically size between the minSize and maxSize to reflect the z 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:

    1. Bubble size

34. val minSize: UndefOr[String]

    

    Minimum bubble size.

    Minimum bubble size. Bubbles will automatically size between the minSize and maxSize to reflect the z 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:

    1. Bubble size

35. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

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

    1. Negative color below a threshold

37. final def notify(): Unit

    

    Definition Classes

    AnyRef

38. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

39. val point: UndefOr[CleanJsObject[PlotOptionsMapbubblePoint]]

    

    Properties for each single point

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

41. def propertyIsEnumerable(v: String): Boolean

    

    Definition Classes

    Object

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

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

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

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

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

47. 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 to minSize.

    Example:

    1. Size by absolute value, various thresholds.

    Since

    1.1.9

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

49. val states: UndefOr[CleanJsObject[PlotOptionsSeriesStates]]

    

    A wrapper object for all the series options in specific states.

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

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

    

    Definition Classes

    AnyRef

52. def toLocaleString(): String

    

    Definition Classes

    Object

53. def toString(): String

    

    Definition Classes

    AnyRef → Any

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

55. def valueOf(): Any

    

    Definition Classes

    Object

56. val visible: UndefOr[Boolean]

    

    Set the initial visibility of the series.

57. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

59. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

60. val zIndex: UndefOr[Double]

    

    Define the z index of the series.

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

    Example:

    1. Z has a possible range of 0-100

    Since

    1.0.3

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

    Example:

    1. Z has a possible range of 0-100

    Since

    1.0.3

63. 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. When displayNegative is true and a negativeColor is given, points with lower Z is colored.

    Example:

    1. Negative color below a threshold