org.fujion.highcharts.LoadingOptions Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fujion-highcharts Show documentation

There is a newer version: 3.1.0

/*
 * #%L
 * fujion
 * %%
 * Copyright (C) 2008 - 2017 Regenstrief Institute, Inc.
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * #L%
 */
package org.fujion.highcharts;

import org.fujion.ancillary.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.
 */
public class LoadingOptions extends Options {
    
    /**
     * The duration in milliseconds of the fade out effect. Defaults to 100.
     */
    public Integer hideDuration;
    
    /**
     * CSS styles for the loading label span. Defaults to:
     * 
     *      *     fontWeight: 'bold'
     *     position: 'relative'
     *     top: '1em'
     * 
     */
    public final StyleOptions labelStyle = new StyleOptions();
    
    /**
     * The duration in milliseconds of the fade in effect. Defaults to 100.
     */
    public Integer showDuration;
    
    /**
     * CSS styles for the loading screen that covers the plot area. Defaults to:
     * 
     *      *     position: 'absolute',
     *     backgroundColor: 'white',
     *     opacity: 0.5,
     *     textAlign: 'center'
     * 
     */
    public final StyleOptions style = new StyleOptions();
}