Package com.vaadin.componentfactory.maps.model

Class MapModel

java.lang.Object
com.vaadin.componentfactory.maps.model.AbstractConfigurationObject
com.vaadin.componentfactory.maps.model.MapModel
All Implemented Interfaces:
Serializable
@Generated(value="This class was generated", comments="Incorrect and missing API should be reported") public class MapModel extends AbstractConfigurationObject
Options regarding the chart area and plot area as well as general chart options.
Version:
$Id: $Id
Author:
Vaadin
See Also:

  • Constructor Details

    • MapModel

      public MapModel()

      Constructor for MapModel.

  • Method Details

    • getStyledMode

      public Boolean getStyledMode()

    • setStyledMode

      public void setStyledMode(Boolean styledMode)
      Whether to apply styled mode. When in styled mode, no presentational attributes or CSS are applied to the chart SVG. Instead, CSS rules are required to style the chart. The default style sheet is available from https://code.highcharts.com/css/highcharts.css.
      Parameters:
      styledMode - if true, style mode is applied

    • getAnimation

      public Boolean getAnimation()

      Getter for the field animation.

      Returns:
      a Boolean object.
      See Also:

    • setAnimation

      public void setAnimation(Boolean animation)

      Set the overall animation for all chart updating. Animation can be disabled throughout the chart by setting it to false here. It can be overridden for each individual API method as a function parameter. The only animation not affected by this option is the initial series animation, see plotOptions.series.animation.

      The animation can either be set as a boolean or a configuration object. If true, it will use the 'swing' jQuery easing and a duration of 500 ms. If used as a configuration object, 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.

      Defaults to: true

      Parameters:
      animation - a Boolean object.

    • getBackgroundColor

      public Color getBackgroundColor()

      Getter for the field backgroundColor.

      Returns:
      a Color object.
      See Also:

    • setBackgroundColor

      public void setBackgroundColor(Color backgroundColor)
      The background color or gradient for the outer chart area.

      Defaults to: #FFFFFF

      Parameters:
      backgroundColor - a Color object.

    • getBorderColor

      public Color getBorderColor()

      Getter for the field borderColor.

      Returns:
      a Color object.
      See Also:

    • setBorderColor

      public void setBorderColor(Color borderColor)
      The color of the outer chart border.

      Defaults to: #4572A7

      Parameters:
      borderColor - a Color object.

    • getBorderRadius

      public Number getBorderRadius()

      Getter for the field borderRadius.

      Returns:
      a Number object.
      See Also:

    • setBorderRadius

      public void setBorderRadius(Number borderRadius)
      The corner radius of the outer chart border.

      Defaults to: 0

      Parameters:
      borderRadius - a Number object.

    • getBorderWidth

      public Number getBorderWidth()

      Getter for the field borderWidth.

      Returns:
      a Number object.
      See Also:

    • setBorderWidth

      public void setBorderWidth(Number borderWidth)
      The pixel width of the outer chart border.

      Defaults to: 0

      Parameters:
      borderWidth - a Number object.

    • getClassName

      public String getClassName()

      Getter for the field className.

      Returns:
      a String object.
      See Also:

    • setClassName

      public void setClassName(String className)
      A CSS class name to apply to the charts container div, allowing unique CSS styling for each chart.
      Parameters:
      className - a String object.

    • getHeight

      public Number getHeight()

      Getter for the field height.

      Returns:
      a Number object.
      See Also:

    • setHeight

      public void setHeight(Number height)
      An explicit height for the chart. By default (when null) the height is calculated from the offset height of the containing element, or 400 pixels if the containing element's height is 0.

      Defaults to: null

      Parameters:
      height - a Number object.

    • getMargin

      public Number[] getMargin()

      Getter for the field margin.

      Returns:
      an array of Number objects.
      See Also:

    • getMarginBottom

      public Number getMarginBottom()

      Getter for the field marginBottom.

      Returns:
      a Number object.
      See Also:

    • setMarginBottom

      public void setMarginBottom(Number marginBottom)
      The margin between the bottom outer edge of the chart and the plot area. Use this to set a fixed pixel value for the margin as opposed to the default dynamic margin. See also spacingBottom.
      Parameters:
      marginBottom - a Number object.

    • getMarginLeft

      public Number getMarginLeft()

      Getter for the field marginLeft.

      Returns:
      a Number object.
      See Also:

    • setMarginLeft

      public void setMarginLeft(Number marginLeft)
      The margin between the left outer edge of the chart and the plot area. Use this to set a fixed pixel value for the margin as opposed to the default dynamic margin. See also spacingLeft.
      Parameters:
      marginLeft - a Number object.

    • getMarginRight

      public Number getMarginRight()

      Getter for the field marginRight.

      Returns:
      a Number object.
      See Also:

    • setMarginRight

      public void setMarginRight(Number marginRight)
      The margin between the right outer edge of the chart and the plot area. Use this to set a fixed pixel value for the margin as opposed to the default dynamic margin. See also spacingRight.
      Parameters:
      marginRight - a Number object.

    • getMarginTop

      public Number getMarginTop()

      Getter for the field marginTop.

      Returns:
      a Number object.
      See Also:

    • setMarginTop

      public void setMarginTop(Number marginTop)
      The margin between the top outer edge of the chart and the plot area. Use this to set a fixed pixel value for the margin as opposed to the default dynamic margin. See also spacingTop.
      Parameters:
      marginTop - a Number object.

    • getPlotBackgroundColor

      public Color getPlotBackgroundColor()

      Getter for the field plotBackgroundColor.

      Returns:
      a Color object.
      See Also:

    • setPlotBackgroundColor

      public void setPlotBackgroundColor(Color plotBackgroundColor)
      The background color or gradient for the plot area.
      Parameters:
      plotBackgroundColor - a Color object.

    • getPlotBackgroundImage

      public String getPlotBackgroundImage()

      Getter for the field plotBackgroundImage.

      Returns:
      a String object.
      See Also:

    • setPlotBackgroundImage

      public void setPlotBackgroundImage(String plotBackgroundImage)
      The URL for an image to use as the plot background. To set an image as the background for the entire chart, set a CSS background image to the container element. Note that for the image to be applied to exported charts, its URL needs to be accessible by the export server.
      Parameters:
      plotBackgroundImage - a String object.

    • getPlotBorderColor

      public Color getPlotBorderColor()

      Getter for the field plotBorderColor.

      Returns:
      a Color object.
      See Also:

    • setPlotBorderColor

      public void setPlotBorderColor(Color plotBorderColor)
      The color of the inner chart or plot area border.

      Defaults to: #C0C0C0

      Parameters:
      plotBorderColor - a Color object.

    • getPlotBorderWidth

      public Number getPlotBorderWidth()

      Getter for the field plotBorderWidth.

      Returns:
      a Number object.
      See Also:

    • setPlotBorderWidth

      public void setPlotBorderWidth(Number plotBorderWidth)
      The pixel width of the plot area border.

      Defaults to: 0

      Parameters:
      plotBorderWidth - a Number object.

    • getPlotShadow

      public Boolean getPlotShadow()

      Getter for the field plotShadow.

      Returns:
      a Boolean object.
      See Also:

    • setPlotShadow

      public void setPlotShadow(Boolean plotShadow)
      Whether to apply a drop shadow to the plot area. Requires that plotBackgroundColor be set. Since 2.3 the shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.

      Defaults to: false

      Parameters:
      plotShadow - a Boolean object.

    • getReflow

      public Boolean getReflow()

      Getter for the field reflow.

      Returns:
      a Boolean object.
      See Also:

    • setReflow

      public void setReflow(Boolean reflow)
      Whether to reflow the chart to fit the width of the container div on resizing the window.

      Defaults to: true

      Parameters:
      reflow - a Boolean object.

    • getResetZoomButton

      public ResetZoomButton getResetZoomButton()

      Getter for the field resetZoomButton.

      Returns:
      a ResetZoomButton object.
      See Also:

    • setResetZoomButton

      public void setResetZoomButton(ResetZoomButton resetZoomButton)

      The button that appears after a selection zoom, allowing the user to reset zoom. In Highmaps, the reset zoom button is rarely used, as the controls for mapNavigation are used instead.

      For live demos, see the resetZoomButton options for basic Highcharts.

      Parameters:
      resetZoomButton - a ResetZoomButton object.

    • getSelectionMarkerFill

      public Color getSelectionMarkerFill()

      Getter for the field selectionMarkerFill.

      Returns:
      a Color object.
      See Also:

    • setSelectionMarkerFill

      public void setSelectionMarkerFill(Color selectionMarkerFill)
      The background color of the marker square when selecting (zooming in on) an area of the chart.

      Defaults to: rgba(69,114,167,0.25)

      Parameters:
      selectionMarkerFill - a Color 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 outer chart area. Requires that backgroundColor be set. Since 2.3 the shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.

      Defaults to: false

      Parameters:
      shadow - a Boolean object.

    • getSpacing

      public Number[] getSpacing()

      Getter for the field spacing.

      Returns:
      an array of Number objects.
      See Also:

    • setSpacing

      public void setSpacing(Number[] spacing)
      The distance between the outer edge of the chart and the content, like title and legend. The numbers in the array designate top, right, bottom and left respectively. Use the options spacingTop, spacingRight, spacingBottom and spacingLeft options for shorthand setting of one option.

      Defaults to: [10, 10, 15, 10]

      Parameters:
      spacing - an array of Number objects.

    • getSpacingBottom

      public Number getSpacingBottom()

      Getter for the field spacingBottom.

      Returns:
      a Number object.
      See Also:

    • setSpacingBottom

      public void setSpacingBottom(Number spacingBottom)

      The space between the bottom edge of the chart and the content (plot area, title, subtitle or legend in top position).

      Defaults to: 15

      Parameters:
      spacingBottom - a Number object.

    • getSpacingLeft

      public Number getSpacingLeft()

      Getter for the field spacingLeft.

      Returns:
      a Number object.
      See Also:

    • setSpacingLeft

      public void setSpacingLeft(Number spacingLeft)

      The space between the left edge of the chart and the content (plot area,title, subtitle or legend in top position).

      Defaults to: 10

      Parameters:
      spacingLeft - a Number object.

    • getSpacingRight

      public Number getSpacingRight()

      Getter for the field spacingRight.

      Returns:
      a Number object.
      See Also:

    • setSpacingRight

      public void setSpacingRight(Number spacingRight)

      The space between the right edge of the chart and the content (plot area, title, subtitle or legend in top position).

      Defaults to: 10

      Parameters:
      spacingRight - a Number object.

    • getSpacingTop

      public Number getSpacingTop()

      Getter for the field spacingTop.

      Returns:
      a Number object.
      See Also:

    • setSpacingTop

      public void setSpacingTop(Number spacingTop)

      The space between the top edge of the chart and the content (plot area, title, subtitle or legend in top position).

      Defaults to: 10

      Parameters:
      spacingTop - a Number object.

    • getStyle

      public Style getStyle()

      Getter for the field style.

      Returns:
      a Style object.
      See Also:

    • setStyle

      public void setStyle(Style style)
      Additional CSS styles to apply inline to the container div. Note that since the default font styles are applied in the renderer, it is ignorant of the individual chart options and must be set globally. Defaults to: 
       style: {
                fontFamily: '"Lucida Grande", "Lucida Sans Unicode", Verdana, Arial, Helvetica, sans-serif', // default font
                fontSize: '12px'
        }

      Defaults to: {"fontFamily": "\"Lucida Grande\", \"Lucida Sans Unicode\", Verdana, Arial, Helvetica, sans-serif" ,"fontSize":"12px"}

      Parameters:
      style - a Style object.

    • getType

      public MapType getType()

      Getter for the field type.

      Returns:
      a MapType object.
      See Also:

    • setType

      public void setType(MapType type)
      The default series type for the chart. Can be any of the chart types listed under plotOptions.

      Defaults to: map

      Parameters:
      type - a MapType object.

    • getWidth

      public Number getWidth()

      Getter for the field width.

      Returns:
      a Number object.
      See Also:

    • setWidth

      public void setWidth(Number width)
      An explicit width for the chart. By default (when null) the width is calculated from the offset width of the containing element.

      Defaults to: null

      Parameters:
      width - a Number object.

    • setMargin

      public void setMargin(Number margin)
      Sets all margins to the same value
      Parameters:
      margin - a Number object.

    • setMargin

      public void setMargin(Number vertical, Number horizontal)
      Sets the vertical margin for top and bottom and the horizontal margin for the right and left margin
      Parameters:
      vertical - a Number object.
      horizontal - a Number object.

    • setMargin

      public void setMargin(Number top, Number right, Number bottom, Number left)
      Set all margins in one call
      Parameters:
      top - a Number object.
      right - a Number object.
      bottom - a Number object.
      left - a Number object.

    • getMap

      public String getMap()

      Getter for the field map.

      Returns:
      a String object.

    • setMap

      public void setMap(String map)

      Setter for the field map.

      Parameters:
      map - a String object.