org.fujion.plotly.layout.RangeSelectorOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fujion-plotly Show documentation
The newest version!
/*
 * #%L
 * fujion
 * %%
 * Copyright (C) 2021 Fujion Framework
 * %%
 * 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.plotly.layout;

import org.fujion.ancillary.Options;
import org.fujion.annotation.Option;
import org.fujion.plotly.common.FontOptions;
import org.fujion.plotly.common.HorizontalAlignEnum;

/**
 * Layout options for range selectors.
 */
public class RangeSelectorOptions extends Options {

    /**
     * The background color of the active range selector button.
     */
    @Option
    public String activecolor;
    
    /**
     * The background color of the range selector buttons.
     * 
     * Default: "#eee"
     */
    @Option
    public String bgcolor;
    
    /**
     * The color of the border enclosing the range selector.
     * 

     * Default: "#444"
     */
    @Option
    public String bordercolor;
    
    /**
     * The width (in px) of the border enclosing the range selector.
     * 

     * Constraints: ≥0
     * 

     * Default: 0
     */
    @Option
    public Integer borderwidth;

    /**
     * Options for buttons.
     */
    @Option
    public final RangeSelectorButtonOptions buttons = new RangeSelectorButtonOptions();
    
    /**
     * The font of the range selector button text.
     */
    @Option
    public final FontOptions font = new FontOptions();

    /**
     * Determines whether or not this range selector is visible. Note that range selectors are only
     * available for x axes of "type" set to or auto-typed to "date".
     */
    @Option
    public Boolean visible;

    /**
     * The x position (in normalized coordinates) of the range selector.
     * 

     * Constraints: ≥-2 and ≤3
     */
    @Option
    public Double x;

    /**
     * The range selector's horizontal position anchor. This anchor binds the "x" position to the
     * "left", "center" or "right" of the range selector.
     * 

     * Default: LEFT
     */
    @Option
    public HorizontalAlignEnum xanchor;

    /**
     * The y position (in normalized coordinates) of the range selector.
     * 

     * Constraints: ≥-2 and ≤3
     */
    @Option
    public Double y;

    /**
     * The range selector's vertical position anchor This anchor binds the "y" position to the
     * "top", "middle" or "bottom" of the range selector.
     * 
     * Default: BOTTOM
     */
    @Option
    public HorizontalAlignEnum yanchor;
}