/* ====================================================================
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You 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.apache.poi.ss.usermodel.charts;

import org.apache.poi.util.Removal;

High level representation of chart axis.
Deprecated:
use XDDFChartAxis instead/**
 * High level representation of chart axis.
 *
 * @deprecated use XDDFChartAxis instead
 */
@Deprecated
@Removal(version="4.2")
public interface ChartAxis {

	
Returns:
axis id/**
	 * @return axis id
	 */
	long getId();

	
Returns:
axis position/**
	 * @return axis position
	 */
	AxisPosition getPosition();

	
Params:
position – new axis position/**
	 * @param position new axis position
	 */
	void setPosition(AxisPosition position);

	
Returns:
axis number format/**
	 * @return axis number format
	 */
	String getNumberFormat();

	
Params:
format – axis number format/**
	 * @param format axis number format
	 */
	void setNumberFormat(String format);

	
Returns:
true if log base is defined, false otherwise/**
	 * @return true if log base is defined, false otherwise
	 */
	boolean isSetLogBase();

	
Params:
logBase – a number between 2 and 1000 (inclusive)
Throws:
IllegalArgumentException – if log base not within allowed range/**
	 * @param logBase a number between 2 and 1000 (inclusive)
	 * @throws IllegalArgumentException if log base not within allowed range
	 */
	void setLogBase(double logBase);

	
Returns:
axis log base or 0.0 if not set/**
	 * @return axis log base or 0.0 if not set
	 */
	double getLogBase();

	
Returns:
true if minimum value is defined, false otherwise/**
	 * @return true if minimum value is defined, false otherwise
	 */
	boolean isSetMinimum();

	
Returns:
axis minimum or 0.0 if not set/**
	 * @return axis minimum or 0.0 if not set
	 */
	double getMinimum();

	
Params:
min – axis minimum/**
	 * @param min axis minimum
	 */
	void setMinimum(double min);

	
Returns:
true if maximum value is defined, false otherwise/**
	 * @return true if maximum value is defined, false otherwise
	 */
	boolean isSetMaximum();

	
Returns:
axis maximum or 0.0 if not set/**
	 * @return axis maximum or 0.0 if not set
	 */
	double getMaximum();

	
Params:
max – axis maximum/**
	 * @param max axis maximum
	 */
	void setMaximum(double max);

	
Returns:
axis orientation/**
	 * @return axis orientation
	 */
	AxisOrientation getOrientation();

	
Params:
orientation – axis orientation/**
	 * @param orientation axis orientation
	 */
	void setOrientation(AxisOrientation orientation);

	
Params:
crosses – axis cross type/**
	 * @param crosses axis cross type
	 */
	void setCrosses(AxisCrosses crosses);

	
Returns:
axis cross type/**
	 * @return axis cross type
	 */
	AxisCrosses getCrosses();

	
Declare this axis cross another axis.
Params:
axis – that this axis should cross/**
	 * Declare this axis cross another axis.
	 * @param axis that this axis should cross
	 */
	void crossAxis(ChartAxis axis);

    
Returns:
visibility of the axis./**
     * @return visibility of the axis.
     */
    boolean isVisible();

    
Params:
value – visibility of the axis./**
     * @param value visibility of the axis.
     */
    void setVisible(boolean value);

    
Returns:
major tick mark./**
     * @return major tick mark.
     */
    AxisTickMark getMajorTickMark();

    
Params:
tickMark – major tick mark type./**
     * @param tickMark major tick mark type.
     */
    void setMajorTickMark(AxisTickMark tickMark);

    
Returns:
minor tick mark./**
     * @return minor tick mark.
     */
    AxisTickMark getMinorTickMark();

    
Params:
tickMark – minor tick mark type./**
     * @param tickMark minor tick mark type.
     */
    void setMinorTickMark(AxisTickMark tickMark);

    
Use this to check before retrieving a number format, as calling getNumberFormat() may create a default one if none exists. 
Returns:
true if a number format element is defined, false if not/**
     * Use this to check before retrieving a number format, as calling {@link #getNumberFormat()} may create a default one if none exists.
     * @return true if a number format element is defined, false if not
     */
    boolean hasNumberFormat();
}