    001/* ===========================================================
    002 * Orson Charts : a 3D chart library for the Java(tm) platform
    003 * ===========================================================
    004 *
    005 * (C)opyright 2013-2016, by Object Refinery Limited.  All rights reserved.
    006 *
    007 * http://www.object-refinery.com/orsoncharts/index.html
    008 *
    009 * This program is free software: you can redistribute it and/or modify
    010 * it under the terms of the GNU General Public License as published by
    011 * the Free Software Foundation, either version 3 of the License, or
    012 * (at your option) any later version.
    013 *
    014 * This program is distributed in the hope that it will be useful,
    015 * but WITHOUT ANY WARRANTY; without even the implied warranty of
    016 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    017 * GNU General Public License for more details.
    018 *
    019 * You should have received a copy of the GNU General Public License
    020 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
    021 *
    022 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates.
    023 * Other names may be trademarks of their respective owners.]
    024 *
    025 * If you do not wish to be bound by the terms of the GPL, an alternative
    026 * commercial license can be purchased.  For details, please see visit the
    027 * Orson Charts home page:
    028 *
    029 * http://www.object-refinery.com/orsoncharts/index.html
    030 *
    031 */
    032
    033package com.orsoncharts.interaction;
    034
    035import com.orsoncharts.graphics3d.RenderedElement;
    036
    037/**
    038 * The type for an interactive chart element.  These values are used when
    039 * constructing a {@link RenderedElement}.  For each type, some additional
    040 * properties will usually be defined:
    041 *
    042 * <ul>
    043 * <li>CATEGORY_AXIS_TICK_LABEL: 'label' (a string containing the tick label,
    044 * and 'axis' (either 'row' or 'column');</li>
    045 * <li>LEGEND_ITEM: 'series_key' (the series key)</li>
    046 * </ul>
    047 *
    048 */
    049public enum InteractiveElementType {
    050
    051    /** A data item within a chart. */
    052    DATA_ITEM,
    053
    054    /** The chart title. */
    055    TITLE,
    056
    057    /** The chart subtitle. */
    058    SUBTITLE,
    059
    060    /** A gridline in the chart. */
    061    GRIDLINE,
    062
    063    /** An axis label (the main label for an axis, not a tick label). */
    064    AXIS_LABEL,
    065
    066    /** A category axis tick label. */
    067    CATEGORY_AXIS_TICK_LABEL,
    068
    069    /** A value axis tick label. */
    070    VALUE_AXIS_TICK_LABEL,
    071
    072    /** The section label for a pie chart. */
    073    SECTION_LABEL,
    074
    075    /** The legend (see also {@link #LEGEND_ITEM}). */
    076    LEGEND,
    077
    078    /**
    079     * An item within a legend (typically representing a series in the chart).
    080     */
    081    LEGEND_ITEM,
    082
    083    /** A marker. */
    084    MARKER;
    085
    086    private InteractiveElementType() {
    087    }
    088
    089}