SeriesMap

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. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

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

   

   The border color of the map areas.

   The border color of the map areas.

   Example:

   1. Borders demo

9. val borderWidth: UndefOr[Double]

   

   The border width of each map area.

   The border width of each map area.

   Example:

   1. Borders demo

10. def clone(): AnyRef

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    Example:

    1. Category map by multiple series

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

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

14. 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 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"
    }]
    

15. val dataLabels: UndefOr[CleanJsObject[SeriesMapDataLabels]]

    

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

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

    

    Definition Classes

    AnyRef

18. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

19. val events: UndefOr[CleanJsObject[SeriesMapEvents]]

    

20. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

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

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

    

    Definition Classes

    AnyRef → Any

22. def hasOwnProperty(v: String): Boolean

    

    Definition Classes

    Object

23. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

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

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

26. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

27. def isPrototypeOf(v: Object): Boolean

    

    Definition Classes

    Object

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

29. val legendIndex: UndefOr[Double]

    

    The sequential index of the series in the legend.

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

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

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

    

    Definition Classes

    AnyRef

33. final def notify(): Unit

    

    Definition Classes

    AnyRef

34. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

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

    

    The color to apply to null points.

    The color to apply to null points.

    Example:

    1. Null color

36. val point: UndefOr[CleanJsObject[SeriesMapPoint]]

    

    Properties for each single point

37. def propertyIsEnumerable(v: String): Boolean

    

    Definition Classes

    Object

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

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

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

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

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

    

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

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

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

    

    Definition Classes

    AnyRef

45. def toLocaleString(): String

    

    Definition Classes

    Object

46. def toString(): String

    

    Definition Classes

    AnyRef → Any

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

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

49. def valueOf(): Any

    

    Definition Classes

    Object

50. val visible: UndefOr[Boolean]

    

    Set the initial visibility of the series.

51. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

54. val zIndex: UndefOr[Double]

    

    Define the z index of the series.