com.d3x.morpheus.viz.chart.pie.PiePlot 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.pie;

import java.awt.*;

/**
 * An interface to control pie based plots.
 *
 * @author Xavier Witdouck
 *
 * This is open source software released under the Apache 2.0 License
 */
public interface PiePlot {

    /**
     * Returns the data interface for this plot
     * @return      the data interface
     */
    PieModel data();

    /**
     * Returns the label controller for this plot
     * @return      the label controller
     */
    PieLabels labels();

    /**
     * Returns the section controller interface for the item specified
     * @param itemKey   the key for the section item
     * @return          the section controller
     */
    PieSection section(X itemKey);

    /**
     * Sets the start angle for the first section in degrees
     * @param degrees       the degrees for start angle
     * @return              this pie plot
     */
    PiePlot withStartAngle(double degrees);

    /**
     * Sets the size of the pie hole for donut plots
     * This feature does not work on 3D plots and is ignored
     * @param percent   the percent size for pie hole
     * @return          this pie plot
     */
    PiePlot withPieHole(double percent);

    /**
     * Sets the outline color for pie sections
     * @param color     the color instance
     * @return          this pie plot controller
     */
    PiePlot withSectionOutlineColor(Color color);

}