Package com.vaadin.componentfactory.maps.model

Class PlotOptionsHeatmap

java.lang.Object
com.vaadin.componentfactory.maps.model.AbstractConfigurationObject
com.vaadin.componentfactory.maps.model.AbstractPlotOptions
com.vaadin.componentfactory.maps.model.PlotOptionsHeatmap
All Implemented Interfaces:
Serializable
@Generated(value="This class was generated", comments="Incorrect and missing API should be reported") public class PlotOptionsHeatmap extends AbstractPlotOptions
The heatmap series type, a special case of a choropleth map where each point is a square colored to signify a value. Heatmaps are available both in Highmaps and in Highcharts since version 4.
Version:
$Id: $Id
Author:
Vaadin
See Also:

  • Constructor Details

    • PlotOptionsHeatmap

      public PlotOptionsHeatmap()

      Constructor for PlotOptionsHeatmap.

  • Method Details

    • getMapType

      public MapType getMapType()

      getMapType.

      Overrides:
      getMapType in class AbstractPlotOptions
      Returns:
      a MapType object.

    • getAllowPointSelect

      public Boolean getAllowPointSelect()

      Getter for the field allowPointSelect.

      Returns:
      a Boolean object.
      See Also:

    • setAllowPointSelect

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

      Defaults to: false

      Parameters:
      allowPointSelect - a Boolean object.

    • getAnimation

      public Boolean getAnimation()

      Getter for the field animation.

      Returns:
      a Boolean object.
      See Also:

    • setAnimation

      public void setAnimation(Boolean 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:

      duration
      The duration of the animation in milliseconds.
      easing
      A string reference to an easing function set on the 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.

      Defaults to: false

      Parameters:
      animation - a Boolean object.

    • getAnimationLimit

      public Number getAnimationLimit()

      Getter for the field animationLimit.

      Returns:
      a Number object.
      See Also:

    • setAnimationLimit

      public void setAnimationLimit(Number 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.
      Parameters:
      animationLimit - a Number object.

    • getBorderColor

      public Color getBorderColor()

      Getter for the field borderColor.

      Returns:
      a Color object.
      See Also:

    • setBorderColor

      public void setBorderColor(Color borderColor)
      The border color of the map areas.

      Defaults to: silver

      Parameters:
      borderColor - a Color object.

    • getBorderWidth

      public Number getBorderWidth()

      Getter for the field borderWidth.

      Returns:
      a Number object.
      See Also:

    • setBorderWidth

      public void setBorderWidth(Number borderWidth)
      The border width of each map area.

      Defaults to: 1

      Parameters:
      borderWidth - a Number object.

    • getColor

      public Color getColor()

      Getter for the field color.

      Returns:
      a Color object.
      See Also:

    • setColor

      public void setColor(Color 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.
      Parameters:
      color - a Color object.

    • getColorAxis

      public ColorAxis getColorAxis()

      Getter for the field colorAxis.

      Returns:
      a ColorAxis object.
      See Also:

    • setColorAxis

      public void setColorAxis(ColorAxis 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.

      Defaults to: undefined

      Parameters:
      colorAxis - a ColorAxis object.

    • getColsize

      public Number getColsize()

      Getter for the field colsize.

      Returns:
      a Number object.
      See Also:

    • setColsize

      public void setColsize(Number colsize)
      The column size - how many X axis units each column in the heatmap should span.

      Defaults to: 1

      Parameters:
      colsize - a Number object.

    • getCursor

      public Cursor getCursor()

      Getter for the field cursor.

      Returns:
      a Cursor object.
      See Also:

    • setCursor

      public void setCursor(Cursor 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.
      Parameters:
      cursor - a Cursor object.

    • getDataLabels

      public DataLabels getDataLabels()

      Getter for the field dataLabels.

      Returns:
      a DataLabels object.
      See Also:

    • setDataLabels

      public void setDataLabels(DataLabels dataLabels)

      Setter for the field dataLabels.

      Parameters:
      dataLabels - a DataLabels object.

    • getEnableMouseTracking

      public Boolean getEnableMouseTracking()

      Getter for the field enableMouseTracking.

      Returns:
      a Boolean object.
      See Also:

    • setEnableMouseTracking

      public void setEnableMouseTracking(Boolean 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.

      Defaults to: true

      Parameters:
      enableMouseTracking - a Boolean object.

    • getNullColor

      public Color getNullColor()

      Getter for the field nullColor.

      Returns:
      a Color object.
      See Also:

    • setNullColor

      public void setNullColor(Color nullColor)
      The color to apply to null points.

      Defaults to: #F8F8F8

      Parameters:
      nullColor - a Color object.

    • getRowsize

      public Number getRowsize()

      Getter for the field rowsize.

      Returns:
      a Number object.
      See Also:

    • setRowsize

      public void setRowsize(Number rowsize)
      The row size - how many Y axis units each heatmap row should span.

      Defaults to: 1

      Parameters:
      rowsize - a Number object.

    • getSelected

      public Boolean getSelected()

      Getter for the field selected.

      Returns:
      a Boolean object.
      See Also:

    • setSelected

      public void setSelected(Boolean 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.

      Defaults to: false

      Parameters:
      selected - a Boolean object.

    • getShadow

      public Boolean getShadow()

      Getter for the field shadow.

      Returns:
      a Boolean object.
      See Also:

    • setShadow

      public void setShadow(Boolean shadow)
      Whether to apply a drop shadow to the shapes. The shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.

      Defaults to: false

      Parameters:
      shadow - a Boolean object.

    • getShowCheckbox

      public Boolean getShowCheckbox()

      Getter for the field showCheckbox.

      Returns:
      a Boolean object.
      See Also:

    • setShowCheckbox

      public void setShowCheckbox(Boolean 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.

      Defaults to: false

      Parameters:
      showCheckbox - a Boolean object.

    • getShowInLegend

      public Boolean getShowInLegend()

      Getter for the field showInLegend.

      Returns:
      a Boolean object.
      See Also:

    • setShowInLegend

      public void setShowInLegend(Boolean 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.

      Defaults to: true

      Parameters:
      showInLegend - a Boolean object.

    • getStates

      public States getStates()

      Getter for the field states.

      Returns:
      a States object.
      See Also:

    • setStates

      public void setStates(States states)
      A wrapper object for all the series options in specific states.
      Parameters:
      states - a States object.

    • getStickyTracking

      public Boolean getStickyTracking()

      Getter for the field stickyTracking.

      Returns:
      a Boolean object.
      See Also:

    • setStickyTracking

      public void setStickyTracking(Boolean 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.

      Defaults to: false

      Parameters:
      stickyTracking - a Boolean object.

    • getTooltip

      public SeriesTooltip getTooltip()

      Getter for the field tooltip.

      Returns:
      a SeriesTooltip object.
      See Also:

    • setTooltip

      public void setTooltip(SeriesTooltip 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.
      Parameters:
      tooltip - a SeriesTooltip object.

    • getVisible

      public Boolean getVisible()

      Getter for the field visible.

      Returns:
      a Boolean object.
      See Also:

    • setVisible

      public void setVisible(Boolean visible)
      Set the initial visibility of the series.

      Defaults to: true

      Parameters:
      visible - a Boolean object.

    • getZIndex

      public Number getZIndex()

      Getter for the field zIndex.

      Returns:
      a Number object.
      See Also:

    • setZIndex

      public void setZIndex(Number zIndex)
      Define the z index of the series.
      Parameters:
      zIndex - a Number object.