Class YAxis
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
ColorAxis
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:
-
Field Summary
Fields inherited from class com.vaadin.flow.component.charts.model.Axis
max, min, MINOR_TICK_INTERVAL_AUTO
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addCategory
(String category) Adds category to the categories arrayvoid
addPlotBand
(PlotBand plotBand) Adds plotBand to the plotBands arrayvoid
addPlotLine
(PlotLine plotLine) Adds plotLine to the plotLines arrayvoid
Adds stop to the stops arrayvoid
addUnit
(TimeUnitMultiples unit) Adds unit to the units arraygetAngle()
Breaks[]
String[]
getFloor()
getGrid()
getId()
getPane()
PlotBand[]
PlotLine[]
getRange()
Stop[]
getStops()
Number[]
getTitle()
getTop()
getType()
getUnits()
void
removeCategory
(String category) Removes first occurrence of category in categories arrayvoid
removePlotBand
(PlotBand plotBand) Removes first occurrence of plotBand in plotBands arrayvoid
removePlotLine
(PlotLine plotLine) Removes first occurrence of plotLine in plotLines arrayvoid
removeStop
(Stop stop) Removes first occurrence of stop in stops arrayvoid
removeUnit
(TimeUnitMultiples unit) Removes first occurrence of unit in units arrayvoid
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.void
setAllowDecimals
(Boolean allowDecimals) Whether to allow decimals in this axis' ticks.void
setAlternateGridColor
(Color alternateGridColor) When using an alternate grid color, a band is painted across the plot area between every other grid line.void
In a polar chart, this is the angle of the Y axis in degrees, where 0 is up and 90 is right.void
An array defining breaks in the axis, the sections defined will be left out and all the points shifted closer to each other.void
setCategories
(String... categories) If categories are present for the xAxis, names are used instead of numbers for that axis.void
setCeiling
(Number ceiling) The highest allowed value for automatically computed axis extremes.void
setClassName
(String className) A class name that opens for styling the axis by CSS, especially in Highcharts styled mode.void
setCrosshair
(Crosshair crosshair) Configure a crosshair that follows either the mouse pointer or the hovered point.void
setDateTimeLabelFormats
(DateTimeLabelFormats dateTimeLabelFormats) For a datetime axis, the scale will automatically adjust to the appropriate unit.void
setDescription
(String description) Requires Accessibility modulevoid
setEndOnTick
(Boolean endOnTick) Whether to force the axis to end on a tick.void
The lowest allowed value for automatically computed axis extremes.void
Set grid options for the axis labels.void
setGridLineColor
(Color gridLineColor) Color of the grid lines extending the ticks across the plot area.void
setGridLineDashStyle
(DashStyle gridLineDashStyle) The dash or dot style of the grid lines.void
setGridLineInterpolation
(String gridLineInterpolation) Polar charts only.void
setGridLineWidth
(Number gridLineWidth) The width of the grid lines extending the ticks across the plot area.void
setGridZIndex
(Number gridZIndex) The Z index of the grid lines.void
The height of the Y axis.void
An id for the axis.void
The axis labels show the number or category for each tick.void
setLineColor
(Color lineColor) The color of the line marking the axis itself.void
setLineWidth
(Number lineWidth) The width of the line marking the axis itself.void
setLinkedTo
(YAxis axis) void
setLinkedTo
(Number linkedTo) Index of another axis that this axis is linked to.void
If there are multiple axes on the same side of the chart, the pixel margin between the axes.void
setMaxColor
(Color maxColor) Solid gauge only.void
setMaxPadding
(Number maxPadding) Padding of the max value relative to the length of the axis.void
setMaxRange
(Number maxRange) Maximum range which can be set using the navigator's handles.void
setMinColor
(Color minColor) Solid gauge only.void
setMinorGridLineColor
(Color minorGridLineColor) Color of the minor, secondary grid lines.void
setMinorGridLineDashStyle
(DashStyle minorGridLineDashStyle) The dash or dot style of the minor grid lines.void
setMinorGridLineWidth
(Number minorGridLineWidth) Width of the minor, secondary grid lines.void
setMinorTickColor
(Color minorTickColor) Color for the minor tick marks.void
setMinorTickInterval
(String minorTickInterval) Tick interval in scale units for the minor ticks.void
setMinorTickLength
(Number minorTickLength) The pixel length of the minor tick marks.void
setMinorTickPosition
(TickPosition minorTickPosition) The position of the minor tick marks relative to the axis line.void
setMinorTicks
(Boolean minorTicks) Enable or disable minor ticks.void
setMinorTickWidth
(Number minorTickWidth) The pixel width of the minor tick mark.void
setMinPadding
(Number minPadding) Padding of the min value relative to the length of the axis.void
setMinRange
(Number minRange) The minimum range to display on this axis.void
setMinTickInterval
(Number minTickInterval) The minimum tick interval allowed in axis values.void
The distance in pixels from the plot area to the axis line.void
setOpposite
(Boolean opposite) Whether to display the axis on the opposite side of the normal.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.void
void
void
setPlotBands
(PlotBand... plotBands) An array of objects defining plot bands on the Y axis.void
setPlotLines
(PlotLine... plotLines) An array of objects representing plot lines on the X axisvoid
The zoomed range to display when only defining one or none ofmin
ormax
.void
setReversed
(Boolean reversed) Whether to reverse the axis so that the highest number is closest to the origin.void
setReversedStacks
(Boolean reversedStacks) Iftrue
, the first series in a stack will be drawn on top in a positive, non-reversed Y axis.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.void
setShowEmpty
(Boolean showEmpty) Whether to show the axis line and title when the axis has no data.void
setShowFirstLabel
(Boolean showFirstLabel) Whether to show the first tick label.void
setShowLastLabel
(Boolean showLastLabel) Whether to show the last tick label.void
setSoftMax
(Number softMax) A soft maximum for the axis.void
setSoftMin
(Number softMin) A soft minimum for the axis.void
setStackLabels
(StackLabels stackLabels) The stack labels show the total value for each bar in a stacked column or bar chart.void
setStartOfWeek
(Number startOfWeek) For datetime axes, this decides where to put the tick between weeks.void
setStartOnTick
(Boolean startOnTick) Whether to force the axis to start on a tick.void
setStaticScale
(Number staticScale) Supported only in Gantt charts: For vertical axes only.void
void
setTickAmount
(Number tickAmount) The amount of ticks to draw on the axis.void
setTickColor
(Color tickColor) Color for the main tick marks.void
setTickInterval
(Number tickInterval) The interval of the tick marks in axis units.void
setTickLength
(Number tickLength) The pixel length of the main tick marks.void
setTickmarkPlacement
(TickmarkPlacement tickmarkPlacement) For categorized axes only.void
setTickPixelInterval
(Number tickPixelInterval) If tickInterval isnull
this option sets the approximate pixel interval of the tick marks.void
setTickPosition
(TickPosition tickPosition) The position of the major tick marks relative to the axis line.void
setTickPositions
(Number[] tickPositions) An array defining where the ticks are laid out on the axis.void
setTickWidth
(Number tickWidth) The pixel width of the major tick marks.void
The axis title, showing next to the axis line.void
void
The top position of the Y axis.void
The type of axis.void
setUniqueNames
(Boolean uniqueNames) Applies only when the axistype
iscategory
.void
setUnits
(TimeUnitMultiples... units) Datetime axis only.void
setVisible
(Boolean visible) Whether axis, including axis title, line, ticks and labels, should be visible.Methods inherited from class com.vaadin.flow.component.charts.model.Axis
getAxisIndex, getConfiguration, getMax, getMin, setAxisIndex, setConfiguration, setExtremes, setExtremes, setExtremes, setExtremes, setExtremes, setExtremes, setMax, setMax, setMax, setMin, setMin, setMin
-
Constructor Details
-
YAxis
public YAxis()
-
-
Method Details
-
getAllowDecimals
- Specified by:
getAllowDecimals
in classAxis
- See Also:
-
setAllowDecimals
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 classAxis
-
getAlternateGridColor
- Specified by:
getAlternateGridColor
in classAxis
- See Also:
-
setAlternateGridColor
When using an alternate grid color, a band is painted across the plot area between every other grid line.- Specified by:
setAlternateGridColor
in classAxis
-
getAngle
- See Also:
-
setAngle
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
- See Also:
-
setBreaks
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
- Specified by:
getCategories
in classAxis
- See Also:
-
setCategories
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 thecategories
array.Example:
categories: ['Apples', 'Bananas', 'Oranges']
Defaults tonull
- Specified by:
setCategories
in classAxis
-
addCategory
Adds category to the categories array- Specified by:
addCategory
in classAxis
- Parameters:
category
- to add- See Also:
-
removeCategory
Removes first occurrence of category in categories array- Specified by:
removeCategory
in classAxis
- Parameters:
category
- to remove- See Also:
-
getCeiling
- Specified by:
getCeiling
in classAxis
- See Also:
-
setCeiling
The highest allowed value for automatically computed axis extremes.- Specified by:
setCeiling
in classAxis
-
getClassName
- Specified by:
getClassName
in classAxis
- See Also:
-
setClassName
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 classAxis
-
getCrosshair
- Specified by:
getCrosshair
in classAxis
- See Also:
-
setCrosshair
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 classAxis
-
getDateTimeLabelFormats
- Specified by:
getDateTimeLabelFormats
in classAxis
- See Also:
-
setDateTimeLabelFormats
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 theday
unit can be used on midnight andhour
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 classAxis
-
getDescription
- Specified by:
getDescription
in classAxis
- See Also:
-
setDescription
Requires Accessibility module
Description of the axis to screen reader users.
Defaults to: undefined
- Specified by:
setDescription
in classAxis
-
getEndOnTick
- Specified by:
getEndOnTick
in classAxis
- See Also:
-
setEndOnTick
Whether to force the axis to end on a tick. Use this option with themaxPadding
option to control the axis end.Defaults to: true
- Specified by:
setEndOnTick
in classAxis
-
getFloor
-
setFloor
The lowest allowed value for automatically computed axis extremes.Defaults to: null
-
getGridLineColor
- See Also:
-
setGridLineColor
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
- See Also:
-
setGridLineDashStyle
The dash or dot style of the grid lines. For possible values, see this demonstration.Defaults to: Solid
-
getGridLineInterpolation
- See Also:
-
setGridLineInterpolation
Polar charts only. Whether the grid lines should draw as a polygon with straight lines between categories, or as circles. Can be eithercircle
orpolygon
.Defaults to: null
-
getGridLineWidth
- See Also:
-
setGridLineWidth
The width of the grid lines extending the ticks across the plot area.Defaults to: 1
-
getGridZIndex
- Specified by:
getGridZIndex
in classAxis
- See Also:
-
setGridZIndex
The Z index of the grid lines.Defaults to: 1
- Specified by:
setGridZIndex
in classAxis
-
getId
-
setId
An id for the axis. This can be used after render time to get a pointer to the axis object throughchart.get()
. -
getLabels
-
setLabels
Description copied from class:Axis
The axis labels show the number or category for each tick. -
getLineColor
- Specified by:
getLineColor
in classAxis
- See Also:
-
setLineColor
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 classAxis
-
getLineWidth
- Specified by:
getLineWidth
in classAxis
- See Also:
-
setLineWidth
The width of the line marking the axis itself.Defaults to: 0
- Specified by:
setLineWidth
in classAxis
-
getLinkedTo
- Specified by:
getLinkedTo
in classAxis
- See Also:
-
setLinkedTo
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 classAxis
-
getMaxColor
- See Also:
-
setMaxColor
Solid gauge only. Unless stops are set, the color to represent the maximum value of the Y axis.Defaults to: #003399
-
getMaxPadding
- Specified by:
getMaxPadding
in classAxis
- See Also:
-
setMaxPadding
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 classAxis
-
getMinColor
- See Also:
-
setMinColor
Solid gauge only. Unless stops are set, the color to represent the minimum value of the Y axis.Defaults to: #e6ebf5
-
getMinPadding
- Specified by:
getMinPadding
in classAxis
- See Also:
-
setMinPadding
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 classAxis
-
getMinRange
- Specified by:
getMinRange
in classAxis
- See Also:
-
setMinRange
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
andendOnTick
settings also affect how the extremes of the axis are computed.- Specified by:
setMinRange
in classAxis
-
getMinTickInterval
- Specified by:
getMinTickInterval
in classAxis
- See Also:
-
setMinTickInterval
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 classAxis
-
getMinorGridLineColor
- See Also:
-
setMinorGridLineColor
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
- See Also:
-
setMinorGridLineDashStyle
The dash or dot style of the minor grid lines. For possible values, see this demonstration.Defaults to: Solid
-
getMinorGridLineWidth
- See Also:
-
setMinorGridLineWidth
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
- See Also:
-
setMinorTickColor
Color for the minor tick marks.Defaults to: #999999
-
getMinorTickInterval
- Specified by:
getMinorTickInterval
in classAxis
- See Also:
-
setMinorTickInterval
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. Ifnull
, 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 classAxis
-
getMinorTickLength
- Specified by:
getMinorTickLength
in classAxis
- See Also:
-
setMinorTickLength
The pixel length of the minor tick marks.Defaults to: 2
- Specified by:
setMinorTickLength
in classAxis
-
getMinorTickPosition
- Specified by:
getMinorTickPosition
in classAxis
- See Also:
-
setMinorTickPosition
The position of the minor tick marks relative to the axis line. Can be one ofinside
andoutside
.Defaults to: outside
- Specified by:
setMinorTickPosition
in classAxis
-
getMinorTickWidth
- See Also:
-
setMinorTickWidth
The pixel width of the minor tick mark.Defaults to: 0
-
getOffset
-
setOffset
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
-
getOpposite
- Specified by:
getOpposite
in classAxis
- See Also:
-
setOpposite
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 classAxis
-
getPlotBands
- Specified by:
getPlotBands
in classAxis
- See Also:
-
setPlotBands
An array of objects defining plot bands on the Y axis.- Specified by:
setPlotBands
in classAxis
-
addPlotBand
Adds plotBand to the plotBands array- Specified by:
addPlotBand
in classAxis
- Parameters:
plotBand
- to add- See Also:
-
removePlotBand
Removes first occurrence of plotBand in plotBands array- Specified by:
removePlotBand
in classAxis
- Parameters:
plotBand
- to remove- See Also:
-
getPlotLines
- Specified by:
getPlotLines
in classAxis
- See Also:
-
setPlotLines
An array of objects representing plot lines on the X axis- Specified by:
setPlotLines
in classAxis
-
addPlotLine
Adds plotLine to the plotLines array- Specified by:
addPlotLine
in classAxis
- Parameters:
plotLine
- to add- See Also:
-
removePlotLine
Removes first occurrence of plotLine in plotLines array- Specified by:
removePlotLine
in classAxis
- Parameters:
plotLine
- to remove- See Also:
-
getReversed
- Specified by:
getReversed
in classAxis
- See Also:
-
setReversed
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 classAxis
-
getReversedStacks
- See Also:
-
setReversedStacks
Iftrue
, the first series in a stack will be drawn on top in a positive, non-reversed Y axis. Iffalse
, the first series is in the base of the stack.Defaults to: true
-
getShowEmpty
- Specified by:
getShowEmpty
in classAxis
- See Also:
-
setShowEmpty
Whether to show the axis line and title when the axis has no data.Defaults to: true
- Specified by:
setShowEmpty
in classAxis
-
getShowFirstLabel
- Specified by:
getShowFirstLabel
in classAxis
- See Also:
-
setShowFirstLabel
Whether to show the first tick label.Defaults to: true
- Specified by:
setShowFirstLabel
in classAxis
-
getShowLastLabel
- Specified by:
getShowLastLabel
in classAxis
- See Also:
-
setShowLastLabel
Whether to show the last tick label. Defaults totrue
on cartesian charts, andfalse
on polar charts.- Specified by:
setShowLastLabel
in classAxis
-
getSoftMax
- Specified by:
getSoftMax
in classAxis
- See Also:
-
setSoftMax
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 classAxis
-
getSoftMin
- Specified by:
getSoftMin
in classAxis
- See Also:
-
setSoftMin
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 classAxis
-
getStackLabels
- See Also:
-
setStackLabels
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
- Specified by:
getStartOfWeek
in classAxis
- See Also:
-
setStartOfWeek
For datetime axes, this decides where to put the tick between weeks. 0 = Sunday, 1 = Monday.Defaults to: 1
- Specified by:
setStartOfWeek
in classAxis
-
getStartOnTick
- Specified by:
getStartOnTick
in classAxis
- See Also:
-
setStartOnTick
Whether to force the axis to start on a tick. Use this option with themaxPadding
option to control the axis start.Defaults to: true
- Specified by:
setStartOnTick
in classAxis
-
getTickAmount
- Specified by:
getTickAmount
in classAxis
- See Also:
-
setTickAmount
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 classAxis
-
getTickColor
- Specified by:
getTickColor
in classAxis
- See Also:
-
setTickColor
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 classAxis
-
getTickInterval
- Specified by:
getTickInterval
in classAxis
- See Also:
-
setTickInterval
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, anull
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 as24 * 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 classAxis
-
getTickLength
- Specified by:
getTickLength
in classAxis
- See Also:
-
setTickLength
The pixel length of the main tick marks.Defaults to: 10
- Specified by:
setTickLength
in classAxis
-
getTickPixelInterval
- Specified by:
getTickPixelInterval
in classAxis
- See Also:
-
setTickPixelInterval
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 and100
for the X axis.- Specified by:
setTickPixelInterval
in classAxis
-
getTickPosition
- Specified by:
getTickPosition
in classAxis
- See Also:
-
setTickPosition
The position of the major tick marks relative to the axis line. Can be one ofinside
andoutside
.Defaults to: outside
- Specified by:
setTickPosition
in classAxis
-
getTickPositions
- Specified by:
getTickPositions
in classAxis
- See Also:
-
setTickPositions
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 classAxis
-
getTickWidth
- See Also:
-
setTickWidth
The pixel width of the major tick marks.Defaults to: 0
-
getTickmarkPlacement
- Specified by:
getTickmarkPlacement
in classAxis
- See Also:
-
setTickmarkPlacement
For categorized axes only. Ifon
the tick mark is placed in the center of the category, ifbetween
the tick mark is placed between categories. The default isbetween
if thetickInterval
is 1, elseon
.Defaults to: null
- Specified by:
setTickmarkPlacement
in classAxis
-
getTitle
-
setTitle
Description copied from class:Axis
The axis title, showing next to the axis line. -
getType
-
setType
The type of axis. Can be one oflinear
,logarithmic
,datetime
orcategory
. 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
-
getUniqueNames
- Specified by:
getUniqueNames
in classAxis
- See Also:
-
setUniqueNames
Applies only when the axistype
iscategory
. WhenuniqueNames
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. WhenuniqueNames
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 classAxis
-
getUnits
-
setUnits
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 ]]
-
addUnit
Adds unit to the units array -
removeUnit
Removes first occurrence of unit in units array- Specified by:
removeUnit
in classAxis
- Parameters:
unit
- to remove- See Also:
-
getVisible
- Specified by:
getVisible
in classAxis
- See Also:
-
setVisible
Whether axis, including axis title, line, ticks and labels, should be visible.Defaults to: true
- Specified by:
setVisible
in classAxis
-
getHeight
- See Also:
-
setHeight
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
- See Also:
-
setOrdinal
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
- See Also:
-
setRange
The zoomed range to display when only defining one or none ofmin
ormax
. For example, to show the latest month, a range of one month can be set.Defaults to: undefined
-
getScrollbar
- See Also:
-
setScrollbar
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
- See Also:
-
setTop
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
-
setPane
-
setPane
-
setTitle
-
setLinkedTo
-
getStops
- See Also:
-
setStops
-
addStop
Adds stop to the stops array- Parameters:
stop
- to add- See Also:
-
removeStop
Removes first occurrence of stop in stops array- Parameters:
stop
- to remove- See Also:
-
getGrid
- See Also:
-
setGrid
Set grid options for the axis labels. Relevant only for Highcharts Gantt. -
getAlignTicks
- See Also:
-
setAlignTicks
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
- See Also:
-
setMargin
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
- See Also:
-
setMaxRange
Maximum range which can be set using the navigator's handles. Opposite ofsetMinRange(Number)
- Parameters:
maxRange
-
-
getMinorTicks
- See Also:
-
setMinorTicks
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
- See Also:
-
setStaticScale
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
-
-