All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • org.chartistjsf.model.chart.ChartModel Maven / Gradle / Ivy

    There is a newer version: 3.0
    Show newest version
    /*
 * Copyright 2015 ChartistJSF.
 *
 * 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 org.chartistjsf.model.chart;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;

/**
 * 
    
 * The main model for ChartistJSF
 * 
    
 *
 * @author Hatem Alimam
 * @since 0.1
 */
public class ChartModel implements Serializable {

	/**
	 * 
	 */
	private static final long serialVersionUID = -8649635660286079308L;
	private List labels;
	private String width;
	private String height;
	private String chartPadding = "5";
	private boolean reverseData = false;
	private AspectRatio aspectRatio;
	private boolean showTooltip = false;
	private String responsiveOptions;

	public ChartModel() {
		labels = new ArrayList();
		aspectRatio = AspectRatio.GOLDEN_SECTION;
	}

	/**
	 * Returns the current labels
	 * 
	 * @return List
	 */
	public List getLabels() {
		return labels;
	}

	/**
	 * Adds a label
	 * 
	 * @param label
	 */
	public void addLabel(Object label) {
		this.labels.add(label);
	}

	/**
	 * Clears the added labels
	 * 
	 */
	public void clearLabels() {
		this.labels.clear();
	}

	/**
	 * Specify a fixed width for the chart as a string (i.e. '100px' or '50%')
	 * 
	 * @return the width
	 */
	public String getWidth() {
		return width;
	}

	/**
	 * Specify a fixed width for the chart as a string (i.e. '100px' or '50%')
	 * 
	 * @param width
	 *            the width to set
	 */
	public void setWidth(String width) {
		this.width = width;
	}

	/**
	 * Specify a fixed height for the chart as a string (i.e. '100px' or '50%')
	 * 
	 * @return the height
	 */
	public String getHeight() {
		return height;
	}

	/**
	 * Specify a fixed height for the chart as a string (i.e. '100px' or '50%')
	 * 
	 * @param height
	 *            the height to set
	 */
	public void setHeight(String height) {
		this.height = height;
	}

	/**
	 * Padding of the chart drawing area to the container element and labels as
	 * a number or padding object {top: 5, right: 5, bottom: 5, left: 5}
	 * 
	 * @return the chartPadding
	 */
	public String getChartPadding() {
		return chartPadding;
	}

	/**
	 * Padding of the chart drawing area to the container element and labels as
	 * a number or padding object {top: 5, right: 5, bottom: 5, left: 5}
	 * 
	 * @param chartPadding
	 *            the reverseData to set
	 */
	public void setChartPadding(String chartPadding) {
		this.chartPadding = chartPadding;
	}

	/**
	 * If true the whole data is reversed including labels, the series order as
	 * well as the whole series data arrays.
	 * 
	 * @return the reverseData
	 */
	public boolean isReverseData() {
		return reverseData;
	}

	/**
	 * If true the whole data is reversed including labels, the series order as
	 * well as the whole series data arrays.
	 * 
	 * @param reverseData
	 *            the reverseData to set
	 */
	public void setReverseData(boolean reverseData) {
		this.reverseData = reverseData;
	}

	/**
	 * Specify a ratio directly on chart without the need to calculate any fixed
	 * dimensions
	 * 
	 * @see AspectRatio
	 * 
	 * @return the aspectRatio
	 */
	public AspectRatio getAspectRatio() {
		return aspectRatio;
	}

	/**
	 * @param aspectRatio
	 *            the aspectRatio to set
	 */
	public void setAspectRatio(AspectRatio aspectRatio) {
		this.aspectRatio = aspectRatio;
	}

	public String getStyleClass() {
		return "ct-chart " + getAspectRatio().styleClass();
	}

	/**
	 * Enables tooltips over the points
	 * 
	 * @return the enableTooltip
	 */
	public boolean isShowTooltip() {
		return showTooltip;
	}

	/**
	 * Enables tooltips over the points
	 * 
	 * @param enableTooltip
	 *            the enableTooltip to set
	 */
	public void setShowTooltip(boolean showTooltip) {
		this.showTooltip = showTooltip;
	}

	/**
	 * Specify an array of responsive option arrays which are a media query and
	 * options object pair => [[mediaQueryString, optionsObject],[more...]]
	 * 
	 * @return the responsiveOptions
	 */
	public String getResponsiveOptions() {
		return responsiveOptions;
	}

	/**
	 * Specify an array of responsive option arrays which are a media query and
	 * options object pair => [[mediaQueryString, optionsObject],[more...]]
	 * 
	 * @param responsiveOptions
	 *            the responsiveOptions to set
	 */
	public void setResponsiveOptions(String responsiveOptions) {
		this.responsiveOptions = responsiveOptions;
	}

}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy