All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.primefaces.model.charts.optionconfig.legend.Legend Maven / Gradle / Ivy

There is a newer version: 14.0.0
Show newest version
/*
 * The MIT License
 *
 * Copyright (c) 2009-2023 PrimeTek Informatics
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.primefaces.model.charts.optionconfig.legend;

import java.io.IOException;
import java.io.Serializable;

import org.primefaces.util.ChartUtils;
import org.primefaces.util.FastStringWriter;

/**
 * The chart legend displays data about the datasets that are appearing on the chart.
 * The legend configuration is passed into the options.legend namespace. The
 * global options for the chart legend is defined in Chart.defaults.global.legend.
 */
public class Legend implements Serializable {

    private static final long serialVersionUID = 1L;

    private boolean display = true;
    private String position;
    private String align;
    private boolean fullWidth = true;
    private boolean reverse;
    private boolean rtl;
    private String textDirection;
    private LegendLabel labels;

    /**
     * Is the legend shown?
     *
     * @return the display
     */
    public boolean isDisplay() {
        return display;
    }

    /**
     * Set if the legend is shown.
     *
     * @param display the display to set
     */
    public void setDisplay(boolean display) {
        this.display = display;
    }

    /**
     * Position of the legend. top, left, bottom, right.
     *
     * @return the position
     */
    public String getPosition() {
        return position;
    }

    /**
     * Position of the legend. top, left, bottom, right.
     *
     * @param position the position to set
     */
    public void setPosition(String position) {
        this.position = position;
    }

    /**
     * Alignment of the legend. Options are:'start','center','end'. Defaults to 'center' for unrecognized values.
     *
     * @return the align
     */
    public String getAlign() {
        return align;
    }

    /**
     * Alignment of the legend. Options are:'start','center','end'. Defaults to 'center' for unrecognized values.
     *
     * @param align the align to set
     */
    public void setAlign(String align) {
        this.align = align;
    }

    /**
     * Marks that this box should take the full width of the canvas (pushing down other boxes).
     * This is unlikely to need to be changed in day-to-day use.
     *
     * @return the fullWidth
     */
    public boolean isFullWidth() {
        return fullWidth;
    }

    /**
     * Marks that this box should take the full width of the canvas (pushing down other boxes).
     * This is unlikely to need to be changed in day-to-day use.
     *
     * @param fullWidth the fullWidth to set
     */
    public void setFullWidth(boolean fullWidth) {
        this.fullWidth = fullWidth;
    }

    /**
     * Legend will show datasets in reverse order.
     *
     * @return the reverse
     */
    public boolean isReverse() {
        return reverse;
    }

    /**
     * Legend will show datasets in reverse order.
     *
     * @param reverse the reverse to set
     */
    public void setReverse(boolean reverse) {
        this.reverse = reverse;
    }

    /**
     * For rendering the legends from right to left.
     *
     * @return the rtl
     */
    public boolean isRtl() {
        return rtl;
    }

    /**
     * For rendering the legends from right to left.
     *
     * @param rtl the rtl to set
     */
    public void setRtl(boolean rtl) {
        this.rtl = rtl;
    }

    /**
     * Text Direction 'ltr' or 'rtl' regardless of the css specified on the canvas.
     *
     * @return the textDirection
     */
    public String getTextDirection() {
        return textDirection;
    }

    /**
     * Text Direction 'ltr' or 'rtl' regardless of the css specified on the canvas.
     *
     * @param textDirection the textDirection to set
     */
    public void setTextDirection(String textDirection) {
        this.textDirection = textDirection;
    }

    /**
     * The legend label configuration is nested below the legend configuration using the labels key.
     *
     * @return the labels
     */
    public LegendLabel getLabels() {
        return labels;
    }

    /**
     * The legend label configuration is nested below the legend configuration using the labels key.
     *
     * @param labels the labels to set
     */
    public void setLabels(LegendLabel labels) {
        this.labels = labels;
    }

    /**
     * Write the common options of the legend.
     *
     * @return options as JSON object
     * @throws java.io.IOException If an I/O error occurs
     */
    public String encode() throws IOException {
        try (FastStringWriter fsw = new FastStringWriter()) {
            ChartUtils.writeDataValue(fsw, "display", this.display, false);
            ChartUtils.writeDataValue(fsw, "position", this.position, true);
            ChartUtils.writeDataValue(fsw, "align", this.align, true);
            ChartUtils.writeDataValue(fsw, "fullWidth", this.fullWidth, true);
            ChartUtils.writeDataValue(fsw, "reverse", this.reverse, true);
            ChartUtils.writeDataValue(fsw, "rtl", this.rtl, true);
            ChartUtils.writeDataValue(fsw, "textDirection", this.textDirection, true);

            if (this.labels != null) {
                fsw.write(",\"labels\":" + this.labels.encode());
            }

            return fsw.toString();
        }
    }

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy