com.googlecode.gflot.client.options.AxisOptions.java Source code

Introduction

Here is the source code for com.googlecode.gflot.client.options.AxisOptions.java

Source

/*
 * Copyright (c) 2012 Nicolas Morel
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 */
package com.googlecode.gflot.client.options;

import com.google.gwt.core.client.JavaScriptObject;

/**
 * @author Alexander De Leon
 */
public class AxisOptions extends AbstractAxisOptions<AxisOptions> {
    /**
     * Creates a {@link AxisOptions}
     */
    public static final AxisOptions create() {
        return JavaScriptObject.createObject().cast();
    }

    private static final String TICK_DECIMALS_KEY = "tickDecimals";

    protected AxisOptions() {
    }

    /**
     * Set the tick interval size. If you set it to 2, you'll get ticks at 2, 4, 6, etc.
     */
    public final AxisOptions setTickSize(double tickSize) {
        put(TICK_SIZE_KEY, new Double(tickSize));
        return this;
    }

    /**
     * @return the tick interval size
     */
    public final Double getTickSize() {
        return getDouble(TICK_SIZE_KEY);
    }

    /**
     * Set that you don't want ticks at a size less than the specified one
     */
    public final AxisOptions setMinTickSize(double minTickSize) {
        put(MIN_TICK_SIZE_KEY, new Double(minTickSize));
        return this;
    }

    /**
     * @return the minimal tick size
     */
    public final Double getMinTickSize() {
        return getDouble(MIN_TICK_SIZE_KEY);
    }

    /**
     * Set the number of decimals to display (default is auto-detected).
     */
    public final AxisOptions setTickDecimals(double tickDecimals) {
        put(TICK_DECIMALS_KEY, new Double(tickDecimals));
        return this;
    }

    /**
     * @return the number of decimals to display
     */
    public final Double getTickDecimals() {
        return getDouble(TICK_DECIMALS_KEY);
    }

    /**
     * Clear the number of decimals to display
     */
    public final AxisOptions clearTickDecimals() {
        clear(TICK_DECIMALS_KEY);
        return this;
    }
}