Packages

object XAxis

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. XAxis
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def apply(allowDecimals: UndefOr[Boolean] = js.undefined, alternateGridColor: UndefOr[|[String, Object]] = js.undefined, breaks: UndefOr[Array[CleanJsObject[XAxisBreaks]]] = js.undefined, categories: UndefOr[Array[String]] = js.undefined, ceiling: UndefOr[Double] = js.undefined, className: UndefOr[String] = js.undefined, crosshair: UndefOr[|[Boolean, CleanJsObject[XAxisCrosshair]]] = js.undefined, dateTimeLabelFormats: UndefOr[Object] = js.undefined, description: UndefOr[String] = js.undefined, endOnTick: UndefOr[Boolean] = js.undefined, events: UndefOr[CleanJsObject[XAxisEvents]] = js.undefined, floor: UndefOr[Double] = js.undefined, gridLineColor: UndefOr[|[String, Object]] = js.undefined, gridLineDashStyle: UndefOr[String] = js.undefined, gridLineWidth: UndefOr[Double] = js.undefined, gridZIndex: UndefOr[Double] = js.undefined, id: UndefOr[String] = js.undefined, labels: UndefOr[CleanJsObject[XAxisLabels]] = js.undefined, lineColor: UndefOr[|[String, Object]] = js.undefined, lineWidth: UndefOr[Double] = js.undefined, linkedTo: UndefOr[Double] = js.undefined, max: UndefOr[Double] = js.undefined, maxPadding: UndefOr[Double] = js.undefined, maxZoom: UndefOr[Double] = js.undefined, min: UndefOr[Double] = js.undefined, minPadding: UndefOr[Double] = js.undefined, minRange: UndefOr[Double] = js.undefined, minTickInterval: UndefOr[Double] = js.undefined, minorGridLineColor: UndefOr[|[String, Object]] = js.undefined, minorGridLineDashStyle: UndefOr[String] = js.undefined, minorGridLineWidth: UndefOr[Double] = js.undefined, minorTickColor: UndefOr[|[String, Object]] = js.undefined, minorTickInterval: UndefOr[|[String, Double]] = js.undefined, minorTickLength: UndefOr[Double] = js.undefined, minorTickPosition: UndefOr[String] = js.undefined, minorTickWidth: UndefOr[Double] = js.undefined, nameToX: UndefOr[Boolean] = js.undefined, offset: UndefOr[Double] = js.undefined, opposite: UndefOr[Boolean] = js.undefined, plotBands: UndefOr[Array[CleanJsObject[XAxisPlotBands]]] = js.undefined, plotLines: UndefOr[Array[CleanJsObject[XAxisPlotLines]]] = js.undefined, reversed: UndefOr[Boolean] = js.undefined, showEmpty: UndefOr[Boolean] = js.undefined, showFirstLabel: UndefOr[Boolean] = js.undefined, showLastLabel: UndefOr[Boolean] = js.undefined, softMax: UndefOr[Double] = js.undefined, softMin: UndefOr[Double] = js.undefined, startOfWeek: UndefOr[Double] = js.undefined, startOnTick: UndefOr[Boolean] = js.undefined, tickAmount: UndefOr[Double] = js.undefined, tickColor: UndefOr[|[String, Object]] = js.undefined, tickInterval: UndefOr[Double] = js.undefined, tickLength: UndefOr[Double] = js.undefined, tickPixelInterval: UndefOr[Double] = js.undefined, tickPosition: UndefOr[String] = js.undefined, tickPositioner: UndefOr[Function] = js.undefined, tickPositions: UndefOr[Array[Double]] = js.undefined, tickWidth: UndefOr[Double] = js.undefined, tickmarkPlacement: UndefOr[String] = js.undefined, title: UndefOr[CleanJsObject[XAxisTitle]] = js.undefined, type: UndefOr[String] = js.undefined, units: UndefOr[Array[Any]] = js.undefined, visible: UndefOr[Boolean] = js.undefined): XAxis

    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.

    alternateGridColor

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

    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.

    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']

    ceiling

    The highest allowed value for automatically computed axis extremes.

    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.

    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.

    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'. }

    description

    Requires Accessibility module. . Description of the axis to screen reader users.

    endOnTick

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

    events

    Event handlers for the axis.

    floor

    The lowest allowed value for automatically computed axis extremes.

    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.

    gridLineDashStyle

    The dash or dot style of the grid lines. For possible values, see this demonstration.

    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.

    gridZIndex

    The Z index of the grid lines.

    id

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

    labels

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

    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.

    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.

    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.

    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.. . If a tickAmount is set, the axis may be extended beyond the set max in order to reach the given number of ticks. The same may happen in a chart with multiple axes, determined by chart.alignTicks, where a tickAmount is applied internally.

    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.

    maxZoom

    Deprecated. Renamed to minRange as of Highcharts 2.2.

    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.

    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.

    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.

    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.

    minorGridLineColor

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

    minorGridLineDashStyle

    The dash or dot style of the minor grid lines. For possible values, see this demonstration.

    minorGridLineWidth

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

    minorTickColor

    Color for the minor tick marks.

    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.

    minorTickLength

    The pixel length of the minor tick marks.

    minorTickPosition

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

    minorTickWidth

    The pixel width of the minor tick mark.

    nameToX

    Applies only when the axis type is category. When nameToX 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 nameToX 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.

    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.

    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.

    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.

    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.

    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.

    showEmpty

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

    showFirstLabel

    Whether to show the first tick label.

    showLastLabel

    Whether to show the last tick label.

    softMax

    A soft maximum for the axis. If the series data maximum is greater 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.

    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.

    startOfWeek

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

    startOnTick

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

    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.

    tickColor

    Color for the main tick marks.. . In styled mode, the stroke is given in the .highcharts-tick class.

    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.

    tickLength

    The pixel length of the main tick marks.

    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.

    tickPosition

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

    tickPositioner

    A callback function returning array defining where the ticks are laid out on the axis. This overrides the default behaviour of tickPixelInterval and tickInterval. The automatic tick positions are accessible through this.tickPositions and can be modified by the callback.

    tickPositions

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

    tickWidth

    The pixel width of the major tick marks.. . In styled mode, the stroke width is given in the .highcharts-tick class.

    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.

    title

    The axis title, showing next to the axis line.

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

    visible

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

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped