public class HIXAxis extends HIFoundation
Constructor and Description |
---|
HIXAxis() |
Modifier and Type | Method and Description |
---|---|
void |
addPlotBand(HIPlotBands options)
Add a plot band after render time.
|
void |
addPlotLine(HIPlotLines options)
Add a plot line after render time.
|
void |
addTitle(java.lang.Boolean display)
Adds the title defined in axis.options.title.
|
void |
drawCrosshair()
Internal function to draw a crosshair.
|
HIAccessibility |
getAccessibility() |
java.lang.Boolean |
getAlignTicks() |
java.lang.Boolean |
getAllowDecimals() |
HIColor |
getAlternateGridColor() |
java.lang.Number |
getAngle() |
java.util.ArrayList |
getBreaks() |
java.util.ArrayList<java.lang.String> |
getCategories() |
java.lang.Number |
getCeiling() |
java.lang.String |
getClassName() |
HICrosshair |
getCrosshair() |
java.lang.Number |
getCrossing() |
HIDateTimeLabelFormats |
getDateTimeLabelFormats() |
java.lang.Boolean |
getEndOnTick() |
HIEvents |
getEvents() |
java.lang.Number |
getFloor() |
HIColor |
getGridLineColor() |
java.lang.String |
getGridLineDashStyle() |
java.lang.String |
getGridLineInterpolation() |
java.lang.Number |
getGridLineWidth() |
java.lang.Number |
getGridZIndex() |
java.lang.Object |
getHeight() |
java.lang.String |
getId() |
HILabels |
getLabels() |
java.lang.Object |
getLeft() |
HIColor |
getLineColor() |
java.lang.Number |
getLineWidth() |
java.lang.Number |
getLinkedTo() |
java.lang.Number |
getMargin() |
java.lang.Number |
getMax() |
java.lang.Number |
getMaxPadding() |
java.lang.Number |
getMin() |
HIColor |
getMinorGridLineColor() |
java.lang.String |
getMinorGridLineDashStyle() |
java.lang.Number |
getMinorGridLineWidth() |
HIColor |
getMinorTickColor() |
java.lang.Number |
getMinorTickInterval() |
java.lang.Number |
getMinorTickLength() |
java.lang.String |
getMinorTickPosition() |
java.lang.Boolean |
getMinorTicks() |
java.lang.Number |
getMinorTicksPerMajor() |
java.lang.Number |
getMinorTickWidth() |
java.lang.Number |
getMinPadding() |
java.lang.Number |
getMinRange() |
java.lang.Number |
getMinTickInterval() |
java.lang.Number |
getOffset() |
java.lang.Boolean |
getOpposite() |
java.lang.Number |
getPane() |
java.lang.Boolean |
getPanningEnabled() |
java.util.HashMap<java.lang.String,java.lang.Object> |
getParams() |
java.util.ArrayList |
getPlotBands() |
java.util.ArrayList |
getPlotLines() |
java.lang.Boolean |
getReversed() |
java.lang.Boolean |
getReversedStacks() |
java.lang.Boolean |
getShowEmpty() |
java.lang.Boolean |
getShowFirstLabel() |
java.lang.Boolean |
getShowLastLabel() |
java.lang.Number |
getSoftMax() |
java.lang.Number |
getSoftMin() |
java.lang.Number |
getStartOfWeek() |
java.lang.Boolean |
getStartOnTick() |
java.lang.Number |
getTickAmount() |
HIColor |
getTickColor() |
java.lang.Number |
getTickInterval() |
java.lang.Number |
getTickLength() |
java.lang.String |
getTickmarkPlacement() |
java.lang.Number |
getTickPixelInterval() |
java.lang.String |
getTickPosition() |
HIFunction |
getTickPositioner() |
java.util.ArrayList<java.lang.Number> |
getTickPositions() |
java.lang.Number |
getTickWidth() |
HITitle |
getTitle() |
java.lang.Object |
getTop() |
java.lang.String |
getType() |
java.lang.Boolean |
getUniqueNames() |
java.util.ArrayList<java.util.ArrayList> |
getUnits() |
java.lang.Boolean |
getVisible() |
java.lang.Object |
getWidth() |
java.lang.Number |
getZIndex() |
java.lang.Boolean |
getZoomEnabled() |
void |
hideCrosshair()
Hide the crosshair if visible.
|
void |
remove()
Remove the axis from the chart.
|
void |
remove(java.lang.Boolean redraw)
Remove the axis from the chart.
|
void |
removePlotBand(java.lang.String id)
Remove a plot band by its id.
|
void |
removePlotLine(java.lang.String id)
Remove a plot line by its id.
|
void |
renderLine()
Render the axis line.
|
void |
renderMinorTick(java.lang.Number pos)
Render a minor tick into the given position.
|
void |
renderTick(java.lang.Number pos,
java.lang.Number i)
Render a major tick into the given position.
|
void |
setAccessibility(HIAccessibility accessibility)
Accessibility options for an axis.
|
void |
setAlignTicks(java.lang.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(java.lang.Boolean allowDecimals)
Whether to allow decimals in this axis' ticks.
|
void |
setAlternateGridColor(HIColor alternateGridColor)
When using an alternate grid color, a band is painted across the plot area between every other grid line.
|
void |
setAngle(java.lang.Number angle)
In a polar chart, this is the angle of the Y axis in degrees, where 0 is up and 90 is right.
|
void |
setAxisTitle(HITitle title)
Update the axis title by options after render time.
|
void |
setAxisTitle(HITitle title,
boolean redraw)
Update the axis title by options after render time.
|
void |
setBreaks(java.util.ArrayList breaks)
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(java.util.ArrayList<java.lang.String> categories)
If categories are present for the xAxis, names are used instead of numbers for that axis.
|
void |
setCategories(java.util.List<java.lang.String> categories)
Set new axis categories and optionally redraw.
|
void |
setCategories(java.util.List<java.lang.String> categories,
boolean redraw)
Set new axis categories and optionally redraw.
|
void |
setCeiling(java.lang.Number ceiling)
The highest allowed value for automatically computed axis extremes.
|
void |
setClassName(java.lang.String className)
A class name that opens for styling the axis by CSS, especially in Highcharts styled mode.
|
void |
setCrosshair(HICrosshair crosshair)
Configure a crosshair that follows either the mouse pointer or the hovered point.
|
void |
setCrossing(java.lang.Number crossing)
The value on a perpendicular axis where this axis should cross.
|
void |
setDateTimeLabelFormats(HIDateTimeLabelFormats dateTimeLabelFormats)
For a datetime axis, the scale will automatically adjust to the appropriate unit.
|
void |
setEndOnTick(java.lang.Boolean endOnTick)
Whether to force the axis to end on a tick.
|
void |
setEvents(HIEvents events)
Event handlers for the axis.
|
void |
setExtremes()
Set the minimum and maximum of the axes after render time.
|
void |
setExtremes(java.lang.Number newMin)
Set the minimum and maximum of the axes after render time.
|
void |
setExtremes(java.lang.Number newMin,
java.lang.Number newMax)
Set the minimum and maximum of the axes after render time.
|
void |
setExtremes(java.lang.Number newMin,
java.lang.Number newMax,
boolean redraw)
Set the minimum and maximum of the axes after render time.
|
void |
setExtremes(java.lang.Number newMin,
java.lang.Number newMax,
boolean redraw,
HIAnimationOptionsObject animation)
Set the minimum and maximum of the axes after render time.
|
void |
setFloor(java.lang.Number floor)
The lowest allowed value for automatically computed axis extremes.
|
void |
setGridLineColor(HIColor gridLineColor)
Color of the grid lines extending the ticks across the plot area.
|
void |
setGridLineDashStyle(java.lang.String gridLineDashStyle)
The dash or dot style of the grid lines.
|
void |
setGridLineInterpolation(java.lang.String gridLineInterpolation)
Polar charts only.
|
void |
setGridLineWidth(java.lang.Number gridLineWidth)
The width of the grid lines extending the ticks across the plot area.
|
void |
setGridZIndex(java.lang.Number gridZIndex)
The Z index of the grid lines.
|
void |
setHeight(java.lang.Object height)
The height as the vertical axis.
|
void |
setId(java.lang.String id)
An id for the axis.
|
void |
setLabels(HILabels labels)
The axis labels show the number or category for each tick.
|
void |
setLeft(java.lang.Object left)
The left position as the horizontal axis.
|
void |
setLineColor(HIColor lineColor)
The color of the line marking the axis itself.
|
void |
setLineWidth(java.lang.Number lineWidth)
The width of the line marking the axis itself.
|
void |
setLinkedTo(java.lang.Number linkedTo)
Index of another axis that this axis is linked to.
|
void |
setMargin(java.lang.Number margin)
If there are multiple axes on the same side of the chart, the pixel margin between the axes.
|
void |
setMax(java.lang.Number max)
The maximum value of the axis.
|
void |
setMaxPadding(java.lang.Number maxPadding)
Padding of the max value relative to the length of the axis.
|
void |
setMin(java.lang.Number min)
The minimum value of the axis.
|
void |
setMinorGridLineColor(HIColor minorGridLineColor)
Color of the minor, secondary grid lines.
|
void |
setMinorGridLineDashStyle(java.lang.String minorGridLineDashStyle)
The dash or dot style of the minor grid lines.
|
void |
setMinorGridLineWidth(java.lang.Number minorGridLineWidth)
Width of the minor, secondary grid lines.
|
void |
setMinorTickColor(HIColor minorTickColor)
Color for the minor tick marks.
|
void |
setMinorTickInterval(java.lang.Number minorTickInterval)
Specific tick interval in axis units for the minor ticks.
|
void |
setMinorTickLength(java.lang.Number minorTickLength)
The pixel length of the minor tick marks.
|
void |
setMinorTickPosition(java.lang.String minorTickPosition)
The position of the minor tick marks relative to the axis line.
|
void |
setMinorTicks(java.lang.Boolean minorTicks)
Enable or disable minor ticks.
|
void |
setMinorTicksPerMajor(java.lang.Number minorTicksPerMajor)
The number of minor ticks per major tick.
|
void |
setMinorTickWidth(java.lang.Number minorTickWidth)
The pixel width of the minor tick mark.
|
void |
setMinPadding(java.lang.Number minPadding)
Padding of the min value relative to the length of the axis.
|
void |
setMinRange(java.lang.Number minRange)
The minimum range to display on this axis.
|
void |
setMinTickInterval(java.lang.Number minTickInterval)
The minimum tick interval allowed in axis values.
|
void |
setOffset(java.lang.Number offset)
The distance in pixels from the plot area to the axis line.
|
void |
setOpposite(java.lang.Boolean opposite)
Whether to display the axis on the opposite side of the normal.
|
void |
setPane(java.lang.Number pane)
Refers to the index in the `panes` array.
|
void |
setPanningEnabled(java.lang.Boolean panningEnabled)
Whether to pan axis.
|
void |
setPlotBands(java.util.ArrayList plotBands)
An array of colored bands stretching across the plot area marking an interval on the axis.
|
void |
setPlotLines(java.util.ArrayList plotLines)
An array of lines stretching across the plot area, marking a specific value on one of the axes.
|
void |
setReversed(java.lang.Boolean reversed)
Whether to reverse the axis so that the highest number is closest to the origin.
|
void |
setReversedStacks(java.lang.Boolean reversedStacks)
This option determines how stacks should be ordered within a group.
|
void |
setShowEmpty(java.lang.Boolean showEmpty)
Whether to show the axis line and title when the axis has no data.
|
void |
setShowFirstLabel(java.lang.Boolean showFirstLabel)
Whether to show the first tick label.
|
void |
setShowLastLabel(java.lang.Boolean showLastLabel)
Whether to show the last tick label.
|
void |
setSoftMax(java.lang.Number softMax)
A soft maximum for the axis.
|
void |
setSoftMin(java.lang.Number softMin)
A soft minimum for the axis.
|
void |
setStartOfWeek(java.lang.Number startOfWeek)
For datetime axes, this decides where to put the tick between weeks. 0 = Sunday, 1 = Monday.
|
void |
setStartOnTick(java.lang.Boolean startOnTick)
Whether to force the axis to start on a tick.
|
void |
setTickAmount(java.lang.Number tickAmount)
The amount of ticks to draw on the axis.
|
void |
setTickColor(HIColor tickColor)
Color for the main tick marks.
|
void |
setTickInterval(java.lang.Number tickInterval)
The interval of the tick marks in axis units.
|
void |
setTickLength(java.lang.Number tickLength)
The pixel length of the main tick marks.
|
void |
setTickmarkPlacement(java.lang.String tickmarkPlacement)
For categorized axes only.
|
void |
setTickPixelInterval(java.lang.Number tickPixelInterval)
If tickInterval is `null` this option sets the approximate pixel interval of the tick marks.
|
void |
setTickPosition(java.lang.String tickPosition)
The position of the major tick marks relative to the axis line.
|
void |
setTickPositioner(HIFunction tickPositioner)
A callback function returning array defining where the ticks are laid out on the axis.
|
void |
setTickPositions()
Now we have computed the normalized tickInterval, get the tick positions
|
void |
setTickPositions(java.util.ArrayList<java.lang.Number> tickPositions)
An array defining where the ticks are laid out on the axis.
|
void |
setTickWidth(java.lang.Number tickWidth)
The pixel width of the major tick marks.
|
void |
setTitle(HITitle title)
The axis title, showing next to the axis line.
|
void |
setTop(java.lang.Object top)
The top position as the vertical axis.
|
void |
setType(java.lang.String type)
The type of axis.
|
void |
setUniqueNames(java.lang.Boolean uniqueNames)
Applies only when the axis `type` is `category`.
|
void |
setUnits(java.util.ArrayList<java.util.ArrayList> units)
Datetime axis only.
|
void |
setVisible(java.lang.Boolean visible)
Whether axis, including axis title, line, ticks and labels, should be visible.
|
void |
setWidth(java.lang.Object width)
The width as the horizontal axis.
|
void |
setZIndex(java.lang.Number zIndex)
The Z index for the axis group.
|
void |
setZoomEnabled(java.lang.Boolean zoomEnabled)
Whether to zoom axis.
|
void |
update(HIXAxis options)
Translate a pixel position along the axis to a value in terms of axis units.
|
void |
update(HIXAxis options,
boolean redraw)
Translate a pixel position along the axis to a value in terms of axis units.
|
public void addPlotBand(HIPlotBands options)
options
- A configuration object for the plot band, as defined in xAxis.plotBands.public void addPlotLine(HIPlotLines options)
options
- A configuration object for the plot line, as defined in xAxis.plotLines.public void addTitle(java.lang.Boolean display)
display
- Whether or not to display the title.public void drawCrosshair()
public HIAccessibility getAccessibility()
public java.lang.Boolean getAlignTicks()
public java.lang.Boolean getAllowDecimals()
public HIColor getAlternateGridColor()
public java.lang.Number getAngle()
public java.util.ArrayList getBreaks()
public java.util.ArrayList<java.lang.String> getCategories()
public java.lang.Number getCeiling()
public java.lang.String getClassName()
public HICrosshair getCrosshair()
public java.lang.Number getCrossing()
public HIDateTimeLabelFormats getDateTimeLabelFormats()
public java.lang.Boolean getEndOnTick()
public HIEvents getEvents()
public java.lang.Number getFloor()
public HIColor getGridLineColor()
public java.lang.String getGridLineDashStyle()
public java.lang.String getGridLineInterpolation()
public java.lang.Number getGridLineWidth()
public java.lang.Number getGridZIndex()
public java.lang.Object getHeight()
public java.lang.String getId()
public HILabels getLabels()
public java.lang.Object getLeft()
public HIColor getLineColor()
public java.lang.Number getLineWidth()
public java.lang.Number getLinkedTo()
public java.lang.Number getMargin()
public java.lang.Number getMax()
public java.lang.Number getMaxPadding()
public java.lang.Number getMin()
public HIColor getMinorGridLineColor()
public java.lang.String getMinorGridLineDashStyle()
public java.lang.Number getMinorGridLineWidth()
public HIColor getMinorTickColor()
public java.lang.Number getMinorTickInterval()
public java.lang.Number getMinorTickLength()
public java.lang.String getMinorTickPosition()
public java.lang.Boolean getMinorTicks()
public java.lang.Number getMinorTicksPerMajor()
public java.lang.Number getMinorTickWidth()
public java.lang.Number getMinPadding()
public java.lang.Number getMinRange()
public java.lang.Number getMinTickInterval()
public java.lang.Number getOffset()
public java.lang.Boolean getOpposite()
public java.lang.Number getPane()
public java.lang.Boolean getPanningEnabled()
public java.util.HashMap<java.lang.String,java.lang.Object> getParams()
getParams
in class HIFoundation
public java.util.ArrayList getPlotBands()
public java.util.ArrayList getPlotLines()
public java.lang.Boolean getReversed()
public java.lang.Boolean getReversedStacks()
public java.lang.Boolean getShowEmpty()
public java.lang.Boolean getShowFirstLabel()
public java.lang.Boolean getShowLastLabel()
public java.lang.Number getSoftMax()
public java.lang.Number getSoftMin()
public java.lang.Number getStartOfWeek()
public java.lang.Boolean getStartOnTick()
public java.lang.Number getTickAmount()
public HIColor getTickColor()
public java.lang.Number getTickInterval()
public java.lang.Number getTickLength()
public java.lang.String getTickmarkPlacement()
public java.lang.Number getTickPixelInterval()
public java.lang.String getTickPosition()
public HIFunction getTickPositioner()
public java.util.ArrayList<java.lang.Number> getTickPositions()
public java.lang.Number getTickWidth()
public HITitle getTitle()
public java.lang.Object getTop()
public java.lang.String getType()
public java.lang.Boolean getUniqueNames()
public java.util.ArrayList<java.util.ArrayList> getUnits()
public java.lang.Boolean getVisible()
public java.lang.Object getWidth()
public java.lang.Number getZIndex()
public java.lang.Boolean getZoomEnabled()
public void hideCrosshair()
public void remove()
public void remove(java.lang.Boolean redraw)
redraw
- Whether to redraw the chart following the remove.public void removePlotBand(java.lang.String id)
id
- The plot band's id as given in the original configuration object or in the addPlotBand option.public void removePlotLine(java.lang.String id)
id
- The plot line's id as given in the original configuration object or in the addPlotLine option.public void renderLine()
public void renderMinorTick(java.lang.Number pos)
pos
- The position in axis values.public void renderTick(java.lang.Number pos, java.lang.Number i)
pos
- The position in axis values.i
- The tick index.public void setAccessibility(HIAccessibility accessibility)
public void setAlignTicks(java.lang.Boolean alignTicks)
public void setAllowDecimals(java.lang.Boolean allowDecimals)
public void setAlternateGridColor(HIColor alternateGridColor)
public void setAngle(java.lang.Number angle)
public void setAxisTitle(HITitle title)
title
- The additional title options.public void setAxisTitle(HITitle title, boolean redraw)
title
- The additional title options.redraw
- Whether to redraw the chart after setting the title.public void setBreaks(java.util.ArrayList breaks)
public void setCategories(java.util.ArrayList<java.lang.String> categories)
public void setCategories(java.util.List<java.lang.String> categories)
categories
- The new categories.public void setCategories(java.util.List<java.lang.String> categories, boolean redraw)
categories
- The new categories.redraw
- Whether to redraw the chart.public void setCeiling(java.lang.Number ceiling)
public void setClassName(java.lang.String className)
public void setCrosshair(HICrosshair crosshair)
public void setCrossing(java.lang.Number crossing)
public void setDateTimeLabelFormats(HIDateTimeLabelFormats dateTimeLabelFormats)
public void setEndOnTick(java.lang.Boolean endOnTick)
public void setEvents(HIEvents events)
public void setExtremes()
public void setExtremes(java.lang.Number newMin)
newMin
- The new minimum value.public void setExtremes(java.lang.Number newMin, java.lang.Number newMax)
newMin
- The new minimum value.newMax
- The new maximum value.public void setExtremes(java.lang.Number newMin, java.lang.Number newMax, boolean redraw)
newMin
- The new minimum value.newMax
- The new maximum value.redraw
- Whether to redraw the chart or wait for an explicit call to HIChartView redraw()public void setExtremes(java.lang.Number newMin, java.lang.Number newMax, boolean redraw, HIAnimationOptionsObject animation)
newMin
- The new minimum value.newMax
- The new maximum value.redraw
- Whether to redraw the chart or wait for an explicit call to HIChartView redraw()animation
- Enable or modify animations.public void setFloor(java.lang.Number floor)
public void setGridLineColor(HIColor gridLineColor)
public void setGridLineDashStyle(java.lang.String gridLineDashStyle)
public void setGridLineInterpolation(java.lang.String gridLineInterpolation)
public void setGridLineWidth(java.lang.Number gridLineWidth)
public void setGridZIndex(java.lang.Number gridZIndex)
public void setHeight(java.lang.Object height)
public void setId(java.lang.String id)
public void setLabels(HILabels labels)
public void setLeft(java.lang.Object left)
public void setLineColor(HIColor lineColor)
public void setLineWidth(java.lang.Number lineWidth)
public void setLinkedTo(java.lang.Number linkedTo)
public void setMargin(java.lang.Number margin)
public void setMax(java.lang.Number max)
public void setMaxPadding(java.lang.Number maxPadding)
public void setMin(java.lang.Number min)
public void setMinorGridLineColor(HIColor minorGridLineColor)
public void setMinorGridLineDashStyle(java.lang.String minorGridLineDashStyle)
public void setMinorGridLineWidth(java.lang.Number minorGridLineWidth)
public void setMinorTickColor(HIColor minorTickColor)
public void setMinorTickInterval(java.lang.Number minorTickInterval)
public void setMinorTickLength(java.lang.Number minorTickLength)
public void setMinorTickPosition(java.lang.String minorTickPosition)
public void setMinorTicks(java.lang.Boolean minorTicks)
public void setMinorTicksPerMajor(java.lang.Number minorTicksPerMajor)
public void setMinorTickWidth(java.lang.Number minorTickWidth)
public void setMinPadding(java.lang.Number minPadding)
public void setMinRange(java.lang.Number minRange)
public void setMinTickInterval(java.lang.Number minTickInterval)
public void setOffset(java.lang.Number offset)
public void setOpposite(java.lang.Boolean opposite)
public void setPane(java.lang.Number pane)
public void setPanningEnabled(java.lang.Boolean panningEnabled)
public void setPlotBands(java.util.ArrayList plotBands)
public void setPlotLines(java.util.ArrayList plotLines)
public void setReversed(java.lang.Boolean reversed)
public void setReversedStacks(java.lang.Boolean reversedStacks)
public void setShowEmpty(java.lang.Boolean showEmpty)
public void setShowFirstLabel(java.lang.Boolean showFirstLabel)
public void setShowLastLabel(java.lang.Boolean showLastLabel)
public void setSoftMax(java.lang.Number softMax)
public void setSoftMin(java.lang.Number softMin)
public void setStartOfWeek(java.lang.Number startOfWeek)
public void setStartOnTick(java.lang.Boolean startOnTick)
public void setTickAmount(java.lang.Number tickAmount)
public void setTickColor(HIColor tickColor)
public void setTickInterval(java.lang.Number tickInterval)
public void setTickLength(java.lang.Number tickLength)
public void setTickmarkPlacement(java.lang.String tickmarkPlacement)
public void setTickPixelInterval(java.lang.Number tickPixelInterval)
public void setTickPosition(java.lang.String tickPosition)
public void setTickPositioner(HIFunction tickPositioner)
public void setTickPositions()
public void setTickPositions(java.util.ArrayList<java.lang.Number> tickPositions)
public void setTickWidth(java.lang.Number tickWidth)
public void setTitle(HITitle title)
public void setTop(java.lang.Object top)
public void setType(java.lang.String type)
public void setUniqueNames(java.lang.Boolean uniqueNames)
public void setUnits(java.util.ArrayList<java.util.ArrayList> units)
public void setVisible(java.lang.Boolean visible)
public void setWidth(java.lang.Object width)
public void setZIndex(java.lang.Number zIndex)
public void setZoomEnabled(java.lang.Boolean zoomEnabled)
public void update(HIXAxis options)
options
- The new options that will be merged in with existing options on the axis.public void update(HIXAxis options, boolean redraw)
options
- The new options that will be merged in with existing options on the axis.redraw
- Whether to redraw the chart after the axis is altered. If doing more operations on the chart, it is a good idea to set redraw to false and call redraw() on HIChartView after.