Class Axis

Field Detail

• MINOR_TICK_INTERVAL_AUTO

  public static final String MINOR_TICK_INTERVAL_AUTO

  See Also:

  Constant Field Values

• min

  protected Number min

• max

  protected Number max

Constructor Detail

• Axis

  public Axis()

Method Detail

• setAxisIndex

  public void setAxisIndex​(int i)

• getAxisIndex

  protected Integer getAxisIndex()

• getMin

  public Number getMin()

  Returns:

  the minimum value of the axis or null

  See Also:

  setMin(Number)

• setMin

  public void setMin​(Number 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.

  Parameters:

  min -

• setMin

  public void setMin​(Date min)

  The minimum value of the axis as Date.

  Parameters:

  min -

  See Also:

  setMin(Number)

• getMax

  public Number getMax()

  Returns:

  Maximum value of axis or null

  See Also:

  setMax(Number)

• setMax

  public void setMax​(Number 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.

  Parameters:

  max -

• setMax

  public void setMax​(Date max)

  The maximum value of the axis as Date.

  Parameters:

  max -

  See Also:

  setMax(Number)

• setExtremes

  public void setExtremes​(Number min,
                          Number max)

  Sets the minimum and maximum of the axes after rendering has finished. If the startOnTick and endOnTick options are true, the minimum and maximum values are rounded off to the nearest tick. To prevent this, these options can be set to false before calling setExtremes.

  Parameters:

  min - The new minimum value

  max - The new maximum value

• setExtremes

  public void setExtremes​(Date min,
                          Date max)

  The minimum and maximum value of the axis as Date.

  See Also:

  setExtremes(Number, Number)

• setExtremes

  public void setExtremes​(Number min,
                          Number max,
                          boolean redraw)

  Sets the extremes at runtime.

  Parameters:

  min - Minimum.

  max - Maximum.

  redraw - Whether or not to redraw the chart.

• setExtremes

  public void setExtremes​(Date min,
                          Date max,
                          boolean redraw)

  The minimum and maximum value of the axis as Date.

  See Also:

  setExtremes(Number, Number, boolean)

• setExtremes

  public void setExtremes​(Number minimum,
                          Number maximum,
                          boolean redraw,
                          boolean animate)

  Run-time modification of the axis extremes.

  Parameters:

  minimum - New minimum value.

  maximum - New maximum value.

  redraw - Whether or not to redraw the chart.

  animate - Whether or not to animate the rescaling.

• setExtremes

  public void setExtremes​(Date minimum,
                          Date maximum,
                          boolean redraw,
                          boolean animate)

  The minimum and maximum value of the axis as Date.

  See Also:

  setExtremes(Number, Number, boolean, boolean)

• getConfiguration

  public ChartConfiguration getConfiguration()

  Returns the configuration this axis is bound to.

  Returns:

  The configuration.

• setConfiguration

  public void setConfiguration​(ChartConfiguration configuration)

  Sets the configuration this axis is bound to. This method is automatically called by configuration, when the axis is added to it.

  Parameters:

  configuration - Configuration this object is linked to.

• getAllowDecimals

  public abstract Boolean getAllowDecimals()

  See Also:

  setAllowDecimals(Boolean)

• setAllowDecimals

  public abstract void setAllowDecimals​(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.

• getAlternateGridColor

  public abstract Color getAlternateGridColor()

  See Also:

  setAlternateGridColor(Color)

• setAlternateGridColor

  public abstract void setAlternateGridColor​(Color alternateGridColor)

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

• getCategories

  public abstract String[] getCategories()

  See Also:

  setCategories(String...)

• setCategories

  public abstract void setCategories​(String... categories)

  If categories are present for the axis, names are used instead of numbers for that axis. Since Highcharts 3.0, categories can also be extracted by giving each point a name and setting axis type to category. However, if you have multiple series, best practice remains defining the categories array.

  Example:

   categories: ['Apples', 'Bananas', 'Oranges']
   

• addCategory

  public abstract void addCategory​(String category)

  Adds category to the categories array

  Parameters:

  category - to add

  See Also:

  setCategories(String...)

• removeCategory

  public abstract void removeCategory​(String category)

  Removes first occurrence of category in categories array

  Parameters:

  category - to remove

  See Also:

  setCategories(String...)

• getCeiling

  public abstract Number getCeiling()

  See Also:

  setCeiling(Number)

• setCeiling

  public abstract void setCeiling​(Number ceiling)

  The highest allowed value for automatically computed axis extremes.

• getClassName

  public abstract String getClassName()

  See Also:

  setClassName(String)

• setClassName

  public abstract void setClassName​(String className)

  A class name that opens for styling the axis by CSS.

• getCrosshair

  public abstract Crosshair getCrosshair()

  See Also:

  setCrosshair(Crosshair)

• setCrosshair

  public abstract void setCrosshair​(Crosshair crosshair)

  Configure a crosshair that follows either the mouse pointer or the hovered point.

• getDateTimeLabelFormats

  public abstract DateTimeLabelFormats getDateTimeLabelFormats()

  See Also:

  setDateTimeLabelFormats(DateTimeLabelFormats)

• setDateTimeLabelFormats

  public abstract void setDateTimeLabelFormats​(DateTimeLabelFormats dateTimeLabelFormats)

  For a datetime axis, the scale will automatically adjust to the appropriate unit. This member gives the default string representations used for each unit. For an overview of the replacement codes, see dateFormat.

• getDescription

  public abstract String getDescription()

  See Also:

  setDescription(String)

• setDescription

  public abstract void setDescription​(String description)

  Description of the axis to screen reader users.

• getEndOnTick

  public abstract Boolean getEndOnTick()

  See Also:

  setEndOnTick(Boolean)

• setEndOnTick

  public abstract void setEndOnTick​(Boolean endOnTick)

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

• getFloor

  public abstract Number getFloor()

  See Also:

  setFloor(Number)

• setFloor

  public abstract void setFloor​(Number floor)

  The lowest allowed value for automatically computed axis extremes.

• getGridZIndex

  public abstract Number getGridZIndex()

  See Also:

  setGridZIndex(Number)

• setGridZIndex

  public abstract void setGridZIndex​(Number gridZIndex)

  The Z index of the grid lines.

• getId

  public abstract String getId()

  See Also:

  setId(String)

• setId

  public abstract void setId​(String id)

  An id for the axis. This can be used after render time to get a pointer to the axis object through chart.get().

• getLabels

  public abstract Labels getLabels()

  See Also:

  setLabels(Labels)

• setLabels

  public abstract void setLabels​(Labels labels)

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

• getLineColor

  public abstract Color getLineColor()

  See Also:

  setLineColor(Color)

• setLineColor

  public abstract void setLineColor​(Color lineColor)

  The color of the line marking the axis itself.

• getLineWidth

  public abstract Number getLineWidth()

  See Also:

  setLineWidth(Number)

• setLineWidth

  public abstract void setLineWidth​(Number lineWidth)

  The width of the line marking the axis itself.

• getLinkedTo

  public abstract Number getLinkedTo()

  See Also:

  setLinkedTo(Number)

• setLinkedTo

  public abstract void setLinkedTo​(Number 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.

• getMaxPadding

  public abstract Number getMaxPadding()

  See Also:

  setMaxPadding(Number)

• setMaxPadding

  public abstract void setMaxPadding​(Number 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.

• getMinPadding

  public abstract Number getMinPadding()

  See Also:

  setMinPadding(Number)

• setMinPadding

  public abstract void setMinPadding​(Number 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.

• getMinRange

  public abstract Number getMinRange()

  See Also:

  setMinRange(Number)

• setMinRange

  public abstract void setMinRange​(Number 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.

  Note that the minPadding, maxPadding, startOnTick and endOnTick settings also affect how the extremes of the axis are computed.

• getMinTickInterval

  public abstract Number getMinTickInterval()

  See Also:

  setMinTickInterval(Number)

• setMinTickInterval

  public abstract void setMinTickInterval​(Number 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.

• getMinorTickInterval

  public abstract String getMinorTickInterval()

  See Also:

  setMinorTickInterval(String)

• setMinorTickInterval

  public abstract void setMinorTickInterval​(String 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.

  If user settings dictate minor ticks to become too dense, they don't make sense, and will be ignored to prevent performance problems.

  On axes using categories, minor ticks are not supported.

• getMinorTickLength

  public abstract Number getMinorTickLength()

  See Also:

  setMinorTickLength(Number)

• setMinorTickLength

  public abstract void setMinorTickLength​(Number minorTickLength)

  The pixel length of the minor tick marks.

• getMinorTickPosition

  public abstract TickPosition getMinorTickPosition()

  See Also:

  setMinorTickPosition(TickPosition)

• setMinorTickPosition

  public abstract void setMinorTickPosition​(TickPosition minorTickPosition)

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

• getOffset

  public abstract Number getOffset()

  See Also:

  setOffset(Number)

• setOffset

  public abstract void setOffset​(Number 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.

• getOpposite

  public abstract Boolean getOpposite()

  See Also:

  setOpposite(Boolean)

• setOpposite

  public abstract void setOpposite​(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.

• getPlotBands

  public abstract PlotBand[] getPlotBands()

  See Also:

  setPlotBands(PlotBand...)

• setPlotBands

  public abstract void setPlotBands​(PlotBand... plotBands)

  An array of colored bands stretching across the plot area marking an interval on the axis.

• addPlotBand

  public abstract void addPlotBand​(PlotBand plotBand)

  Adds plotBand to the plotBands array

  Parameters:

  plotBand - to add

  See Also:

  setPlotBands(PlotBand...)

• removePlotBand

  public abstract void removePlotBand​(PlotBand plotBand)

  Removes first occurrence of plotBand in plotBands array

  Parameters:

  plotBand - to remove

  See Also:

  setPlotBands(PlotBand...)

• getPlotLines

  public abstract PlotLine[] getPlotLines()

  See Also:

  setPlotLines(PlotLine...)

• setPlotLines

  public abstract void setPlotLines​(PlotLine... plotLines)

  An array of lines stretching across the plot area, marking a specific value on one of the axes.

• addPlotLine

  public abstract void addPlotLine​(PlotLine plotLine)

  Adds plotLine to the plotLines array

  Parameters:

  plotLine - to add

  See Also:

  setPlotLines(PlotLine...)

• removePlotLine

  public abstract void removePlotLine​(PlotLine plotLine)

  Removes first occurrence of plotLine in plotLines array

  Parameters:

  plotLine - to remove

  See Also:

  setPlotLines(PlotLine...)

• getReversed

  public abstract Boolean getReversed()

  See Also:

  setReversed(Boolean)

• setReversed

  public abstract void setReversed​(Boolean reversed)

  Whether to reverse the axis so that the highest number is closest to the origin.

• getShowEmpty

  public abstract Boolean getShowEmpty()

  See Also:

  setShowEmpty(Boolean)

• setShowEmpty

  public abstract void setShowEmpty​(Boolean showEmpty)

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

• getShowFirstLabel

  public abstract Boolean getShowFirstLabel()

  See Also:

  setShowFirstLabel(Boolean)

• setShowFirstLabel

  public abstract void setShowFirstLabel​(Boolean showFirstLabel)

  Whether to show the first tick label.

• getShowLastLabel

  public abstract Boolean getShowLastLabel()

  See Also:

  setShowLastLabel(Boolean)

• setShowLastLabel

  public abstract void setShowLastLabel​(Boolean showLastLabel)

  Whether to show the last tick label.

• getSoftMax

  public abstract Number getSoftMax()

  See Also:

  setSoftMax(Number)

• setSoftMax

  public abstract void setSoftMax​(Number softMax)

  A soft maximum for the axis. If the series data maximum is less than this, the axis will stay at this maximum, but if the series data maximum is higher, the axis will flex to show all data.

• getSoftMin

  public abstract Number getSoftMin()

  See Also:

  setSoftMin(Number)

• setSoftMin

  public abstract void setSoftMin​(Number softMin)

  A soft minimum for the axis. If the series data minimum is greater than this, the axis will stay at this minimum, but if the series data minimum is lower, the axis will flex to show all data.

• getStartOfWeek

  public abstract Number getStartOfWeek()

  See Also:

  setStartOfWeek(Number)

• setStartOfWeek

  public abstract void setStartOfWeek​(Number startOfWeek)

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

• getStartOnTick

  public abstract Boolean getStartOnTick()

  See Also:

  setStartOnTick(Boolean)

• setStartOnTick

  public abstract void setStartOnTick​(Boolean startOnTick)

  Whether to force the axis to start on a tick. Use this option with the minPadding option to control the axis start.

• getTickAmount

  public abstract Number getTickAmount()

  See Also:

  setTickAmount(Number)

• setTickAmount

  public abstract void setTickAmount​(Number tickAmount)

  The amount of ticks to draw on the axis. This opens up for aligning the ticks of multiple charts or panes within a chart. This option overrides the tickPixelInterval option.

  This option only has an effect on linear axes. Datetime, logarithmic or category axes are not affected.

• getTickColor

  public abstract Color getTickColor()

  See Also:

  setTickColor(Color)

• setTickColor

  public abstract void setTickColor​(Color tickColor)

  Color for the main tick marks.

• getTickInterval

  public abstract Number getTickInterval()

  See Also:

  setTickInterval(Number)

• setTickInterval

  public abstract void setTickInterval​(Number 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.

  If the tickInterval is too dense for labels to be drawn, Highcharts may remove ticks.

• getTickLength

  public abstract Number getTickLength()

  See Also:

  setTickLength(Number)

• setTickLength

  public abstract void setTickLength​(Number tickLength)

  The pixel length of the main tick marks.

• getTickPixelInterval

  public abstract Number getTickPixelInterval()

  See Also:

  setTickPixelInterval(Number)

• setTickPixelInterval

  public abstract void setTickPixelInterval​(Number tickPixelInterval)

  If tickInterval is null this option sets the approximate pixel interval of the tick marks. Not applicable to categorized axis.

• getTickPosition

  public abstract TickPosition getTickPosition()

  See Also:

  setTickPosition(TickPosition)

• setTickPosition

  public abstract void setTickPosition​(TickPosition tickPosition)

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

• getTickPositions

  public abstract Number[] getTickPositions()

  See Also:

  setTickPositions(Number[])

• setTickPositions

  public abstract void setTickPositions​(Number[] tickPositions)

  An array defining where the ticks are laid out on the axis. This overrides the default behaviour of tickPixelInterval and tickInterval.

• getTickmarkPlacement

  public abstract TickmarkPlacement getTickmarkPlacement()

  See Also:

  setTickmarkPlacement(TickmarkPlacement)

• setTickmarkPlacement

  public abstract void setTickmarkPlacement​(TickmarkPlacement 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. The default is between if the tickInterval is 1, else on.

• getTitle

  public abstract AxisTitle getTitle()

  See Also:

  setTitle(AxisTitle)

• setTitle

  public abstract void setTitle​(AxisTitle title)

  The axis title, showing next to the axis line.

• getType

  public abstract AxisType getType()

  See Also:

  setType(AxisType)

• setType

  public abstract void setType​(AxisType type)

  The type of axis. Can be one of "linear", "logarithmic", "datetime" or "category". In a datetime axis, the numbers are given in milliseconds, and tick marks are placed on appropriate values like full hours or days. In a category axis, the point names of the chart's series are used for categories, if not a categories array is defined.

• getUniqueNames

  public abstract Boolean getUniqueNames()

  See Also:

  setUniqueNames(Boolean)

• setUniqueNames

  public abstract void setUniqueNames​(Boolean uniqueNames)

  Applies only when the axis type is category. When uniqueNames is true, points are placed on the X axis according to their names. If the same point name is repeated in the same or another series, the point is placed on the same X position as other points of the same name. When uniqueNames is false, the points are laid out in increasing X positions regardless of their names, and the X axis category will take the name of the last point in each position.

• getUnits

  public abstract TimeUnitMultiples[] getUnits()

  See Also:

  setUnits(TimeUnitMultiples...)

• setUnits

  public abstract void setUnits​(TimeUnitMultiples... units)

  Datetime axis only. An array determining what time intervals the ticks are allowed to fall on. Each array item is an array where the first value is the time unit and the second value another array of allowed multiples.

• addUnit

  public abstract void addUnit​(TimeUnitMultiples unit)

  Adds unit to the units array

  Parameters:

  unit - to add

  See Also:

  setUnits(TimeUnitMultiples...)

• removeUnit

  public abstract void removeUnit​(TimeUnitMultiples unit)

  Removes first occurrence of unit in units array

  Parameters:

  unit - to remove

  See Also:

  setUnits(TimeUnitMultiples...)

• getVisible

  public abstract Boolean getVisible()

  See Also:

  setVisible(Boolean)

• setVisible

  public abstract void setVisible​(Boolean visible)

  Whether axis, including axis title, line, ticks and labels, should be visible.

• setTitle

  public abstract void setTitle​(String title)