|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.moxieapps.gwt.highcharts.client.Configurable<Navigator> org.moxieapps.gwt.highcharts.client.Navigator
public class Navigator
The navigator is a small series below the main series, displaying a view of the entire data set. It provides tools
to zoom in and out on parts of the data as well as panning across the dataset. Applies only to StockChart
.
Method Summary | |
---|---|
Series |
getSeries()
Access the navigator series, to allow for customization via the Series.setPlotOptions(org.moxieapps.gwt.highcharts.client.plotOptions.PlotOptions)
method. |
XAxis |
getXAxis()
Access the navigator X axis, to allow for customization. |
YAxis |
getYAxis()
Access the navigator Y axis, to allow for customization. |
Navigator |
setAdaptToUpdatedData(boolean adaptToUpdatedData)
When this option is true, the navigator will redraw and reposition when data is updated in the main chart. |
Navigator |
setBaseSeries(Number seriesIndex)
Specify the index of the base series for the navigator. |
Navigator |
setBaseSeries(String seriesId)
Specify the ID of the base series for the navigator. |
Navigator |
setEnabled(boolean enabled)
Enable or disable the navigator. |
Navigator |
setHandlesBackgroundColor(String color)
Set the background color of the navigator handles. |
Navigator |
setHandlesBorderColor(String color)
Set the border color of the navigator handles. |
Navigator |
setHeight(Number height)
Set the height of the navigator. |
Navigator |
setMargin(Number margin)
Set the distance from the nearest element, the X axis or X axis labels. |
Navigator |
setMaskFill(String maskFillColor)
Set the color mask covering the areas of the navigator series that are currently not visible in the main series. |
Navigator |
setOutlineColor(String outlineColor)
Set the color of the line marking the currently zoomed area in the navigator. |
Navigator |
setOutlineWidth(Number outlineWidth)
Set the width of the line marking the currently zoomed area in the navigator. |
Methods inherited from class org.moxieapps.gwt.highcharts.client.Configurable |
---|
getOptions, setOption |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public Series getSeries()
Series.setPlotOptions(org.moxieapps.gwt.highcharts.client.plotOptions.PlotOptions)
method.
stockChart.getNavigator().getSeries()
.setType(Series.Type.LINE)
.setPlotOptions(new LinePlotOptions()
.setColor("#0000ff")
.setLineWidth(2));
public XAxis getXAxis()
stockChart.getNavigator().getXAxis()
.setOpposite(true)
.setTickWidth(1)
.setTickColor("#eeeeee");
public YAxis getYAxis()
stockChart.getNavigator().getYAxis()
.setOpposite(true)
.setTickWidth(1)
.setTickColor("#eeeeee");
public Navigator setAdaptToUpdatedData(boolean adaptToUpdatedData)
true
.
adaptToUpdatedData
- true to redraw and reposition on data update, false to disable.
Navigator
instance for convenient method chaining.public Navigator setBaseSeries(Number seriesIndex)
0
.
seriesIndex
- index of the base series
Navigator
instance for convenient method chaining.public Navigator setBaseSeries(String seriesId)
seriesId
- ID of the base series
Navigator
instance for convenient method chaining.public Navigator setEnabled(boolean enabled)
true.
- Parameters:
enabled
- true to enable the range selector, false to disable.
- Returns:
- A reference to this
Navigator
instance for convenient method chaining.
public Navigator setHandlesBackgroundColor(String color)
color
- the background color to set
Navigator
instance for convenient method chaining.public Navigator setHandlesBorderColor(String color)
color
- the border color to set
Navigator
instance for convenient method chaining.public Navigator setHeight(Number height)
40
.
height
- the height value to set (in pixels)
Navigator
instance for convenient method chaining.public Navigator setMargin(Number margin)
10
.
margin
- the margin distance value to set (in pixels)
Navigator
instance for convenient method chaining.public Navigator setMaskFill(String maskFillColor)
"rgba(255, 255, 255, 0.75)"
maskFillColor
- the color of the mask fill to set
Navigator
instance for convenient method chaining.public Navigator setOutlineColor(String outlineColor)
#444
.
outlineColor
- the outline color to set
Navigator
instance for convenient method chaining.public Navigator setOutlineWidth(Number outlineWidth)
2
.
outlineWidth
- the outlineWidth value to set (in pixels)
Navigator
instance for convenient method chaining.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |