com.github.highcharts4gwt.model.highcharts.option.api.Pane Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of highcharts Show documentation
GWT wrapper for highcharts library.
There is a newer version: 0.0.7

package com.github.highcharts4gwt.model.highcharts.option.api;

import com.github.highcharts4gwt.model.array.api.ArrayNumber;
import com.github.highcharts4gwt.model.array.api.ArrayString;


/**
 * Applies only to polar charts and angular gauges. This configuration object holds general options for the combined X and Y axes set. Each xAxis or yAxis can reference the pane by index.
 * 
 */
public interface Pane {


    /**
     * An object, or array of objects, for backgrounds. Sub options include backgroundColor (can be solid or gradient), shape ("solid" or "arc"), innerWidth, outerWidth, borderWidth, borderColor.
     * 
     */
    String background();

    /**
     * An object, or array of objects, for backgrounds. Sub options include backgroundColor (can be solid or gradient), shape ("solid" or "arc"), innerWidth, outerWidth, borderWidth, borderColor.
     * 
     */
    Pane background(String backgroundAsJsonStringArray);

    /**
     * The center of a polar chart or angular gauge, given as an array of [x, y] positions. Positions can be given as integers that transform to pixels, or as percentages of the plot area size.
     * 
     */
    ArrayString centerAsArrayString();

    /**
     * The center of a polar chart or angular gauge, given as an array of [x, y] positions. Positions can be given as integers that transform to pixels, or as percentages of the plot area size.
     * 
     */
    Pane centerAsArrayString(ArrayString centerAsArrayString);

    /**
     * The center of a polar chart or angular gauge, given as an array of [x, y] positions. Positions can be given as integers that transform to pixels, or as percentages of the plot area size.
     * 
     */
    ArrayNumber centerAsArrayNumber();

    /**
     * The center of a polar chart or angular gauge, given as an array of [x, y] positions. Positions can be given as integers that transform to pixels, or as percentages of the plot area size.
     * 
     */
    Pane centerAsArrayNumber(ArrayNumber centerAsArrayNumber);

    /**
     * The end angle of the polar X axis or gauge value axis, given in degrees where 0 is north. Defaults to startAngle + 360.
     * 
     */
    double endAngle();

    /**
     * The end angle of the polar X axis or gauge value axis, given in degrees where 0 is north. Defaults to startAngle + 360.
     * 
     */
    Pane endAngle(double endAngle);

    /**
     * The size of the pane, either as a number defining pixels, or a percentage defining a percentage of the plot are.
     * 
     */
    double sizeAsNumber();

    /**
     * The size of the pane, either as a number defining pixels, or a percentage defining a percentage of the plot are.
     * 
     */
    Pane sizeAsNumber(double sizeAsNumber);

    /**
     * The size of the pane, either as a number defining pixels, or a percentage defining a percentage of the plot are.
     * 
     */
    String sizeAsString();

    /**
     * The size of the pane, either as a number defining pixels, or a percentage defining a percentage of the plot are.
     * 
     */
    Pane sizeAsString(String sizeAsString);

    /**
     * The start angle of the polar X axis or gauge axis, given in degrees where 0 is north. Defaults to 0.
     * 
     */
    double startAngle();

    /**
     * The start angle of the polar X axis or gauge axis, given in degrees where 0 is north. Defaults to 0.
     * 
     */
    Pane startAngle(double startAngle);

    String getFieldAsJsonObject(String fieldName);

    Pane setFieldAsJsonObject(String fieldName, String fieldValueAsJonObject);

    String getFunctionAsString(String fieldName);

    Pane setFunctionAsString(String fieldName, String functionAsString);

}