org.fujion.highcharts

Class LoadingOptions

java.lang.Object

org.fujion.ancillary.Options

org.fujion.highcharts.LoadingOptions

All Implemented Interfaces:

OptionMap.IOptionMapConverter, IClientTransform

public class LoadingOptions
extends Options

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.

Field Summary

Fields

Modifier and Type	Field and Description
Integer	hideDuration The duration in milliseconds of the fade out effect.
StyleOptions	labelStyle CSS styles for the loading label span.
Integer	showDuration The duration in milliseconds of the fade in effect.
StyleOptions	style CSS styles for the loading screen that covers the plot area.

Constructor Summary

Constructors

Constructor and Description
LoadingOptions()

Method Summary

Methods inherited from class org.fujion.ancillary.Options

toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.fujion.ancillary.OptionMap.IOptionMapConverter

transformForClient

Field Detail

hideDuration

@Option
public Integer hideDuration

The duration in milliseconds of the fade out effect. Defaults to 100.

labelStyle

@Option
public final StyleOptions labelStyle

CSS styles for the loading label span. Defaults to:

     fontWeight: 'bold'
     position: 'relative'
     top: '45%'
 

showDuration

@Option
public Integer showDuration

The duration in milliseconds of the fade in effect. Defaults to 100.

style

@Option
public final StyleOptions style

CSS styles for the loading screen that covers the plot area. Defaults to:

     position: 'absolute',
     backgroundColor: 'ffffff',
     opacity: 0.5,
     textAlign: 'center'
 

Constructor Detail

LoadingOptions

public LoadingOptions()