org.moxieapps.gwt.highcharts.client

Class XAxis

java.lang.Object

org.moxieapps.gwt.highcharts.client.Configurable<T>

org.moxieapps.gwt.highcharts.client.Axis<XAxis>

org.moxieapps.gwt.highcharts.client.XAxis

public class XAxis
extends Axis<XAxis>

Provides access to an object that can abe used to configure and manage the x-axis of the chart. Note that you can not instance an instance of this object directly, and instead should use the BaseChart.getXAxis() method to gain a reference to this object. Example usage:

 XAxis xAxis = chart.getXAxis()
    .setType(Axis.Type.DATE_TIME)
    .setStartOfWeek(Axis.WeekDay.SUNDAY)
    .setAxisTitleText("Year")
    .setAlternateGridColor("#CCCCCC");
 

Since:

1.0.0

Author:

squinn@moxiegroup.com (Shawn Quinn)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XAxis.TickmarkPlacement An enumeration of supported tickmark placements for when categories are in use, which can be passed to the setTickmarkPlacement(XAxis.TickmarkPlacement) method.

Nested classes/interfaces inherited from class org.moxieapps.gwt.highcharts.client.Axis

Axis.TickPosition, Axis.Type, Axis.WeekDay

Method Summary

Methods

Modifier and Type	Method and Description
XAxis	setCategories(boolean redraw, String... categories) Sets category names to use for the xAxis (instead of using numbers), explicitly controlling whether or not the axis will be redrawn in the case that the chart has already been rendered to the DOM.
XAxis	setCategories(String... categories) Sets category names to use for the xAxis (instead of using numbers).
XAxis	setLabels(XAxisLabels labels) Convenience method for setting the 'labels' options of the axis.
XAxis	setTickmarkPlacement(XAxis.TickmarkPlacement tickmarkPlacement) Convenience method for setting the 'tickmarkPlacement' option for the axis.

Methods inherited from class org.moxieapps.gwt.highcharts.client.Axis

addPlotBands, addPlotLines, createPlotBand, createPlotLine, getAxisSetExtremesEventHandler, getExtremes, getNativeAxis, removePlotBand, removePlotLine, setAllowDecimals, setAlternateGridColor, setAxisSetExtremesEventHandler, setAxisTitle, setAxisTitle, setAxisTitleText, setAxisTitleText, setDateTimeLabelFormats, setEndOnTick, setExtremes, setExtremes, setExtremes, setGridLineColor, setGridLineDashStyle, setGridLineWidth, setLineColor, setLineWidth, setLinkedTo, setMax, setMaxPadding, setMaxZoom, setMin, setMinorGridLineColor, setMinorGridLineDashStyle, setMinorGridLineWidth, setMinorTickColor, setMinorTickInterval, setMinorTickIntervalAuto, setMinorTickLength, setMinorTickPosition, setMinorTickWidth, setMinPadding, setOffset, setOpposite, setPlotBands, setPlotLines, setReversed, setShowEmpty, setShowFirstLabel, setShowLastLabel, setStartOfWeek, setStartOnTick, setTickColor, setTickInterval, setTickLength, setTickPixelInterval, setTickPosition, setTickWidth, setType, update, update

Methods inherited from class org.moxieapps.gwt.highcharts.client.Configurable

getOptions, setOption

Methods inherited from class java.lang.Object

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

Method Detail

setCategories

public XAxis setCategories(String... categories)

Sets category names to use for the xAxis (instead of using numbers). If categories are present for the xAxis, names are used instead of numbers for that axis. Example: setCategories("Apples", "Bananas", "Oranges"). Defaults to an empty array, which will use numbers for the categories instead of names when categories are present.

Note that this method will automatically redraw the categories on the chart if invoked after the chart has been rendered. For more control over when the categories are redrawn, you can utilize the setCategories(boolean, String...) method instead.

Parameters:

categories - An array of category names to use for the axis.

Returns:

A reference to this XAxis instance for convenient method chaining.

setCategories

public XAxis setCategories(boolean redraw,
                  String... categories)

Sets category names to use for the xAxis (instead of using numbers), explicitly controlling whether or not the axis will be redrawn in the case that the chart has already been rendered to the DOM. If categories are present for the xAxis, names are used instead of numbers for that axis. Example: setCategories("Apples", "Bananas", "Oranges"). Defaults to an empty array, which will use numbers for the categories instead of names when categories are present.

Parameters:

redraw - Whether to redraw the axis or wait for an explicit call to BaseChart.redraw()

categories - An array of category names to use for the axis.

Returns:

A reference to this XAxis instance for convenient method chaining.

Since:

1.1.1

setLabels

public XAxis setLabels(XAxisLabels labels)

Convenience method for setting the 'labels' options of the axis. Equivalent to code like:

     axis.setOption("/labels/align", Labels.Align.LEFT);
     axis.setOption("/labels/enabled", true);
     etc...
 

Configuration object for the axis labels, usually displaying the number for each tick. Example usage:

   axis.setLabels(
     new XAxisLabels()
       .setAlign(Labels.Align.LEFT)
       .setEnabled(true)
   );
 

Parameters:

labels - The configuration object for the axis labels, or null to use the defaults.

Returns:

A reference to this XAxis instance for convenient method chaining.

setTickmarkPlacement

public XAxis setTickmarkPlacement(XAxis.TickmarkPlacement tickmarkPlacement)

Convenience method for setting the 'tickmarkPlacement' option for the axis. Equivalent to:

     labels.setOption("tickmarkPlacement", TickmarkPlacement.ON);
 

For categorized axes only. If XAxis.TickmarkPlacement.ON the tick mark is placed in the center of the category, if XAxis.TickmarkPlacement.BETWEEN the tick mark is placed between categories. Defaults to XAxis.TickmarkPlacement.BETWEEN.

Parameters:

tickmarkPlacement - Whether or not to place the tickmark in the center or between categories.

Returns:

A reference to this Axis instance for convenient method chaining.