io.deephaven.plot.axisformatters.AxisFormat Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of deephaven-Plot Show documentation

The 'Plot' project

There is a newer version: 0.36.1

//
// Copyright (c) 2016-2024 Deephaven Data Labs and Patent Pending
//
package io.deephaven.plot.axisformatters;

import java.text.NumberFormat;

/**
 * Format for axis tick labels. For time values, this would be how the dates are formatted. For numerical values, this
 * would be the number of significant digits, etc.
 */
public interface AxisFormat {

    /**
     * Set the pattern used for formatting values.
     *
     * @param pattern string indicating how values should be formatted.
     */
    void setPattern(String pattern);

    /**
     * Gets the formatter for given pattern.
     * 
     * Note that as time values are expressed as numbers, a number formatter is still suitable for dates.
     * 
     *
     * @return formatter
     */
    NumberFormat getNumberFormatter();

}