Package com.vaadin.flow.component.charts.model

Class YAxis

java.lang.Object
com.vaadin.flow.component.charts.model.AbstractConfigurationObject
com.vaadin.flow.component.charts.model.Axis
com.vaadin.flow.component.charts.model.YAxis
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
ColorAxis
public class YAxis extends Axis

The Y axis or value axis. In case of multiple axes, the yAxis node is an array of configuration objects.

See the Axis object for programmatic access to the axis.

See Also:

  • Constructor Details

    • YAxis

      public YAxis()

  • Method Details

    • getAllowDecimals

      public Boolean getAllowDecimals()
      Specified by:
      getAllowDecimals in class Axis
      See Also:

    • setAllowDecimals

      public void setAllowDecimals(Boolean allowDecimals)
      Whether to allow decimals in this axis' ticks. When counting integers, like persons or hits on a web page, decimals should be avoided in the labels.

      Defaults to: true

      Specified by:
      setAllowDecimals in class Axis

    • getAlternateGridColor

      public Color getAlternateGridColor()
      Specified by:
      getAlternateGridColor in class Axis
      See Also:

    • setAlternateGridColor

      public void setAlternateGridColor(Color alternateGridColor)
      When using an alternate grid color, a band is painted across the plot area between every other grid line.
      Specified by:
      setAlternateGridColor in class Axis

    • getAngle

      public Number getAngle()
      See Also:

    • setAngle

      public void setAngle(Number angle)
      In a polar chart, this is the angle of the Y axis in degrees, where 0 is up and 90 is right. The angle determines the position of the axis line and the labels, though the coordinate system is unaffected.

      Defaults to: 0

    • getBreaks

      public Breaks[] getBreaks()
      See Also:

    • setBreaks

      public void setBreaks(Breaks[] breaks)
      An array defining breaks in the axis, the sections defined will be left out and all the points shifted closer to each other. Requires that the broken-axis.js module is loaded.

    • getCategories

      public String[] getCategories()
      Specified by:
      getCategories in class Axis
      See Also:

    • setCategories

      public void setCategories(String... categories)

      If categories are present for the xAxis, 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']
      Defaults to null

      Specified by:
      setCategories in class Axis

    • addCategory

      public void addCategory(String category)
      Adds category to the categories array
      Specified by:
      addCategory in class Axis
      Parameters:
      category - to add
      See Also:

    • removeCategory

      public void removeCategory(String category)
      Removes first occurrence of category in categories array
      Specified by:
      removeCategory in class Axis
      Parameters:
      category - to remove
      See Also:

    • getCeiling

      public Number getCeiling()
      Specified by:
      getCeiling in class Axis
      See Also:

    • setCeiling

      public void setCeiling(Number ceiling)
      The highest allowed value for automatically computed axis extremes.
      Specified by:
      setCeiling in class Axis

    • getClassName

      public String getClassName()
      Specified by:
      getClassName in class Axis
      See Also:

    • setClassName

      public void setClassName(String className)
      A class name that opens for styling the axis by CSS, especially in Highcharts styled mode. The class name is applied to group elements for the grid, axis elements and labels.
      Specified by:
      setClassName in class Axis

    • getCrosshair

      public Crosshair getCrosshair()
      Specified by:
      getCrosshair in class Axis
      See Also:

    • setCrosshair

      public void setCrosshair(Crosshair crosshair)

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

      In styled mode, the crosshairs are styled in the .highcharts-crosshair, .highcharts-crosshair-thin or .highcharts-xaxis-category classes.

      Defaults to: false

      Specified by:
      setCrosshair in class Axis

    • getDateTimeLabelFormats

      public DateTimeLabelFormats getDateTimeLabelFormats()
      Specified by:
      getDateTimeLabelFormats in class Axis
      See Also:

    • setDateTimeLabelFormats

      public 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 intermediate values, different units may be used, for example the day unit can be used on midnight and hour unit be used for intermediate values on the same axis. For an overview of the replacement codes, see dateFormat. Defaults to: 
       {
                millisecond: '%H:%M:%S.%L',
                second: '%H:%M:%S',
                minute: '%H:%M',
                hour: '%H:%M',
                day: '%e. %b',
                week: '%e. %b',
                month: '%b \'%y',
                year: '%Y'
        }
      Specified by:
      setDateTimeLabelFormats in class Axis

    • getDescription

      public String getDescription()
      Specified by:
      getDescription in class Axis
      See Also:

    • setDescription

      public void setDescription(String description)

      Requires Accessibility module

      Description of the axis to screen reader users.

      Defaults to: undefined

      Specified by:
      setDescription in class Axis

    • getEndOnTick

      public Boolean getEndOnTick()
      Specified by:
      getEndOnTick in class Axis
      See Also:

    • setEndOnTick

      public 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.

      Defaults to: true

      Specified by:
      setEndOnTick in class Axis

    • getFloor

      public Number getFloor()
      Specified by:
      getFloor in class Axis
      See Also:

    • setFloor

      public void setFloor(Number floor)
      The lowest allowed value for automatically computed axis extremes.

      Defaults to: null

      Specified by:
      setFloor in class Axis

    • getGridLineColor

      public Color getGridLineColor()
      See Also:

    • setGridLineColor

      public void setGridLineColor(Color gridLineColor)

      Color of the grid lines extending the ticks across the plot area.

      In styled mode, the stroke is given in the .highcharts-grid-line class.

      Defaults to: #e6e6e6

    • getGridLineDashStyle

      public DashStyle getGridLineDashStyle()
      See Also:

    • setGridLineDashStyle

      public void setGridLineDashStyle(DashStyle gridLineDashStyle)
      The dash or dot style of the grid lines. For possible values, see this demonstration.

      Defaults to: Solid

    • getGridLineInterpolation

      public String getGridLineInterpolation()
      See Also:

    • setGridLineInterpolation

      public void setGridLineInterpolation(String gridLineInterpolation)
      Polar charts only. Whether the grid lines should draw as a polygon with straight lines between categories, or as circles. Can be either circle or polygon.

      Defaults to: null

    • getGridLineWidth

      public Number getGridLineWidth()
      See Also:

    • setGridLineWidth

      public void setGridLineWidth(Number gridLineWidth)
      The width of the grid lines extending the ticks across the plot area.

      Defaults to: 1

    • getGridZIndex

      public Number getGridZIndex()
      Specified by:
      getGridZIndex in class Axis
      See Also:

    • setGridZIndex

      public void setGridZIndex(Number gridZIndex)
      The Z index of the grid lines.

      Defaults to: 1

      Specified by:
      setGridZIndex in class Axis

    • getId

      public String getId()
      Specified by:
      getId in class Axis
      See Also:

    • setId

      public 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().
      Specified by:
      setId in class Axis

    • getLabels

      public Labels getLabels()
      Specified by:
      getLabels in class Axis
      See Also:

    • setLabels

      public void setLabels(Labels labels)
      Description copied from class: Axis
      The axis labels show the number or category for each tick.
      Specified by:
      setLabels in class Axis

    • getLineColor

      public Color getLineColor()
      Specified by:
      getLineColor in class Axis
      See Also:

    • setLineColor

      public void setLineColor(Color lineColor)

      The color of the line marking the axis itself.

      In styled mode, the line stroke is given in the .highcharts-axis-line or .highcharts-xaxis-line class.

      Defaults to: #ccd6eb

      Specified by:
      setLineColor in class Axis

    • getLineWidth

      public Number getLineWidth()
      Specified by:
      getLineWidth in class Axis
      See Also:

    • setLineWidth

      public void setLineWidth(Number lineWidth)
      The width of the line marking the axis itself.

      Defaults to: 0

      Specified by:
      setLineWidth in class Axis

    • getLinkedTo

      public Number getLinkedTo()
      Specified by:
      getLinkedTo in class Axis
      See Also:

    • setLinkedTo

      public 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.
      Specified by:
      setLinkedTo in class Axis

    • getMaxColor

      public Color getMaxColor()
      See Also:

    • setMaxColor

      public void setMaxColor(Color maxColor)
      Solid gauge only. Unless stops are set, the color to represent the maximum value of the Y axis.

      Defaults to: #003399

    • getMaxPadding

      public Number getMaxPadding()
      Specified by:
      getMaxPadding in class Axis
      See Also:

    • setMaxPadding

      public 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.

      Defaults to: 0.05

      Specified by:
      setMaxPadding in class Axis

    • getMinColor

      public Color getMinColor()
      See Also:

    • setMinColor

      public void setMinColor(Color minColor)
      Solid gauge only. Unless stops are set, the color to represent the minimum value of the Y axis.

      Defaults to: #e6ebf5

    • getMinPadding

      public Number getMinPadding()
      Specified by:
      getMinPadding in class Axis
      See Also:

    • setMinPadding

      public 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.

      Defaults to: 0.05

      Specified by:
      setMinPadding in class Axis

    • getMinRange

      public Number getMinRange()
      Specified by:
      getMinRange in class Axis
      See Also:

    • setMinRange

      public 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.

      Specified by:
      setMinRange in class Axis

    • getMinTickInterval

      public Number getMinTickInterval()
      Specified by:
      getMinTickInterval in class Axis
      See Also:

    • setMinTickInterval

      public 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. Defaults to the closest distance between two points on the axis.
      Specified by:
      setMinTickInterval in class Axis

    • getMinorGridLineColor

      public Color getMinorGridLineColor()
      See Also:

    • setMinorGridLineColor

      public void setMinorGridLineColor(Color minorGridLineColor)

      Color of the minor, secondary grid lines.

      In styled mode, the stroke width is given in the .highcharts-minor-grid-line class.

      Defaults to: #f2f2f2

    • getMinorGridLineDashStyle

      public DashStyle getMinorGridLineDashStyle()
      See Also:

    • setMinorGridLineDashStyle

      public void setMinorGridLineDashStyle(DashStyle minorGridLineDashStyle)
      The dash or dot style of the minor grid lines. For possible values, see this demonstration.

      Defaults to: Solid

    • getMinorGridLineWidth

      public Number getMinorGridLineWidth()
      See Also:

    • setMinorGridLineWidth

      public void setMinorGridLineWidth(Number minorGridLineWidth)

      Width of the minor, secondary grid lines.

      In styled mode, the stroke width is given in the .highcharts-grid-line class.

      Defaults to: 1

    • getMinorTickColor

      public Color getMinorTickColor()
      See Also:

    • setMinorTickColor

      public void setMinorTickColor(Color minorTickColor)
      Color for the minor tick marks.

      Defaults to: #999999

    • getMinorTickInterval

      public String getMinorTickInterval()
      Specified by:
      getMinorTickInterval in class Axis
      See Also:

    • setMinorTickInterval

      public 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.

      Specified by:
      setMinorTickInterval in class Axis

    • getMinorTickLength

      public Number getMinorTickLength()
      Specified by:
      getMinorTickLength in class Axis
      See Also:

    • setMinorTickLength

      public void setMinorTickLength(Number minorTickLength)
      The pixel length of the minor tick marks.

      Defaults to: 2

      Specified by:
      setMinorTickLength in class Axis

    • getMinorTickPosition

      public TickPosition getMinorTickPosition()
      Specified by:
      getMinorTickPosition in class Axis
      See Also:

    • setMinorTickPosition

      public void setMinorTickPosition(TickPosition minorTickPosition)
      The position of the minor tick marks relative to the axis line. Can be one of inside and outside.

      Defaults to: outside

      Specified by:
      setMinorTickPosition in class Axis

    • getMinorTickWidth

      public Number getMinorTickWidth()
      See Also:

    • setMinorTickWidth

      public void setMinorTickWidth(Number minorTickWidth)
      The pixel width of the minor tick mark.

      Defaults to: 0

    • getOffset

      public Number getOffset()
      Specified by:
      getOffset in class Axis
      See Also:

    • setOffset

      public 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. With multiple axes the offset is dynamically adjusted to avoid collision, this can be overridden by setting offset explicitly.

      Defaults to: 0

      Specified by:
      setOffset in class Axis

    • getOpposite

      public Boolean getOpposite()
      Specified by:
      getOpposite in class Axis
      See Also:

    • setOpposite

      public 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.

      Defaults to: false

      Specified by:
      setOpposite in class Axis

    • getPlotBands

      public PlotBand[] getPlotBands()
      Specified by:
      getPlotBands in class Axis
      See Also:

    • setPlotBands

      public void setPlotBands(PlotBand... plotBands)
      An array of objects defining plot bands on the Y axis.
      Specified by:
      setPlotBands in class Axis

    • addPlotBand

      public void addPlotBand(PlotBand plotBand)
      Adds plotBand to the plotBands array
      Specified by:
      addPlotBand in class Axis
      Parameters:
      plotBand - to add
      See Also:

    • removePlotBand

      public void removePlotBand(PlotBand plotBand)
      Removes first occurrence of plotBand in plotBands array
      Specified by:
      removePlotBand in class Axis
      Parameters:
      plotBand - to remove
      See Also:

    • getPlotLines

      public PlotLine[] getPlotLines()
      Specified by:
      getPlotLines in class Axis
      See Also:

    • setPlotLines

      public void setPlotLines(PlotLine... plotLines)
      An array of objects representing plot lines on the X axis
      Specified by:
      setPlotLines in class Axis

    • addPlotLine

      public void addPlotLine(PlotLine plotLine)
      Adds plotLine to the plotLines array
      Specified by:
      addPlotLine in class Axis
      Parameters:
      plotLine - to add
      See Also:

    • removePlotLine

      public void removePlotLine(PlotLine plotLine)
      Removes first occurrence of plotLine in plotLines array
      Specified by:
      removePlotLine in class Axis
      Parameters:
      plotLine - to remove
      See Also:

    • getReversed

      public Boolean getReversed()
      Specified by:
      getReversed in class Axis
      See Also:

    • setReversed

      public void setReversed(Boolean reversed)
      Whether to reverse the axis so that the highest number is closest to the origin. If the chart is inverted, the x axis is reversed by default.

      Defaults to: false

      Specified by:
      setReversed in class Axis

    • getReversedStacks

      public Boolean getReversedStacks()
      See Also:

    • setReversedStacks

      public void setReversedStacks(Boolean reversedStacks)
      If true, the first series in a stack will be drawn on top in a positive, non-reversed Y axis. If false, the first series is in the base of the stack.

      Defaults to: true

    • getShowEmpty

      public Boolean getShowEmpty()
      Specified by:
      getShowEmpty in class Axis
      See Also:

    • setShowEmpty

      public void setShowEmpty(Boolean showEmpty)
      Whether to show the axis line and title when the axis has no data.

      Defaults to: true

      Specified by:
      setShowEmpty in class Axis

    • getShowFirstLabel

      public Boolean getShowFirstLabel()
      Specified by:
      getShowFirstLabel in class Axis
      See Also:

    • setShowFirstLabel

      public void setShowFirstLabel(Boolean showFirstLabel)
      Whether to show the first tick label.

      Defaults to: true

      Specified by:
      setShowFirstLabel in class Axis

    • getShowLastLabel

      public Boolean getShowLastLabel()
      Specified by:
      getShowLastLabel in class Axis
      See Also:

    • setShowLastLabel

      public void setShowLastLabel(Boolean showLastLabel)
      Whether to show the last tick label. Defaults to true on cartesian charts, and false on polar charts.
      Specified by:
      setShowLastLabel in class Axis

    • getSoftMax

      public Number getSoftMax()
      Specified by:
      getSoftMax in class Axis
      See Also:

    • setSoftMax

      public 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.
      Specified by:
      setSoftMax in class Axis

    • getSoftMin

      public Number getSoftMin()
      Specified by:
      getSoftMin in class Axis
      See Also:

    • setSoftMin

      public 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.
      Specified by:
      setSoftMin in class Axis

    • getStackLabels

      public StackLabels getStackLabels()
      See Also:

    • setStackLabels

      public void setStackLabels(StackLabels stackLabels)
      The stack labels show the total value for each bar in a stacked column or bar chart. The label will be placed on top of positive columns and below negative columns. In case of an inverted column chart or a bar chart the label is placed to the right of positive bars and to the left of negative bars.

    • getStartOfWeek

      public Number getStartOfWeek()
      Specified by:
      getStartOfWeek in class Axis
      See Also:

    • setStartOfWeek

      public void setStartOfWeek(Number startOfWeek)
      For datetime axes, this decides where to put the tick between weeks. 0 = Sunday, 1 = Monday.

      Defaults to: 1

      Specified by:
      setStartOfWeek in class Axis

    • getStartOnTick

      public Boolean getStartOnTick()
      Specified by:
      getStartOnTick in class Axis
      See Also:

    • setStartOnTick

      public void setStartOnTick(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: true

      Specified by:
      setStartOnTick in class Axis

    • getTickAmount

      public Number getTickAmount()
      Specified by:
      getTickAmount in class Axis
      See Also:

    • setTickAmount

      public 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.

      Specified by:
      setTickAmount in class Axis

    • getTickColor

      public Color getTickColor()
      Specified by:
      getTickColor in class Axis
      See Also:

    • setTickColor

      public void setTickColor(Color tickColor)

      Color for the main tick marks.

      In styled mode, the stroke is given in the .highcharts-tick class.

      Defaults to: #ccd6eb

      Specified by:
      setTickColor in class Axis

    • getTickInterval

      public Number getTickInterval()
      Specified by:
      getTickInterval in class Axis
      See Also:

    • setTickInterval

      public 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.

      If the chart has multiple axes, the alignTicks option may interfere with the tickInterval setting.

      Specified by:
      setTickInterval in class Axis

    • getTickLength

      public Number getTickLength()
      Specified by:
      getTickLength in class Axis
      See Also:

    • setTickLength

      public void setTickLength(Number tickLength)
      The pixel length of the main tick marks.

      Defaults to: 10

      Specified by:
      setTickLength in class Axis

    • getTickPixelInterval

      public Number getTickPixelInterval()
      Specified by:
      getTickPixelInterval in class Axis
      See Also:

    • setTickPixelInterval

      public void setTickPixelInterval(Number tickPixelInterval)

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

      The tick interval is also influenced by the minTickInterval option, that, by default prevents ticks from being denser than the data points.

      Defaults to 72 for the Y axis and 100 for the X axis.

      Specified by:
      setTickPixelInterval in class Axis

    • getTickPosition

      public TickPosition getTickPosition()
      Specified by:
      getTickPosition in class Axis
      See Also:

    • setTickPosition

      public void setTickPosition(TickPosition tickPosition)
      The position of the major tick marks relative to the axis line. Can be one of inside and outside.

      Defaults to: outside

      Specified by:
      setTickPosition in class Axis

    • getTickPositions

      public Number[] getTickPositions()
      Specified by:
      getTickPositions in class Axis
      See Also:

    • setTickPositions

      public 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.
      Specified by:
      setTickPositions in class Axis

    • getTickWidth

      public Number getTickWidth()
      See Also:

    • setTickWidth

      public void setTickWidth(Number tickWidth)
      The pixel width of the major tick marks.

      Defaults to: 0

    • getTickmarkPlacement

      public TickmarkPlacement getTickmarkPlacement()
      Specified by:
      getTickmarkPlacement in class Axis
      See Also:

    • setTickmarkPlacement

      public 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.

      Defaults to: null

      Specified by:
      setTickmarkPlacement in class Axis

    • getTitle

      public AxisTitle getTitle()
      Specified by:
      getTitle in class Axis
      See Also:

    • setTitle

      public void setTitle(AxisTitle title)
      Description copied from class: Axis
      The axis title, showing next to the axis line.
      Specified by:
      setTitle in class Axis

    • getType

      public AxisType getType()
      Specified by:
      getType in class Axis
      See Also:

    • setType

      public 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.

      Defaults to: linear

      Specified by:
      setType in class Axis

    • getUniqueNames

      public Boolean getUniqueNames()
      Specified by:
      getUniqueNames in class Axis
      See Also:

    • setUniqueNames

      public 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.

      Defaults to: true

      Specified by:
      setUniqueNames in class Axis

    • getUnits

      public TimeUnitMultiples[] getUnits()
      Specified by:
      getUnits in class Axis
      See Also:

    • setUnits

      public 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. Defaults to: 
       units: [[
                'millisecond', // unit name
                [1, 2, 5, 10, 20, 25, 50, 100, 200, 500] // allowed multiples
        ], [
                'second',
                [1, 2, 5, 10, 15, 30]
        ], [
                'minute',
                [1, 2, 5, 10, 15, 30]
        ], [
                'hour',
                [1, 2, 3, 4, 6, 8, 12]
        ], [
                'day',
                [1]
        ], [
                'week',
                [1]
        ], [
                'month',
                [1, 3, 6]
        ], [
                'year',
                null
        ]]
      Specified by:
      setUnits in class Axis

    • addUnit

      public void addUnit(TimeUnitMultiples unit)
      Adds unit to the units array
      Specified by:
      addUnit in class Axis
      Parameters:
      unit - to add
      See Also:

    • removeUnit

      public void removeUnit(TimeUnitMultiples unit)
      Removes first occurrence of unit in units array
      Specified by:
      removeUnit in class Axis
      Parameters:
      unit - to remove
      See Also:

    • getVisible

      public Boolean getVisible()
      Specified by:
      getVisible in class Axis
      See Also:

    • setVisible

      public void setVisible(Boolean visible)
      Whether axis, including axis title, line, ticks and labels, should be visible.

      Defaults to: true

      Specified by:
      setVisible in class Axis

    • getHeight

      public String getHeight()
      See Also:

    • setHeight

      public void setHeight(String height)

      The height of the Y axis. If it's a number, it is interpreted as pixels.

      Since Highstock 2: If it's a percentage string, it is interpreted as percentages of the total plot height.

      Defaults to: null

    • getOrdinal

      public Boolean getOrdinal()
      See Also:

    • setOrdinal

      public void setOrdinal(Boolean ordinal)
      In an ordinal axis, the points are equally spaced in the chart regardless of the actual time or x distance between them. This means that missing data for nights or weekends will not take up space in the chart.

      Defaults to: true

    • getRange

      public Number getRange()
      See Also:

    • setRange

      public void setRange(Number range)
      The zoomed range to display when only defining one or none of min or max. For example, to show the latest month, a range of one month can be set.

      Defaults to: undefined

    • getScrollbar

      public Scrollbar getScrollbar()
      See Also:

    • setScrollbar

      public void setScrollbar(Scrollbar scrollbar)

      An optional scrollbar to display on the Y axis in response to limiting the minimum an maximum of the axis values.

      In styled mode, all the presentational options for the scrollbar are replaced by the classes .highcharts-scrollbar-thumb, .highcharts-scrollbar-arrow, .highcharts-scrollbar-button, .highcharts-scrollbar-rifles and .highcharts-scrollbar-track.

    • getTop

      public String getTop()
      See Also:

    • setTop

      public void setTop(String top)

      The top position of the Y axis. If it's a number, it is interpreted as pixel position relative to the chart.

      Since Highstock 2: If it's a percentage string, it is interpreted as percentages of the plot height, offset from plot area top.

      Defaults to: null

    • getPane

      public Number getPane()

    • setPane

      public void setPane(Number pane)

    • setPane

      public void setPane(Pane pane)

    • setTitle

      public void setTitle(String title)
      Specified by:
      setTitle in class Axis

    • setLinkedTo

      public void setLinkedTo(YAxis axis)

    • getStops

      public Stop[] getStops()
      See Also:

    • setStops

      public void setStops(Stop... stops)

    • addStop

      public void addStop(Stop stop)
      Adds stop to the stops array
      Parameters:
      stop - to add
      See Also:

    • removeStop

      public void removeStop(Stop stop)
      Removes first occurrence of stop in stops array
      Parameters:
      stop - to remove
      See Also:

    • getGrid

      public AxisGrid getGrid()
      See Also:

    • setGrid

      public void setGrid(AxisGrid grid)
      Set grid options for the axis labels. Relevant only for Highcharts Gantt.

    • getAlignTicks

      public Boolean getAlignTicks()
      See Also:

    • setAlignTicks

      public void setAlignTicks(Boolean alignTicks)
      When using multiple axis, the ticks of two or more opposite axes will automatically be aligned by adding ticks to the axis or axes with the least ticks, as if tickAmount were specified. This can be prevented by setting alignTicks to false. If the grid lines look messy, it's a good idea to hide them for the secondary axis by setting gridLineWidth to 0. If startOnTick or endOnTick in an Axis options are set to false, then the alignTicks will be disabled for the Axis. Disabled for logarithmic axes. Defaults to true.
      Parameters:
      alignTicks -

    • getMargin

      public Number getMargin()
      See Also:

    • setMargin

      public void setMargin(Number margin)
      If there are multiple axes on the same side of the chart, the pixel margin between the axes. Defaults to 0 on vertical axes, 15 on horizontal axes.
      Parameters:
      margin -

    • getMaxRange

      public Number getMaxRange()
      See Also:

    • setMaxRange

      public void setMaxRange(Number maxRange)
      Maximum range which can be set using the navigator's handles. Opposite of setMinRange(Number)
      Parameters:
      maxRange -

    • getMinorTicks

      public Boolean getMinorTicks()
      See Also:

    • setMinorTicks

      public void setMinorTicks(Boolean minorTicks)
      Enable or disable minor ticks. Unless minorTickInterval is set, the tick interval is calculated as a fifth of the tickInterval. On a logarithmic axis, minor ticks are laid out based on a best guess, attempting to enter approximately 5 minor ticks between each major tick. Prior to v6.0.0, ticks were unabled in auto layout by setting minorTickInterval to "auto". Defaults to false.
      Parameters:
      minorTicks -

    • getStaticScale

      public Number getStaticScale()
      See Also:

    • setStaticScale

      public void setStaticScale(Number staticScale)
      Supported only in Gantt charts: For vertical axes only. Setting the static scale ensures that each tick unit is translated into a fixed pixel height. For example, setting the static scale to 24 results in each Y axis category taking up 24 pixels, and the height of the chart adjusts. Adding or removing items will make the chart resize. Defaults to 50.
      Parameters:
      staticScale -