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

Class XAxis

  • All Implemented Interfaces:
    Serializable
    public class XAxis
extends Axis

    The X axis or category axis. Normally this is the horizontal axis, though if the chart is inverted this is the vertical axis. In case of multiple axes, the xAxis node is an array of configuration objects.

    See the Axis object for programmatic access to the axis.

    See Also:
    Serialized Form

    • Constructor Detail

      • XAxis

        public XAxis()

    • Method Detail

      • 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

      • 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

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

      • 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

      • setCeiling

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

      • 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

      • 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

      • 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

      • 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

      • 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: false

        Specified by:
        setEndOnTick in class Axis

      • setFloor

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

        Defaults to: null

        Specified by:
        setFloor in class Axis

      • 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

      • setGridLineDashStyle

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

        Defaults to: Solid

      • setGridLineWidth

        public void setGridLineWidth​(Number gridLineWidth)

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

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

        Defaults to: 0

      • setGridZIndex

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

        Defaults to: 1

        Specified by:
        setGridZIndex in class Axis

      • 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

      • setLabels

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

      • 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

      • setLineWidth

        public void setLineWidth​(Number lineWidth)

        The width of the line marking the axis itself.

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

        Defaults to: 1

        Specified by:
        setLineWidth in class Axis

      • 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

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

        Specified by:
        setMaxPadding in class Axis

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

        Specified by:
        setMinPadding in class Axis

      • 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

      • 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

      • 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

      • 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

      • 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

      • setMinorTickColor

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

        Defaults to: #999999

      • 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

      • setMinorTickLength

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

        Defaults to: 2

        Specified by:
        setMinorTickLength in class Axis

      • 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

      • setMinorTickWidth

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

        Defaults to: 0

      • 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

      • 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

      • setPlotBands

        public void setPlotBands​(PlotBand... plotBands)

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

        In a gauge, a plot band on the Y axis (value axis) will stretch along the perimeter of the gauge.

        In styled mode, the plot bands are styled by the .highcharts-plot-band class in addition to the className option.

        Specified by:
        setPlotBands in class Axis

      • setPlotLines

        public void setPlotLines​(PlotLine... plotLines)

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

        In styled mode, the plot lines are styled by the .highcharts-plot-line class in addition to the className option.

        Specified by:
        setPlotLines in class Axis

      • 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

      • 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

      • setShowFirstLabel

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

        Defaults to: true

        Specified by:
        setShowFirstLabel in class Axis

      • setShowLastLabel

        public void setShowLastLabel​(Boolean showLastLabel)
        Whether to show the last tick label.

        Defaults to: true

        Specified by:
        setShowLastLabel in class Axis

      • 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

      • 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

      • 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

      • setStartOnTick

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

        Defaults to: false

        Specified by:
        setStartOnTick in class Axis

      • 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

      • 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

      • 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

      • setTickLength

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

        Defaults to: 10

        Specified by:
        setTickLength in class Axis

      • 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

      • 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

      • setTickWidth

        public void setTickWidth​(Number tickWidth)

        The pixel width of the major tick marks.

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

        Defaults to: 1

      • 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

      • setTitle

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

      • 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

      • 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

      • 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

      • 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

      • 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

      • 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

      • 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​(XAxis axis)