org.primefaces.model.charts.axes.cartesian.CartesianTicks Maven / Gradle / Ivy

Go to download
/*
 * 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.axes.cartesian;

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

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

/**
 * Common ticks options for cartesian types
 */
public abstract class CartesianTicks implements Serializable {

    private static final long serialVersionUID = 1L;

    private boolean autoSkip = true;
    private Number autoSkipPadding;
    private Number labelOffset;
    private Number minRotation;
    private Number maxRotation;
    private boolean mirror;
    private Number padding;

    /**
     * Gets the autoSkip
     *
     * @return autoSkip
     */
    public boolean isAutoSkip() {
        return autoSkip;
    }

    /**
     * Sets the autoSkip
     *
     * @param autoSkip If true, automatically calculates how many labels that can be shown and hides labels accordingly.
     * Turn it off to show all labels no matter what
     */
    public void setAutoSkip(boolean autoSkip) {
        this.autoSkip = autoSkip;
    }

    /**
     * Gets the autoSkipPadding
     *
     * @return autoSkipPadding
     */
    public Number getAutoSkipPadding() {
        return autoSkipPadding;
    }

    /**
     * Sets the autoSkipPadding
     *
     * @param autoSkipPadding Padding between the ticks on the horizontal axis when autoSkip is enabled.
     * Note: Only applicable to horizontal scales.
     */
    public void setAutoSkipPadding(Number autoSkipPadding) {
        this.autoSkipPadding = autoSkipPadding;
    }

    /**
     * Gets the labelOffset
     *
     * @return labelOffset
     */
    public Number getLabelOffset() {
        return labelOffset;
    }

    /**
     * Sets the labelOffset
     *
     * @param labelOffset
     * Distance in pixels to offset the label from the centre point of the tick (in the y direction for the x axis, and the x direction for the y axis).
     * Note: this can cause labels at the edges to be cropped by the edge of the canvas
     */
    public void setLabelOffset(Number labelOffset) {
        this.labelOffset = labelOffset;
    }

    /**
     * Gets the maxRotation
     *
     * @return maxRotation
     */
    public Number getMaxRotation() {
        return maxRotation;
    }

    /**
     * Sets the maxRotation
     *
     * @param maxRotation Maximum rotation for tick labels when rotating to condense labels.
     * Note: Rotation doesn't occur until necessary. Note: Only applicable to horizontal scales.
     */
    public void setMaxRotation(Number maxRotation) {
        this.maxRotation = maxRotation;
    }

    /**
     * Gets the minRotation
     *
     * @return minRotation
     */
    public Number getMinRotation() {
        return minRotation;
    }

    /**
     * Sets the minRotation
     *
     * @param minRotation Minimum rotation for tick labels.
     * Note: Only applicable to horizontal scales.
     */
    public void setMinRotation(Number minRotation) {
        this.minRotation = minRotation;
    }

    /**
     * Gets the mirror
     *
     * @return mirror
     */
    public boolean isMirror() {
        return mirror;
    }

    /**
     * Sets the mirror
     *
     * @param mirror Flips tick labels around axis, displaying the labels inside the chart instead of outside.
     * Note: Only applicable to vertical scales
     */
    public void setMirror(boolean mirror) {
        this.mirror = mirror;
    }

    /**
     * Gets the padding
     *
     * @return padding
     */
    public Number getPadding() {
        return padding;
    }

    /**
     * Sets the padding
     *
     * @param padding Padding between the tick label and the axis. When set on a vertical axis, this applies in the horizontal (X) direction.
     * When set on a horizontal axis, this applies in the vertical (Y) direction.
     */
    public void setPadding(Number padding) {
        this.padding = padding;
    }

    /**
     * Write the common ticks options
     *
     * @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, "autoSkip", this.autoSkip, false);
            ChartUtils.writeDataValue(fsw, "autoSkipPadding", this.autoSkipPadding, true);
            ChartUtils.writeDataValue(fsw, "labelOffset", this.labelOffset, true);
            ChartUtils.writeDataValue(fsw, "maxRotation", this.maxRotation, true);
            ChartUtils.writeDataValue(fsw, "minRotation", this.minRotation, true);
            ChartUtils.writeDataValue(fsw, "mirror", this.mirror, true);
            ChartUtils.writeDataValue(fsw, "padding", this.padding, true);

            return fsw.toString();
        }
    }
}