org.fujion.highcharts

Class Axis

java.lang.Object

org.fujion.ancillary.Options

org.fujion.highcharts.Axis

All Implemented Interfaces:

OptionMap.IOptionMapConverter, IClientTransform

public class Axis
extends Options

A chart axis.

Field Summary

Fields

Modifier and Type	Field and Description
Boolean	allowDecimals Whether to allow decimals in this axis' ticks.
String	alternateGridColor When using an alternate grid color, a band is painted across the plot area between every other grid line.
List<String>	categories If categories are present for the x-axis, names are used instead of numbers for that axis.
Double	ceiling The highest allowed value for automatically computed axis extremes.
DateTimeFormatOptions	dateTimeLabelFormats For a date/time axis, the scale will automatically adjust to the appropriate unit.
Boolean	endOnTick Whether to force the axis to end on a tick.
Double	floor The lowest allowed value for automatically computed axis extremes.
String	gridLineColor Color of the grid lines extending the ticks across the plot area.
DashStyle	gridLineDashStyle The dash or dot style of the grid lines.
Integer	gridLineWidth The width of the grid lines extending the ticks across the plot area.
String	id An id for the axis.
int	index Index of the axis within the chart.
AxisLabelOptions	labels The axis labels show the number or category for each tick.
String	lineColor The color of the line marking the axis itself.
Integer	lineWidth The width of the line marking the axis itself.
Integer	linkedTo Index of another axis that this axis is linked to.
Double	max The maximum value of the axis.
Double	maxPadding Padding of the max value relative to the length of the axis.
Double	min The minimum value of the axis.
String	minorGridLineColor Color of the minor, secondary grid lines.
DashStyle	minorGridLineDashStyle The dash or dot style of the minor grid lines.
Integer	minorGridLineWidth Width of the minor, secondary grid lines.
String	minorTickColor Color for the minor tick marks.
Double	minorTickInterval Tick interval in scale units for the minor ticks.
Integer	minorTickLength The pixel length of the minor tick marks.
String	minorTickPosition The position of the minor tick marks relative to the axis line.
Integer	minorTickWidth The pixel width of the minor tick mark.
Double	minPadding Padding of the min value relative to the length of the axis.
Double	minRange The minimum range to display on this axis.
Double	minTickInterval The minimum tick interval allowed in axis values.
Integer	offset The distance in pixels from the plot area to the axis line.
Boolean	opposite Whether to display the axis on the opposite side of the normal.
List<PlotBandOptions>	plotBands A colored band stretching across the plot area marking an interval on the axis.
List<PlotLineOptions>	plotLines A line stretching across the plot area, marking a specific value on one of the axes.
Boolean	reversed Whether to reverse the axis so that the highest number is closest to origin.
Boolean	showEmpty Whether to show the axis line and title when the axis has no data.
Boolean	showFirstLabel Whether to show the first tick label.
Boolean	showLastLabel Whether to show the last tick label.
Integer	startOfWeek For datetime axes, this decides where to put the tick between weeks.
Boolean	startOnTick Whether to force the axis to start on a tick.
String	tickColor Color for the main tick marks.
Double	tickInterval The interval of the tick marks in axis units.
Integer	tickLength The pixel length of the main tick marks.
String	tickmarkPlacement For categorized axes only.
Integer	tickPixelInterval If tickInterval is null this option sets the approximate pixel interval of the tick marks.
String	tickPosition The position of the major tick marks relative to the axis line.
Integer	tickWidth The pixel width of the major tick marks.
AxisTitleOptions	title The axis title, showing next to the axis line.
String	type The type of axis.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Axis(List<Axis> axes)

Method Summary

Methods inherited from class org.fujion.ancillary.Options

toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.fujion.ancillary.OptionMap.IOptionMapConverter

transformForClient

Field Detail

allowDecimals

@Option
public Boolean allowDecimals

Whether to allow decimals in this axis' ticks. When counting integers, like persons or hits on a web page, decimals must be avoided in the axis tick labels. Defaults to true.

alternateGridColor

@Option
public String alternateGridColor

When using an alternate grid color, a band is painted across the plot area between every other grid line. Defaults to null.

categories

@Option
public final List<String> categories

If categories are present for the x-axis, names are used instead of numbers for that axis. Example: categories: ['Apples', 'Bananas', 'Oranges'] Defaults to none.

ceiling

@Option
public Double ceiling

The highest allowed value for automatically computed axis extremes.

dateTimeLabelFormats

@Option
public final DateTimeFormatOptions dateTimeLabelFormats

For a date/time axis, the scale will automatically adjust to the appropriate unit. This member gives the default string representations used for each unit.

See Also:

DateTimeFormatOptions

endOnTick

@Option
public Boolean endOnTick

Whether to force the axis to end on a tick. Use this option with the maxPadding option to control the axis end. Defaults to false.

floor

@Option
public Double floor

The lowest allowed value for automatically computed axis extremes. Defaults to null.

gridLineColor

@Option
public String gridLineColor

Color of the grid lines extending the ticks across the plot area. Defaults to "#C0C0C0".

gridLineDashStyle

@Option
public DashStyle gridLineDashStyle

The dash or dot style of the grid lines. Defaults to Solid.

gridLineWidth

@Option
public Integer gridLineWidth

The width of the grid lines extending the ticks across the plot area. Defaults to 0.

id

@Option
public String id

An id for the axis. Defaults to null.

labels

@Option
public AxisLabelOptions labels

The axis labels show the number or category for each tick.

lineColor

@Option
public String lineColor

The color of the line marking the axis itself. Defaults to "#C0D0E0".

lineWidth

@Option
public Integer lineWidth

The width of the line marking the axis itself. Defaults to 1.

linkedTo

@Option
public Integer linkedTo

Index of another axis that this axis is linked to. When an axis is linked to a master axis, it will take the same extremes as the master, but as assigned by min or max or by setExtremes. It can be used to show additional info, or to ease reading the chart by duplicating the scales. Defaults to null.

max

@Option
public Double max

The maximum value of the axis. If null, the max value is automatically calculated. If the endOnTick option is true, the max value might be rounded up. The actual maximum value is also influenced by chart.alignTicks. Defaults to null.

maxPadding

@Option
public Double maxPadding

Padding of the max value relative to the length of the axis. A padding of 0.05 will make a 100px axis 5px longer. This is useful when you don't want the highest data value to appear on the edge of the plot area. When the axis' max option is set or a max extreme is set using axis.setExtremes(), the maxPadding will be ignored. Defaults to 0.01.

min

@Option
public Double min

The minimum value of the axis. If null the min value is automatically calculated. If the startOnTick option is true, the min value might be rounded down. Defaults to null.

minPadding

@Option
public Double minPadding

Padding of the min value relative to the length of the axis. A padding of 0.05 will make a 100px axis 5px longer. This is useful when you don't want the lowest data value to appear on the edge of the plot area. When the axis' min option is set or a min extreme is set using axis.setExtremes(), the minPadding will be ignored. Defaults to 0.01.

minRange

@Option
public Double minRange

The minimum range to display on this axis. The entire axis will not be allowed to span over a smaller interval than this. For example, for a datetime axis the main unit is milliseconds. If minRange is set to 3600000, you can't zoom in more than to one hour. The default minRange for the x axis is five times the smallest interval between any of the data points. On a logarithmic axis, the unit for the minimum range is the power. So a minRange of 1 means that the axis can be zoomed to 10-100, 100-1000, 1000-10000 etc.

minTickInterval

@Option
public Double minTickInterval

The minimum tick interval allowed in axis values. For example on zooming in on an axis with daily data, this can be used to prevent the axis from showing hours. Defaults to undefined.

minorGridLineColor

@Option
public String minorGridLineColor

Color of the minor, secondary grid lines. Defaults to #E0E0E0.

minorGridLineDashStyle

@Option
public DashStyle minorGridLineDashStyle

The dash or dot style of the minor grid lines. Defaults to Solid.

minorGridLineWidth

@Option
public Integer minorGridLineWidth

Width of the minor, secondary grid lines. Defaults to 1.

minorTickColor

@Option
public String minorTickColor

Color for the minor tick marks. Defaults to #A0A0A0.

minorTickInterval

@Option
public Double minorTickInterval

Tick interval in scale units for the minor ticks. On a linear axis, if "auto", the minor tick interval is calculated as a fifth of the tickInterval. If null, minor ticks are not shown. On logarithmic axes, the unit is the power of the value. For example, setting the minorTickInterval to 1 puts one tick on each of 0.1, 1, 10, 100 etc. Setting the minorTickInterval to 0.1 produces 9 ticks between 1 and 10, 10 and 100 etc. A minorTickInterval of "auto" on a log axis results in a best guess, attempting to enter approximately 5 minor ticks between each major tick. Defaults to null.

minorTickLength

@Option
public Integer minorTickLength

The pixel length of the minor tick marks. Defaults to 2.

minorTickPosition

@Option
public String minorTickPosition

The position of the minor tick marks relative to the axis line. Can be one of inside and outside. Defaults to outside.

minorTickWidth

@Option
public Integer minorTickWidth

The pixel width of the minor tick mark. Defaults to 0.

offset

@Option
public Integer offset

The distance in pixels from the plot area to the axis line. A positive offset moves the axis with it's line, labels and ticks away from the plot area. This is typically used when two or more axes are displayed on the same side of the plot. Defaults to 0.

opposite

@Option
public Boolean opposite

Whether to display the axis on the opposite side of the normal. The normal is on the left side for vertical axes and bottom for horizontal, so the opposite sides will be right and top respectively. This is typically used with dual or multiple axes. Defaults to false.

plotBands

@Option
public final List<PlotBandOptions> plotBands

A colored band stretching across the plot area marking an interval on the axis.

See Also:

PlotBandOptions

plotLines

@Option
public final List<PlotLineOptions> plotLines

A line stretching across the plot area, marking a specific value on one of the axes.

See Also:

PlotLineOptions

reversed

@Option
public Boolean reversed

Whether to reverse the axis so that the highest number is closest to origin. If the chart is inverted, the x axis is reversed by default. Defaults to false.

showEmpty

@Option
public Boolean showEmpty

Whether to show the axis line and title when the axis has no data. Defaults to true.

showFirstLabel

@Option
public Boolean showFirstLabel

Whether to show the first tick label. Defaults to true.

showLastLabel

@Option
public Boolean showLastLabel

Whether to show the last tick label. Defaults to false.

startOfWeek

@Option
public Integer startOfWeek

For datetime axes, this decides where to put the tick between weeks. 0 = Sunday, 1 = Monday. Defaults to 1.

startOnTick

@Option
public Boolean startOnTick

Whether to force the axis to start on a tick. Use this option with the maxPadding option to control the axis start. Defaults to false.

tickColor

@Option
public String tickColor

Color for the main tick marks. Defaults to #C0D0E0.

tickInterval

@Option
public Double tickInterval

The interval of the tick marks in axis units. When null, the tick interval is computed to approximately follow the tickPixelInterval on linear and datetime axes. On categorized axes, a null tickInterval will default to 1, one category. Note that datetime axes are based on milliseconds, so for example an interval of one day is expressed as 24 * 3600 * 1000. On logarithmic axes, the tickInterval is based on powers, so a tickInterval of 1 means one tick on each of 0.1, 1, 10, 100 etc. A tickInterval of 2 means a tick of 0.1, 10, 1000 etc. A tickInterval of 0.2 puts a tick on 0.1, 0.2, 0.4, 0.6, 0.8, 1, 2, 4, 6, 8, 10, 20, 40 etc. Defaults to null.

tickLength

@Option
public Integer tickLength

The pixel length of the main tick marks. Defaults to 5.

tickPixelInterval

@Option
public Integer tickPixelInterval

If tickInterval is null this option sets the approximate pixel interval of the tick marks. Not applicable to categorized axis. Defaults to 72 for the Y axis and 100 for the X axis.

tickPosition

@Option
public String tickPosition

The position of the major tick marks relative to the axis line. Can be one of inside and outside. Defaults to "outside".

tickWidth

@Option
public Integer tickWidth

The pixel width of the major tick marks. Defaults to 1.

tickmarkPlacement

@Option
public String tickmarkPlacement

For categorized axes only. If "on" the tick mark is placed in the center of the category, if "between" the tick mark is placed between categories. Defaults to "between".

title

@Option
public final AxisTitleOptions title

The axis title, showing next to the axis line.

type

@Option
public String type

The type of axis. Can be one of "linear", "logarithmic" or "datetime". In a datetime axis, the numbers are given in milliseconds, and tick marks are placed on appropriate values like full hours or days. Defaults to "linear".

index

@Option(ignore=true)
public final int index

Index of the axis within the chart.

Constructor Detail

Axis

protected Axis(List<Axis> axes)