public interface XAxisOptions extends Any
Modifier and Type | Interface and Description |
---|---|
static class |
XAxisOptions.GridLineDashStyle |
static class |
XAxisOptions.MinorGridLineDashStyle |
static class |
XAxisOptions.MinorTickPosition |
static class |
XAxisOptions.TickmarkPlacement |
static class |
XAxisOptions.TickPosition |
static interface |
XAxisOptions.TickPositioner |
static class |
XAxisOptions.Type |
Modifier and Type | Method and Description |
---|---|
boolean |
getAlignTicks()
(Highcharts, Highstock, Gantt) 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. |
boolean |
getAllowDecimals()
(Highcharts, Highstock, Highmaps) Whether to allow decimals in this axis'
ticks.
|
String |
getAlternateGridColor()
(Highcharts, Highstock, Highmaps) When using an alternate grid color, a
band is painted across the plot area between every other grid line.
|
Array<XAxisBreaksOptions> |
getBreaks()
(Highcharts, Highstock, Gantt) An array defining breaks in the axis, the
sections defined will be left out and all the points shifted closer to
each other.
|
String[] |
getCategories()
(Highcharts, Gantt) If categories are present for the xAxis, names are
used instead of numbers for that axis.
|
double |
getCeiling()
(Highcharts, Highstock, Gantt) The highest allowed value for
automatically computed axis extremes.
|
String |
getClassName()
(Highcharts, Highstock, Highmaps) A class name that opens for styling the
axis by CSS, especially in Highcharts styled mode.
|
Unknown |
getCrosshair()
(Highcharts, Highstock, Highmaps) Configure a crosshair that follows
either the mouse pointer or the hovered point.
|
Unknown |
getCurrentDateIndicator()
(Gantt) Show an indicator on the axis for the current date and time.
|
XAxisDateTimeLabelFormatsOptions |
getDateTimeLabelFormats()
(Highcharts, Highstock, Gantt) For a datetime axis, the scale will
automatically adjust to the appropriate unit.
|
String |
getDescription()
(Highcharts, Highstock, Highmaps) Requires Accessibility module
Description of the axis to screen reader users.
|
boolean |
getEndOnTick()
(Highcharts, Highstock, Highmaps) Whether to force the axis to end on a
tick.
|
XAxisEventsOptions |
getEvents()
(Highcharts, Highstock, Highmaps) Event handlers for the axis.
|
double |
getFloor()
(Highcharts, Highstock, Gantt) The lowest allowed value for automatically
computed axis extremes.
|
XAxisGridOptions |
getGrid()
(Gantt) Set grid options for the axis labels.
|
String |
getGridLineColor()
(Highcharts, Highstock, Highmaps) Color of the grid lines extending the
ticks across the plot area.
|
XAxisOptions.GridLineDashStyle |
getGridLineDashStyle()
(Highcharts, Highstock, Highmaps) The dash or dot style of the grid
lines.
|
double |
getGridLineWidth()
(Highcharts, Highstock, Highmaps) The width of the grid lines extending
the ticks across the plot area.
|
double |
getGridZIndex()
(Highcharts, Highstock, Gantt) The Z index of the grid lines.
|
String |
getId()
(Highcharts, Highstock, Highmaps) An id for the axis.
|
XAxisLabelsOptions |
getLabels()
(Highcharts, Highstock, Highmaps) The axis labels show the number or
category for each tick.
|
String |
getLineColor()
(Highcharts, Highstock, Highmaps) The color of the line marking the axis
itself.
|
double |
getLineWidth()
(Highcharts, Highstock, Highmaps) The width of the line marking the axis
itself.
|
double |
getLinkedTo()
(Highcharts, Highstock, Gantt) Index of another axis that this axis is
linked to.
|
double |
getMax()
(Highcharts, Highstock, Highmaps) The maximum value of the axis.
|
double |
getMaxPadding()
(Highcharts, Highstock, Highmaps) Padding of the max value relative to
the length of the axis.
|
double |
getMaxRange()
(Highstock) Maximum range which can be set using the navigator's handles.
|
double |
getMaxZoom()
(Highcharts, Highstock) Deprecated.
|
double |
getMin()
(Highcharts, Highstock, Highmaps) The minimum value of the axis.
|
String |
getMinorGridLineColor()
(Highcharts, Highstock, Highmaps) Color of the minor, secondary grid
lines.
|
XAxisOptions.MinorGridLineDashStyle |
getMinorGridLineDashStyle()
(Highcharts, Highstock, Highmaps) The dash or dot style of the minor grid
lines.
|
double |
getMinorGridLineWidth()
(Highcharts, Highstock, Highmaps) Width of the minor, secondary grid
lines.
|
String |
getMinorTickColor()
(Highcharts, Highstock, Highmaps) Color for the minor tick marks.
|
Unknown |
getMinorTickInterval()
(Highcharts, Highstock, Highmaps) Specific tick interval in axis units
for the minor ticks.
|
double |
getMinorTickLength()
(Highcharts, Highstock, Highmaps) The pixel length of the minor tick
marks.
|
XAxisOptions.MinorTickPosition |
getMinorTickPosition()
(Highcharts, Highstock, Highmaps) The position of the minor tick marks
relative to the axis line.
|
boolean |
getMinorTicks()
(Highcharts, Highstock, Highmaps) Enable or disable minor ticks.
|
double |
getMinorTickWidth()
(Highcharts, Highstock, Highmaps) The pixel width of the minor tick mark.
|
double |
getMinPadding()
(Highcharts, Highstock, Gantt) Padding of the min value relative to the
length of the axis.
|
double |
getMinRange()
(Highcharts, Highstock, Highmaps) The minimum range to display on this
axis.
|
double |
getMinTickInterval()
(Highcharts, Highstock, Highmaps) The minimum tick interval allowed in
axis values.
|
double |
getOffset()
(Highcharts, Highstock, Highmaps) The distance in pixels from the plot
area to the axis line.
|
boolean |
getOpposite()
(Highcharts, Highstock, Highmaps) Whether to display the axis on the
opposite side of the normal.
|
boolean |
getOrdinal()
(Highstock) In an ordinal axis, the points are equally spaced in the
chart regardless of the actual time or x distance between them.
|
double |
getOverscroll()
(Highstock) Additional range on the right side of the xAxis.
|
double |
getPane()
(Highcharts) Refers to the index in the panes array.
|
Array<XAxisPlotBandsOptions> |
getPlotBands()
(Highcharts, Highstock, Gantt) An array of colored bands stretching
across the plot area marking an interval on the axis.
|
Array<XAxisPlotLinesOptions> |
getPlotLines()
(Highcharts, Highstock, Gantt) An array of lines stretching across the
plot area, marking a specific value on one of the axes.
|
double |
getRange()
(Highstock) The zoomed range to display when only defining one or none of
min or max . |
boolean |
getReversed()
(Highcharts, Highstock, Highmaps) Whether to reverse the axis so that the
highest number is closest to the origin.
|
boolean |
getReversedStacks()
(Highcharts, Highstock) This option determines how stacks should be
ordered within a group.
|
XAxisScrollbarOptions |
getScrollbar()
(Highstock) An optional scrollbar to display on the X axis in response to
limiting the minimum and maximum of the axis values.
|
boolean |
getShowEmpty()
(Highcharts, Highstock, Highmaps) Whether to show the axis line and title
when the axis has no data.
|
boolean |
getShowFirstLabel()
(Highcharts, Highstock, Highmaps) Whether to show the first tick label.
|
boolean |
getShowLastLabel()
(Highcharts, Highstock, Gantt) Whether to show the last tick label.
|
double |
getSoftMax()
(Highcharts, Highstock, Gantt) A soft maximum for the axis.
|
double |
getSoftMin()
(Highcharts, Highstock, Gantt) A soft minimum for the axis.
|
double |
getStartOfWeek()
(Highcharts, Highstock, Gantt) For datetime axes, this decides where to
put the tick between weeks.
|
boolean |
getStartOnTick()
(Highcharts, Highstock, Highmaps) Whether to force the axis to start on a
tick.
|
double |
getTickAmount()
(Highcharts, Highstock, Gantt) The amount of ticks to draw on the axis.
|
String |
getTickColor()
(Highcharts, Highstock, Highmaps) Color for the main tick marks.
|
double |
getTickInterval()
(Highcharts, Highstock, Highmaps) The interval of the tick marks in axis
units.
|
double |
getTickLength()
(Highcharts, Highstock, Highmaps) The pixel length of the main tick
marks.
|
XAxisOptions.TickmarkPlacement |
getTickmarkPlacement()
(Highcharts, Gantt) For categorized axes only.
|
double |
getTickPixelInterval()
(Highcharts, Highstock, Highmaps) If tickInterval is
null this option
sets the approximate pixel interval of the tick marks. |
XAxisOptions.TickPosition |
getTickPosition()
(Highcharts, Highstock, Highmaps) The position of the major tick marks
relative to the axis line.
|
XAxisOptions.TickPositioner |
getTickPositioner()
(Highcharts, Highstock, Highmaps) A callback function returning array
defining where the ticks are laid out on the axis.
|
double[] |
getTickPositions()
(Highcharts, Highstock, Highmaps) An array defining where the ticks are
laid out on the axis.
|
double |
getTickWidth()
(Highcharts, Highstock, Highmaps) The pixel width of the major tick
marks.
|
XAxisTitleOptions |
getTitle()
(Highcharts, Highstock, Highmaps) The axis title, showing next to the
axis line.
|
XAxisOptions.Type |
getType()
(Highcharts, Gantt) The type of axis.
|
boolean |
getUniqueNames()
(Highcharts, Gantt) Applies only when the axis
type is category . |
Array<Array<Unknown>> |
getUnits()
(Highcharts, Highstock, Gantt) Datetime axis only.
|
boolean |
getVisible()
(Highcharts, Highstock, Gantt) Whether axis, including axis title, line,
ticks and labels, should be visible.
|
void |
setAlignTicks(boolean value)
(Highcharts, Highstock, Gantt) 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 value)
(Highcharts, Highstock, Highmaps) Whether to allow decimals in this axis'
ticks.
|
void |
setAlternateGridColor(String value)
(Highcharts, Highstock, Highmaps) When using an alternate grid color, a
band is painted across the plot area between every other grid line.
|
void |
setBreaks(Array<XAxisBreaksOptions> value)
(Highcharts, Highstock, Gantt) 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[] value)
(Highcharts, Gantt) If categories are present for the xAxis, names are
used instead of numbers for that axis.
|
void |
setCeiling(double value)
(Highcharts, Highstock, Gantt) The highest allowed value for
automatically computed axis extremes.
|
void |
setClassName(String value)
(Highcharts, Highstock, Highmaps) A class name that opens for styling the
axis by CSS, especially in Highcharts styled mode.
|
void |
setCrosshair(boolean value)
(Highcharts, Highstock, Highmaps) Configure a crosshair that follows
either the mouse pointer or the hovered point.
|
void |
setCrosshair(XAxisCrosshairOptions value)
(Highcharts, Highstock, Highmaps) Configure a crosshair that follows
either the mouse pointer or the hovered point.
|
void |
setCurrentDateIndicator(boolean value)
(Gantt) Show an indicator on the axis for the current date and time.
|
void |
setCurrentDateIndicator(XAxisCurrentDateIndicatorOptions value)
(Gantt) Show an indicator on the axis for the current date and time.
|
void |
setDateTimeLabelFormats(XAxisDateTimeLabelFormatsOptions value)
(Highcharts, Highstock, Gantt) For a datetime axis, the scale will
automatically adjust to the appropriate unit.
|
void |
setDescription(String value)
(Highcharts, Highstock, Highmaps) Requires Accessibility module
Description of the axis to screen reader users.
|
void |
setEndOnTick(boolean value)
(Highcharts, Highstock, Highmaps) Whether to force the axis to end on a
tick.
|
void |
setEvents(XAxisEventsOptions value)
(Highcharts, Highstock, Highmaps) Event handlers for the axis.
|
void |
setFloor(double value)
(Highcharts, Highstock, Gantt) The lowest allowed value for automatically
computed axis extremes.
|
void |
setGrid(XAxisGridOptions value)
(Gantt) Set grid options for the axis labels.
|
void |
setGridLineColor(String value)
(Highcharts, Highstock, Highmaps) Color of the grid lines extending the
ticks across the plot area.
|
void |
setGridLineDashStyle(XAxisOptions.GridLineDashStyle value)
(Highcharts, Highstock, Highmaps) The dash or dot style of the grid
lines.
|
void |
setGridLineWidth(double value)
(Highcharts, Highstock, Highmaps) The width of the grid lines extending
the ticks across the plot area.
|
void |
setGridZIndex(double value)
(Highcharts, Highstock, Gantt) The Z index of the grid lines.
|
void |
setId(String value)
(Highcharts, Highstock, Highmaps) An id for the axis.
|
void |
setLabels(XAxisLabelsOptions value)
(Highcharts, Highstock, Highmaps) The axis labels show the number or
category for each tick.
|
void |
setLineColor(String value)
(Highcharts, Highstock, Highmaps) The color of the line marking the axis
itself.
|
void |
setLineWidth(double value)
(Highcharts, Highstock, Highmaps) The width of the line marking the axis
itself.
|
void |
setLinkedTo(double value)
(Highcharts, Highstock, Gantt) Index of another axis that this axis is
linked to.
|
void |
setMax(double value)
(Highcharts, Highstock, Highmaps) The maximum value of the axis.
|
void |
setMaxPadding(double value)
(Highcharts, Highstock, Highmaps) Padding of the max value relative to
the length of the axis.
|
void |
setMaxRange(double value)
(Highstock) Maximum range which can be set using the navigator's handles.
|
void |
setMaxZoom(double value)
(Highcharts, Highstock) Deprecated.
|
void |
setMin(double value)
(Highcharts, Highstock, Highmaps) The minimum value of the axis.
|
void |
setMinorGridLineColor(String value)
(Highcharts, Highstock, Highmaps) Color of the minor, secondary grid
lines.
|
void |
setMinorGridLineDashStyle(XAxisOptions.MinorGridLineDashStyle value)
(Highcharts, Highstock, Highmaps) The dash or dot style of the minor grid
lines.
|
void |
setMinorGridLineWidth(double value)
(Highcharts, Highstock, Highmaps) Width of the minor, secondary grid
lines.
|
void |
setMinorTickColor(String value)
(Highcharts, Highstock, Highmaps) Color for the minor tick marks.
|
void |
setMinorTickInterval(double value)
(Highcharts, Highstock, Highmaps) Specific tick interval in axis units
for the minor ticks.
|
void |
setMinorTickInterval(String value)
(Highcharts, Highstock, Highmaps) Specific tick interval in axis units
for the minor ticks.
|
void |
setMinorTickLength(double value)
(Highcharts, Highstock, Highmaps) The pixel length of the minor tick
marks.
|
void |
setMinorTickPosition(XAxisOptions.MinorTickPosition value)
(Highcharts, Highstock, Highmaps) The position of the minor tick marks
relative to the axis line.
|
void |
setMinorTicks(boolean value)
(Highcharts, Highstock, Highmaps) Enable or disable minor ticks.
|
void |
setMinorTickWidth(double value)
(Highcharts, Highstock, Highmaps) The pixel width of the minor tick mark.
|
void |
setMinPadding(double value)
(Highcharts, Highstock, Gantt) Padding of the min value relative to the
length of the axis.
|
void |
setMinRange(double value)
(Highcharts, Highstock, Highmaps) The minimum range to display on this
axis.
|
void |
setMinTickInterval(double value)
(Highcharts, Highstock, Highmaps) The minimum tick interval allowed in
axis values.
|
void |
setOffset(double value)
(Highcharts, Highstock, Highmaps) The distance in pixels from the plot
area to the axis line.
|
void |
setOpposite(boolean value)
(Highcharts, Highstock, Highmaps) Whether to display the axis on the
opposite side of the normal.
|
void |
setOrdinal(boolean value)
(Highstock) In an ordinal axis, the points are equally spaced in the
chart regardless of the actual time or x distance between them.
|
void |
setOverscroll(double value)
(Highstock) Additional range on the right side of the xAxis.
|
void |
setPane(double value)
(Highcharts) Refers to the index in the panes array.
|
void |
setPlotBands(Array<XAxisPlotBandsOptions> value)
(Highcharts, Highstock, Gantt) An array of colored bands stretching
across the plot area marking an interval on the axis.
|
void |
setPlotLines(Array<XAxisPlotLinesOptions> value)
(Highcharts, Highstock, Gantt) An array of lines stretching across the
plot area, marking a specific value on one of the axes.
|
void |
setRange(double value)
(Highstock) The zoomed range to display when only defining one or none of
min or max . |
void |
setReversed(boolean value)
(Highcharts, Highstock, Highmaps) Whether to reverse the axis so that the
highest number is closest to the origin.
|
void |
setReversedStacks(boolean value)
(Highcharts, Highstock) This option determines how stacks should be
ordered within a group.
|
void |
setScrollbar(XAxisScrollbarOptions value)
(Highstock) An optional scrollbar to display on the X axis in response to
limiting the minimum and maximum of the axis values.
|
void |
setShowEmpty(boolean value)
(Highcharts, Highstock, Highmaps) Whether to show the axis line and title
when the axis has no data.
|
void |
setShowFirstLabel(boolean value)
(Highcharts, Highstock, Highmaps) Whether to show the first tick label.
|
void |
setShowLastLabel(boolean value)
(Highcharts, Highstock, Gantt) Whether to show the last tick label.
|
void |
setSoftMax(double value)
(Highcharts, Highstock, Gantt) A soft maximum for the axis.
|
void |
setSoftMin(double value)
(Highcharts, Highstock, Gantt) A soft minimum for the axis.
|
void |
setStartOfWeek(double value)
(Highcharts, Highstock, Gantt) For datetime axes, this decides where to
put the tick between weeks.
|
void |
setStartOnTick(boolean value)
(Highcharts, Highstock, Highmaps) Whether to force the axis to start on a
tick.
|
void |
setTickAmount(double value)
(Highcharts, Highstock, Gantt) The amount of ticks to draw on the axis.
|
void |
setTickColor(String value)
(Highcharts, Highstock, Highmaps) Color for the main tick marks.
|
void |
setTickInterval(double value)
(Highcharts, Highstock, Highmaps) The interval of the tick marks in axis
units.
|
void |
setTickLength(double value)
(Highcharts, Highstock, Highmaps) The pixel length of the main tick
marks.
|
void |
setTickmarkPlacement(XAxisOptions.TickmarkPlacement value)
(Highcharts, Gantt) For categorized axes only.
|
void |
setTickPixelInterval(double value)
(Highcharts, Highstock, Highmaps) If tickInterval is
null this option
sets the approximate pixel interval of the tick marks. |
void |
setTickPosition(XAxisOptions.TickPosition value)
(Highcharts, Highstock, Highmaps) The position of the major tick marks
relative to the axis line.
|
void |
setTickPositioner(XAxisOptions.TickPositioner value)
(Highcharts, Highstock, Highmaps) A callback function returning array
defining where the ticks are laid out on the axis.
|
void |
setTickPositions(double[] value)
(Highcharts, Highstock, Highmaps) An array defining where the ticks are
laid out on the axis.
|
void |
setTickWidth(double value)
(Highcharts, Highstock, Highmaps) The pixel width of the major tick
marks.
|
void |
setTitle(XAxisTitleOptions value)
(Highcharts, Highstock, Highmaps) The axis title, showing next to the
axis line.
|
void |
setType(XAxisOptions.Type value)
(Highcharts, Gantt) The type of axis.
|
void |
setUniqueNames(boolean value)
(Highcharts, Gantt) Applies only when the axis
type is category . |
void |
setUnits(Array<Array<Unknown>> value)
(Highcharts, Highstock, Gantt) Datetime axis only.
|
void |
setVisible(boolean value)
(Highcharts, Highstock, Gantt) Whether axis, including axis title, line,
ticks and labels, should be visible.
|
boolean getAlignTicks()
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.void setAlignTicks(boolean value)
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.boolean getAllowDecimals()
void setAllowDecimals(boolean value)
@Nullable String getAlternateGridColor()
void setAlternateGridColor(String value)
@Nullable Array<XAxisBreaksOptions> getBreaks()
void setBreaks(Array<XAxisBreaksOptions> value)
@Nullable String[] getCategories()
category
. However, if you have multiple series, best practice
remains defining the categories
array.
Example:
(see online documentation for example)void setCategories(String[] value)
category
. However, if you have multiple series, best practice
remains defining the categories
array.
Example:
(see online documentation for example)double getCeiling()
void setCeiling(double value)
@Nullable String getClassName()
void setClassName(String value)
@Nullable Unknown getCrosshair()
.highcharts-crosshair
,
.highcharts-crosshair-thin
or .highcharts-xaxis-category
classes.void setCrosshair(XAxisCrosshairOptions value)
.highcharts-crosshair
,
.highcharts-crosshair-thin
or .highcharts-xaxis-category
classes.void setCrosshair(boolean value)
.highcharts-crosshair
,
.highcharts-crosshair-thin
or .highcharts-xaxis-category
classes.@Nullable Unknown getCurrentDateIndicator()
void setCurrentDateIndicator(boolean value)
void setCurrentDateIndicator(XAxisCurrentDateIndicatorOptions value)
@Nullable XAxisDateTimeLabelFormatsOptions getDateTimeLabelFormats()
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:
(see online documentation for example)void setDateTimeLabelFormats(XAxisDateTimeLabelFormatsOptions value)
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:
(see online documentation for example)@Nullable String getDescription()
void setDescription(String value)
boolean getEndOnTick()
maxPadding
option to control the axis
end.void setEndOnTick(boolean value)
maxPadding
option to control the axis
end.@Nullable XAxisEventsOptions getEvents()
void setEvents(XAxisEventsOptions value)
double getFloor()
void setFloor(double value)
@Nullable XAxisGridOptions getGrid()
void setGrid(XAxisGridOptions value)
@Nullable String getGridLineColor()
.highcharts-grid-line
class.void setGridLineColor(String value)
.highcharts-grid-line
class.@Nullable XAxisOptions.GridLineDashStyle getGridLineDashStyle()
void setGridLineDashStyle(XAxisOptions.GridLineDashStyle value)
double getGridLineWidth()
.highcharts-grid-line
class.void setGridLineWidth(double value)
.highcharts-grid-line
class.double getGridZIndex()
void setGridZIndex(double value)
@Nullable String getId()
chart.get()
.void setId(String value)
chart.get()
.@Nullable XAxisLabelsOptions getLabels()
void setLabels(XAxisLabelsOptions value)
@Nullable String getLineColor()
.highcharts-axis-line
or .highcharts-xaxis-line
class.void setLineColor(String value)
.highcharts-axis-line
or .highcharts-xaxis-line
class.double getLineWidth()
.highcharts-axis-line
or .highcharts-xaxis-line
class.void setLineWidth(double value)
.highcharts-axis-line
or .highcharts-xaxis-line
class.double getLinkedTo()
void setLinkedTo(double value)
double getMax()
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.void setMax(double value)
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.double getMaxPadding()
max
option is set
or a max extreme is set using axis.setExtremes()
, the maxPadding will
be ignored.void setMaxPadding(double value)
max
option is set
or a max extreme is set using axis.setExtremes()
, the maxPadding will
be ignored.double getMaxRange()
void setMaxRange(double value)
double getMaxZoom()
minRange
instead.void setMaxZoom(double value)
minRange
instead.double getMin()
null
the min value is automatically calculated.
If the startOnTick option is true (default), the min
value might be
rounded down.
The automatically calculated minimum value is also affected by floor,
softMin, minPadding, minRange as well as series.threshold and
series.softThreshold.void setMin(double value)
null
the min value is automatically calculated.
If the startOnTick option is true (default), the min
value might be
rounded down.
The automatically calculated minimum value is also affected by floor,
softMin, minPadding, minRange as well as series.threshold and
series.softThreshold.@Nullable String getMinorGridLineColor()
.highcharts-minor-grid-line
class.void setMinorGridLineColor(String value)
.highcharts-minor-grid-line
class.@Nullable XAxisOptions.MinorGridLineDashStyle getMinorGridLineDashStyle()
void setMinorGridLineDashStyle(XAxisOptions.MinorGridLineDashStyle value)
double getMinorGridLineWidth()
.highcharts-grid-line
class.void setMinorGridLineWidth(double value)
.highcharts-grid-line
class.@Nullable String getMinorTickColor()
void setMinorTickColor(String value)
@Nullable Unknown getMinorTickInterval()
"auto"
, the minor tick
interval is calculated as a fifth of the tickInterval. If null
or
undefined
, 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.
If user settings dictate minor ticks to become too dense, they don't make
sense, and will be ignored to prevent performance problems.void setMinorTickInterval(double value)
"auto"
, the minor tick
interval is calculated as a fifth of the tickInterval. If null
or
undefined
, 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.
If user settings dictate minor ticks to become too dense, they don't make
sense, and will be ignored to prevent performance problems.void setMinorTickInterval(String value)
"auto"
, the minor tick
interval is calculated as a fifth of the tickInterval. If null
or
undefined
, 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.
If user settings dictate minor ticks to become too dense, they don't make
sense, and will be ignored to prevent performance problems.double getMinorTickLength()
void setMinorTickLength(double value)
@Nullable XAxisOptions.MinorTickPosition getMinorTickPosition()
inside
and outside
.void setMinorTickPosition(XAxisOptions.MinorTickPosition value)
inside
and outside
.boolean getMinorTicks()
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"
.void setMinorTicks(boolean value)
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"
.double getMinorTickWidth()
void setMinorTickWidth(double value)
double getMinPadding()
min
option is set or a min
extreme is set using axis.setExtremes()
, the minPadding will be
ignored.void setMinPadding(double value)
min
option is set or a min
extreme is set using axis.setExtremes()
, the minPadding will be
ignored.double getMinRange()
minPadding
, maxPadding
, startOnTick
and endOnTick
settings also affect how the extremes of the axis are computed.void setMinRange(double value)
minPadding
, maxPadding
, startOnTick
and endOnTick
settings also affect how the extremes of the axis are computed.double getMinTickInterval()
void setMinTickInterval(double value)
double getOffset()
void setOffset(double value)
boolean getOpposite()
void setOpposite(boolean value)
boolean getOrdinal()
ordinal: false
will
show any gaps created by the gapSize
setting proportionate to their
duration.
In stock charts the X axis is ordinal by default, unless the boost module
is used and at least one of the series' data length exceeds the
boostThreshold.void setOrdinal(boolean value)
ordinal: false
will
show any gaps created by the gapSize
setting proportionate to their
duration.
In stock charts the X axis is ordinal by default, unless the boost module
is used and at least one of the series' data length exceeds the
boostThreshold.double getOverscroll()
xAxis.maxPadding
, but value is set in milliseconds. Can be
set for both main xAxis
and the navigator's xAxis
.void setOverscroll(double value)
xAxis.maxPadding
, but value is set in milliseconds. Can be
set for both main xAxis
and the navigator's xAxis
.double getPane()
void setPane(double value)
@Nullable Array<XAxisPlotBandsOptions> getPlotBands()
.highcharts-plot-band
class in addition to the className
option.void setPlotBands(Array<XAxisPlotBandsOptions> value)
.highcharts-plot-band
class in addition to the className
option.@Nullable Array<XAxisPlotLinesOptions> getPlotLines()
.highcharts-plot-line
class in addition to the className
option.void setPlotLines(Array<XAxisPlotLinesOptions> value)
.highcharts-plot-line
class in addition to the className
option.double getRange()
min
or max
. For example, to show the latest month, a range of one
month can be set.void setRange(double value)
min
or max
. For example, to show the latest month, a range of one
month can be set.boolean getReversed()
void setReversed(boolean value)
boolean getReversedStacks()
void setReversedStacks(boolean value)
@Nullable XAxisScrollbarOptions getScrollbar()
.highcharts-scrollbar-thumb
,
.highcharts-scrollbar-arrow
, .highcharts-scrollbar-button
,
.highcharts-scrollbar-rifles
and .highcharts-scrollbar-track
.void setScrollbar(XAxisScrollbarOptions value)
.highcharts-scrollbar-thumb
,
.highcharts-scrollbar-arrow
, .highcharts-scrollbar-button
,
.highcharts-scrollbar-rifles
and .highcharts-scrollbar-track
.boolean getShowEmpty()
void setShowEmpty(boolean value)
boolean getShowFirstLabel()
void setShowFirstLabel(boolean value)
boolean getShowLastLabel()
true
on cartesian charts, and false
on polar charts.void setShowLastLabel(boolean value)
true
on cartesian charts, and false
on polar charts.double getSoftMax()
void setSoftMax(double value)
double getSoftMin()
void setSoftMin(double value)
double getStartOfWeek()
void setStartOfWeek(double value)
boolean getStartOnTick()
minPadding
option to control the axis
start.void setStartOnTick(boolean value)
minPadding
option to control the axis
start.double getTickAmount()
tickPixelInterval
option.
This option only has an effect on linear axes. Datetime, logarithmic or
category axes are not affected.void setTickAmount(double value)
tickPixelInterval
option.
This option only has an effect on linear axes. Datetime, logarithmic or
category axes are not affected.@Nullable String getTickColor()
.highcharts-tick
class.void setTickColor(String value)
.highcharts-tick
class.double getTickInterval()
undefined
, the tick interval is computed to approximately
follow the tickPixelInterval on linear and datetime axes. On categorized
axes, a undefined
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.void setTickInterval(double value)
undefined
, the tick interval is computed to approximately
follow the tickPixelInterval on linear and datetime axes. On categorized
axes, a undefined
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.double getTickLength()
void setTickLength(double value)
@Nullable XAxisOptions.TickmarkPlacement getTickmarkPlacement()
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
.void setTickmarkPlacement(XAxisOptions.TickmarkPlacement value)
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
.double getTickPixelInterval()
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.void setTickPixelInterval(double value)
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.@Nullable XAxisOptions.TickPosition getTickPosition()
inside
and outside
.void setTickPosition(XAxisOptions.TickPosition value)
inside
and outside
.@Nullable XAxisOptions.TickPositioner getTickPositioner()
this.tickPositions
and can be
modified by the callback.void setTickPositioner(XAxisOptions.TickPositioner value)
this.tickPositions
and can be
modified by the callback.@Nullable double[] getTickPositions()
void setTickPositions(double[] value)
double getTickWidth()
.highcharts-tick
class.void setTickWidth(double value)
.highcharts-tick
class.@Nullable XAxisTitleOptions getTitle()
void setTitle(XAxisTitleOptions value)
@Nullable XAxisOptions.Type getType()
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.void setType(XAxisOptions.Type value)
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.boolean getUniqueNames()
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.void setUniqueNames(boolean value)
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.@Nullable Array<Array<Unknown>> getUnits()
void setUnits(Array<Array<Unknown>> value)
boolean getVisible()
void setVisible(boolean value)
Copyright © 2020. All rights reserved.