com.d3x.morpheus.viz.chart.xy.XyAxis Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of d3x-morpheus-viz Show documentation
The newest version!
/*
 * Copyright (C) 2014-2018 D3X Systems - All Rights Reserved
 *
 * 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.
 */
package com.d3x.morpheus.viz.chart.xy;

import com.d3x.morpheus.util.Bounds;
import com.d3x.morpheus.viz.chart.ChartFormat;
import com.d3x.morpheus.viz.chart.ChartLabel;
import com.d3x.morpheus.viz.chart.ChartTextStyle;

/**
 * An interface to an axis in an XyPlot.
 *
 * @author Xavier Witdouck
 *
 * This is open source software released under the Apache 2.0 License
 */
public interface XyAxis {

    /**
     * Returns the label for this axis
     * @return  the label for axis
     */
    ChartLabel label();

    /**
     * Returns the format for this axis
     * @return  the format for this axis
     */
    ChartFormat format();

    /**
     * Returns the style interface for this axis
     * @return      the style interface
     */
    ChartTextStyle ticks();

    /**
     * Marks this axis as a log scale axis
     * @return  this axis
     */
    XyAxis asLogScale();

    /**
     * Marks this axis as a linear numeric axis
     * @return  this axis
     */
    XyAxis asLinearScale();

    /**
     * Marks this axis as a linear date axis
     * @return  this axis
     */
    XyAxis asDateScale();

    /**
     * Sets the upper and lower bounds for the range of this axis
     * @param range     the range for this axis
     * @return          this axis
     */
    XyAxis withRange(Bounds range);
}