com.zavtech.morpheus.viz.chart.xy.XyStyle Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of morpheus-viz Show documentation

Visualization components for the Morpheus data science library

The newest version!

/**
 * Copyright (C) 2014-2017 Xavier Witdouck
 *
 * 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.zavtech.morpheus.viz.chart.xy;

import java.awt.*;

import com.zavtech.morpheus.viz.chart.ChartShape;

/**
 * An interface to style a specific series in a plot.
 *
 * @author Xavier Witdouck
 *
 * This is open source software released under the Apache 2.0 License
 */
public interface XyStyle {

    /**
     * Sets the color for this series
     * @param color the color for series
     * @return this style instance
     */
    XyStyle withColor(Color color);

    /**
     * Sets whether line based plots should use a dashed line
     * @param dashed true if lines should be dashed
     * @return this style instance
     */
    XyStyle withDashes(boolean dashed);

    /**
     * Sets the line width for the series for line based plots
     * @param width the line wisth
     * @return this style instance
     */
    XyStyle withLineWidth(float width);

    /**
     * Sets the point shape to use for this series
     * @param shape the shape for series
     * @return this style instance
     */
    XyStyle withPointShape(ChartShape shape);

    /**
     * Sets whether points should be visible for this series
     * @param visible true to make points visible
     * @return this style instance
     */
    XyStyle withPointsVisible(boolean visible);
}