Packages

object SeriesMap

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SeriesMap
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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. def apply(allAreas: UndefOr[Boolean] = js.undefined, allowPointSelect: UndefOr[Boolean] = js.undefined, animation: UndefOr[Boolean] = js.undefined, animationLimit: UndefOr[Double] = js.undefined, borderColor: UndefOr[|[String, Object]] = js.undefined, borderWidth: UndefOr[Double] = js.undefined, className: UndefOr[String] = js.undefined, color: UndefOr[|[String, Object]] = js.undefined, colorAxis: UndefOr[Boolean] = js.undefined, cursor: UndefOr[String] = js.undefined, dashStyle: UndefOr[String] = js.undefined, data: UndefOr[Array[CleanJsObject[SeriesMapData]]] = js.undefined, dataLabels: UndefOr[CleanJsObject[SeriesMapDataLabels]] = js.undefined, description: UndefOr[String] = js.undefined, enableMouseTracking: UndefOr[Boolean] = js.undefined, events: UndefOr[CleanJsObject[SeriesMapEvents]] = js.undefined, id: UndefOr[String] = js.undefined, index: UndefOr[Double] = js.undefined, joinBy: UndefOr[|[String, Array[String]]] = js.undefined, legendIndex: UndefOr[Double] = js.undefined, mapData: UndefOr[Array[Object]] = js.undefined, name: UndefOr[String] = js.undefined, negativeColor: UndefOr[|[String, Object]] = js.undefined, nullColor: UndefOr[|[String, Object]] = js.undefined, nullInteraction: UndefOr[Boolean] = js.undefined, point: UndefOr[CleanJsObject[SeriesMapPoint]] = js.undefined, selected: UndefOr[Boolean] = js.undefined, shadow: UndefOr[|[Boolean, Object]] = js.undefined, showCheckbox: UndefOr[Boolean] = js.undefined, showInLegend: UndefOr[Boolean] = js.undefined, states: UndefOr[CleanJsObject[PlotOptionsSeriesStates]] = js.undefined, stickyTracking: UndefOr[Boolean] = js.undefined, tooltip: UndefOr[CleanJsObject[SeriesMapTooltip]] = js.undefined, type: String = "map", visible: UndefOr[Boolean] = js.undefined, zIndex: UndefOr[Double] = js.undefined): SeriesMap

    allAreas

    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.

    allowPointSelect

    Allow this series' points to be selected by clicking on the shapes. Selected points can be read through the Chart.getSelectedPoints() method.

    animation

    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.

    animationLimit

    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.

    borderColor

    The border color of the map areas.. . In styled mode, the border stroke is given in the .highcharts-point class.

    borderWidth

    The border width of each map area.. . In styled mode, the border stroke width is given in the .highcharts-point class.

    className

    A class name to apply to the series' graphical elements.

    color

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

    colorAxis

    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.

    cursor

    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.

    dashStyle

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

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

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

    description

    Requires Accessibility module. A description of the series to add to the screen reader information about the series.

    enableMouseTracking

    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.

    id

    An id for the series. This can be used after render time to get a pointer to the series object through chart.get().

    index

    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.

    joinBy

    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.

    legendIndex

    The sequential index of the series in the legend.

    mapData

    An array of objects containing a path definition and optionally a code or property to join in the data as per the joinBy option.

    name

    The name of the series as shown in the legend, tooltip etc.

    negativeColor

    The color for the parts of the graph or points that are below the threshold.

    nullColor

    The color to apply to null points.. . In styled mode, the null point fill is set in the .highcharts-null-point class.

    nullInteraction

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

    point

    Properties for each single point

    selected

    Whether to select the series initially. If showCheckbox is true, the checkbox next to the series name will be checked for a selected series.

    shadow

    Whether to apply a drop shadow to the shapes. The shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.

    showCheckbox

    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.

    showInLegend

    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.

    states

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

    stickyTracking

    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.

    tooltip

    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.

    visible

    Set the initial visibility of the series.

    zIndex

    Define the z index of the series.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped