Package com.vaadin.componentfactory.maps.model

Class Loading

java.lang.Object
com.vaadin.componentfactory.maps.model.AbstractConfigurationObject
com.vaadin.componentfactory.maps.model.Loading
All Implemented Interfaces:
Serializable
@Generated(value="This class was generated", comments="Incorrect and missing API should be reported") public class Loading extends AbstractConfigurationObject

The loading options control the appearance of the loading screen that covers the plot area on chart operations. This screen only appears after an explicit call to chart.showLoading(). It is a utility for developers to communicate to the end user that something is going on, for example while retrieving new data via an XHR connection. The "Loading..." text itself is not part of this configuration object, but part of the lang object.

For demo cases, see the loading configuration object for basic Highcharts.

Version:
$Id: $Id
Author:
Vaadin
See Also:

  • Constructor Details

    • Loading

      public Loading()

      Constructor for Loading.

  • Method Details

    • getHideDuration

      public Number getHideDuration()

      Getter for the field hideDuration.

      Returns:
      a Number object.
      See Also:

    • setHideDuration

      public void setHideDuration(Number hideDuration)
      The duration in milliseconds of the fade out effect.

      Defaults to: 100

      Parameters:
      hideDuration - a Number object.

    • getLabelStyle

      public Style getLabelStyle()

      Getter for the field labelStyle.

      Returns:
      a Style object.
      See Also:

    • setLabelStyle

      public void setLabelStyle(Style labelStyle)
      CSS styles for the loading label span.

      Defaults to: { "fontWeight": "bold", "position": "relative", "top": "45%" }

      Parameters:
      labelStyle - a Style object.

    • getShowDuration

      public Number getShowDuration()

      Getter for the field showDuration.

      Returns:
      a Number object.
      See Also:

    • setShowDuration

      public void setShowDuration(Number showDuration)
      The duration in milliseconds of the fade in effect.

      Defaults to: 100

      Parameters:
      showDuration - a Number object.

    • getStyle

      public Style getStyle()

      Getter for the field style.

      Returns:
      a Style object.
      See Also:

    • setStyle

      public void setStyle(Style style)
      CSS styles for the loading screen that covers the plot area. Defaults to: 
       style: {
                position: 'absolute',
                backgroundColor: 'white',
                opacity: 0.5,
                textAlign: 'center'
        }
      Parameters:
      style - a Style object.