com.orsoncharts.marker.ValueMarker Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of orsoncharts Show documentation

Orson Charts is a 3D chart library for the Java platform.

There is a newer version: 1.7

/* ===========================================================
 * Orson Charts : a 3D chart library for the Java(tm) platform
 * ===========================================================
 * 
 * (C)opyright 2013-2016, by Object Refinery Limited.  All rights reserved.
 * 
 * http://www.object-refinery.com/orsoncharts/index.html
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 * 
 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 
 * Other names may be trademarks of their respective owners.]
 * 
 * If you do not wish to be bound by the terms of the GPL, an alternative
 * commercial license can be purchased.  For details, please see visit the
 * Orson Charts home page:
 * 
 * http://www.object-refinery.com/orsoncharts/index.html
 * 
 */

package com.orsoncharts.marker;

import com.orsoncharts.Range;

/**
 * A marker that can be used to mark a value or range of values on a 
 * {@link com.orsoncharts.axis.ValueAxis3D}.
 * 
 * @since 1.2
 */
public interface ValueMarker extends Marker {

    /**
     * Returns the range of values covered by the marker.  If the marker
     * represents a single value rather than a range of values, then the range
     * that is returned will have zero length.
     * 
     * @return The range (never {@code null}). 
     */
    Range getRange();
    
}