public class Scrollbar extends AbstractChartObject
SerialChartModelImpl
and XYChartModelImpl
charts.
Constructor and Description |
---|
Scrollbar() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAccessibleLabel() |
java.lang.Boolean |
getAutoGridCount() |
java.lang.Double |
getBackgroundAlpha() |
Color |
getBackgroundColor() |
Color |
getColor() |
java.lang.String |
getDragCursorDown() |
java.lang.String |
getDragCursorHover() |
java.lang.String |
getDragIcon() |
java.lang.Integer |
getDragIconHeight() |
java.lang.Integer |
getDragIconWidth() |
java.lang.Boolean |
getEnabled() |
java.lang.String |
getGraph() |
java.lang.Double |
getGraphFillAlpha() |
Color |
getGraphFillColor() |
java.lang.Double |
getGraphLineAlpha() |
Color |
getGraphLineColor() |
GraphType |
getGraphType() |
java.lang.Double |
getGridAlpha() |
Color |
getGridColor() |
java.lang.Integer |
getGridCount() |
java.lang.Boolean |
getHideResizeGrips() |
java.lang.String |
getHResizeCursor() |
java.lang.String |
getHResizeCursorDown() |
java.lang.String |
getHResizeCursorHover() |
java.lang.Boolean |
getIgnoreCustomColors() |
java.lang.Double |
getMaximum() |
java.lang.Double |
getMinimum() |
java.lang.Integer |
getOffset() |
java.lang.Boolean |
getOppositeAxis() |
java.lang.Boolean |
getResizeEnabled() |
java.lang.Integer |
getScrollbarHeight() |
java.lang.Double |
getScrollDuration() |
java.lang.Double |
getSelectedBackgroundAlpha() |
Color |
getSelectedBackgroundColor() |
java.lang.Double |
getSelectedGraphFillAlpha() |
Color |
getSelectedGraphFillColor() |
java.lang.Double |
getSelectedGraphLineAlpha() |
Color |
getSelectedGraphLineColor() |
java.lang.Integer |
getTabIndex() |
java.lang.Boolean |
getUpdateOnReleaseOnly() |
java.lang.String |
getVResizeCursor() |
java.lang.String |
getVResizeCursorDown() |
java.lang.String |
getVResizeCursorHover() |
Scrollbar |
setAccessibleLabel(java.lang.String accessibleLabel)
Sets text which screen readers will read if user rolls-over or sets focus using tab key (this is possible only
if
AbstractGraph.tabIndex is set to some number) on the grips or draggable part of a scrollbar. |
Scrollbar |
setAutoGridCount(java.lang.Boolean autoGridCount)
Set autoGridCount to true if a number of gridCount should be specified automatically, according to the axis size.
|
Scrollbar |
setBackgroundAlpha(java.lang.Double backgroundAlpha)
Sets background opacity.
|
Scrollbar |
setBackgroundColor(Color backgroundColor)
Sets background color of the scrollbar.
|
Scrollbar |
setColor(Color color)
Sets text color.
|
Scrollbar |
setDragCursorDown(java.lang.String dragCursorDown)
Sets drag cursor.
|
Scrollbar |
setDragCursorHover(java.lang.String dragCursorHover)
Sets drag cursor hover.
|
Scrollbar |
setDragIcon(java.lang.String dragIcon)
Sets file name of scrollbar drag (resize grip) icon.
|
Scrollbar |
setDragIconHeight(java.lang.Integer dragIconHeight)
Sets height of resize grip image.
|
Scrollbar |
setDragIconWidth(java.lang.Integer dragIconWidth)
Sets width of resize grip image.
|
Scrollbar |
setEnabled(java.lang.Boolean enabled)
Set enabled to false if you don't want scrollbar should be enabled.
|
Scrollbar |
setGraph(java.lang.String graph)
Sets the graph which will be displayed in the scrollbar.
|
Scrollbar |
setGraphFillAlpha(java.lang.Double graphFillAlpha)
Sets graph fill opacity.
|
Scrollbar |
setGraphFillColor(Color graphFillColor)
Sets graph fill color.
|
Scrollbar |
setGraphLineAlpha(java.lang.Double graphLineAlpha)
Sets graph line opacity.
|
Scrollbar |
setGraphLineColor(Color graphLineColor)
Sets graph line color.
|
Scrollbar |
setGraphType(GraphType graphType)
Sets the graph type.
|
Scrollbar |
setGridAlpha(java.lang.Double gridAlpha)
Sets grid opacity.
|
Scrollbar |
setGridColor(Color gridColor)
Sets grid color.
|
Scrollbar |
setGridCount(java.lang.Integer gridCount)
Sets the number of grid lines.
|
Scrollbar |
setHideResizeGrips(java.lang.Boolean hideResizeGrips)
Set hideResizeGrips to true if resize grips should be hidden when the mouse is away from the scrollbar.
|
void |
setHResizeCursor(java.lang.String hResizeCursor)
Sets mouse cursor type shown when user hovers horizontal cursor's resize grips.
|
void |
setHResizeCursorDown(java.lang.String hResizeCursorDown)
Sets CSS value of cursor displayed when mouse is pressed down over horizontal cursor's resize grip.
|
void |
setHResizeCursorHover(java.lang.String hResizeCursorHover)
Sets CSS value of cursor displayed when hovering over horizontal cursor's resize grip.
|
Scrollbar |
setIgnoreCustomColors(java.lang.Boolean ignoreCustomColors)
Set ignoreCustomColors to true to use scrollbar's graph colors.
|
Scrollbar |
setMaximum(java.lang.Double maximum)
Sets maximum value of
ValueAxis of scrollbar. |
Scrollbar |
setMinimum(java.lang.Double minimum)
Sets minimum value of
ValueAxis of scrollbar. |
Scrollbar |
setOffset(java.lang.Integer offset)
Sets distance from plot area to scrollbar, in pixels.
|
Scrollbar |
setOppositeAxis(java.lang.Boolean oppositeAxis)
Set oppositeAxis to false and scrollbar will be placed next to category/value axis.
|
Scrollbar |
setResizeEnabled(java.lang.Boolean resizeEnabled)
Set resizeEnabled to false if you want prevent the chart scroll bar to change selection scope.
|
Scrollbar |
setScrollbarHeight(java.lang.Integer scrollbarHeight)
Sets height (width, if chart is rotated) of a scrollbar.
|
Scrollbar |
setScrollDuration(java.lang.Double scrollDuration)
Sets duration of scrolling, when the user clicks on scrollbar's background, in seconds.
|
Scrollbar |
setSelectedBackgroundAlpha(java.lang.Double selectedBackgroundAlpha)
Sets selected background opacity.
|
Scrollbar |
setSelectedBackgroundColor(Color selectedBackgroundColor)
Sets selected background color.
|
Scrollbar |
setSelectedGraphFillAlpha(java.lang.Double selectedGraphFillAlpha)
Sets selected graph's fill opacity.
|
Scrollbar |
setSelectedGraphFillColor(Color selectedGraphFillColor)
Sets selected graph's fill color.
|
Scrollbar |
setSelectedGraphLineAlpha(java.lang.Double selectedGraphLineAlpha)
Sets selected graph's line opacity.
|
Scrollbar |
setSelectedGraphLineColor(Color selectedGraphLineColor)
Sets selected graph's line color.
|
Scrollbar |
setTabIndex(java.lang.Integer tabIndex)
Sets tab index to scrollbar.
|
Scrollbar |
setUpdateOnReleaseOnly(java.lang.Boolean updateOnReleaseOnly)
Set updateOnReleaseOnly to true if the chart should be updated only at the moment when user releases mouse
button.
|
void |
setVResizeCursor(java.lang.String vResizeCursor)
Sets mouse cursor type shown when user hovers vertical cursor's resize grips.
|
void |
setVResizeCursorDown(java.lang.String vResizeCursorDown)
Sets CSS value of cursor displayed when mouse is pressed down over vertical cursor's resize grip.
|
void |
setVResizeCursorHover(java.lang.String vResizeCursorHover)
Sets CSS value of cursor displayed when hovering over vertical cursor's resize grip.
|
public java.lang.Boolean getAutoGridCount()
public Scrollbar setAutoGridCount(java.lang.Boolean autoGridCount)
autoGridCount
- autoGridCount optionpublic java.lang.Double getBackgroundAlpha()
public Scrollbar setBackgroundAlpha(java.lang.Double backgroundAlpha)
backgroundAlpha
- background opacitypublic Color getBackgroundColor()
public Scrollbar setBackgroundColor(Color backgroundColor)
backgroundColor
- background color of the scrollbarpublic Color getColor()
public Scrollbar setColor(Color color)
color
- text colorpublic java.lang.Integer getDragIconHeight()
public Scrollbar setDragIconHeight(java.lang.Integer dragIconHeight)
dragIconHeight
- drag icon heightpublic java.lang.Integer getDragIconWidth()
public Scrollbar setDragIconWidth(java.lang.Integer dragIconWidth)
dragIconWidth
- drag icon widthpublic java.lang.Double getGraphFillAlpha()
public Scrollbar setGraphFillAlpha(java.lang.Double graphFillAlpha)
graphFillAlpha
- graph fill opacitypublic Color getGraphFillColor()
public Scrollbar setGraphFillColor(Color graphFillColor)
graphFillColor
- graph fill colorpublic java.lang.Double getGraphLineAlpha()
public Scrollbar setGraphLineAlpha(java.lang.Double graphLineAlpha)
graphLineAlpha
- graph line opacitypublic Color getGraphLineColor()
public Scrollbar setGraphLineColor(Color graphLineColor)
graphLineColor
- graph line colorpublic GraphType getGraphType()
public Scrollbar setGraphType(GraphType graphType)
graphType
- graph typepublic java.lang.Double getGridAlpha()
public Scrollbar setGridAlpha(java.lang.Double gridAlpha)
gridAlpha
- grid opacitypublic Color getGridColor()
public Scrollbar setGridColor(Color gridColor)
gridColor
- grid colorpublic java.lang.Integer getGridCount()
public Scrollbar setGridCount(java.lang.Integer gridCount)
gridCount
- number of grid linespublic java.lang.Boolean getHideResizeGrips()
public Scrollbar setHideResizeGrips(java.lang.Boolean hideResizeGrips)
hideResizeGrips
- hideResizeGrips optionpublic java.lang.Double getMaximum()
ValueAxis
of scrollbarpublic Scrollbar setMaximum(java.lang.Double maximum)
ValueAxis
of scrollbar. Calculated automatically, if not set.maximum
- maximum valuepublic java.lang.Double getMinimum()
ValueAxis
of scrollbarpublic Scrollbar setMinimum(java.lang.Double minimum)
ValueAxis
of scrollbar. Calculated automatically, if not set.minimum
- minimum valuepublic java.lang.Boolean getResizeEnabled()
public Scrollbar setResizeEnabled(java.lang.Boolean resizeEnabled)
resizeEnabled
- resizeEnabled optionpublic java.lang.Integer getScrollbarHeight()
public Scrollbar setScrollbarHeight(java.lang.Integer scrollbarHeight)
scrollbarHeight
- scrollbar heightpublic java.lang.Double getScrollDuration()
public Scrollbar setScrollDuration(java.lang.Double scrollDuration)
scrollDuration
- scroll duration, in secondspublic java.lang.Double getSelectedBackgroundAlpha()
public Scrollbar setSelectedBackgroundAlpha(java.lang.Double selectedBackgroundAlpha)
selectedBackgroundAlpha
- opacitypublic Color getSelectedBackgroundColor()
public Scrollbar setSelectedBackgroundColor(Color selectedBackgroundColor)
selectedBackgroundColor
- colorpublic java.lang.Double getSelectedGraphFillAlpha()
public Scrollbar setSelectedGraphFillAlpha(java.lang.Double selectedGraphFillAlpha)
selectedGraphFillAlpha
- opacitypublic Color getSelectedGraphFillColor()
public Scrollbar setSelectedGraphFillColor(Color selectedGraphFillColor)
selectedGraphFillColor
- color.public java.lang.Double getSelectedGraphLineAlpha()
public Scrollbar setSelectedGraphLineAlpha(java.lang.Double selectedGraphLineAlpha)
selectedGraphLineAlpha
- opacitypublic Color getSelectedGraphLineColor()
public Scrollbar setSelectedGraphLineColor(Color selectedGraphLineColor)
selectedGraphLineColor
- colorpublic java.lang.Boolean getUpdateOnReleaseOnly()
public Scrollbar setUpdateOnReleaseOnly(java.lang.Boolean updateOnReleaseOnly)
updateOnReleaseOnly
- updateOnReleaseOnly optionpublic java.lang.String getGraph()
public Scrollbar setGraph(java.lang.String graph)
graph
- graph idpublic java.lang.Boolean getEnabled()
public Scrollbar setEnabled(java.lang.Boolean enabled)
enabled
- enabled optionpublic java.lang.Integer getOffset()
public Scrollbar setOffset(java.lang.Integer offset)
offset
- distance, in pixelspublic java.lang.String getDragIcon()
public Scrollbar setDragIcon(java.lang.String dragIcon)
dragIcon
- icon file namepublic java.lang.Boolean getIgnoreCustomColors()
public Scrollbar setIgnoreCustomColors(java.lang.Boolean ignoreCustomColors)
ignoreCustomColors
- ignoreCustomColors optionpublic java.lang.Boolean getOppositeAxis()
public Scrollbar setOppositeAxis(java.lang.Boolean oppositeAxis)
oppositeAxis
- oppositeAxis optionpublic java.lang.String getDragCursorDown()
public Scrollbar setDragCursorDown(java.lang.String dragCursorDown)
dragCursorDown
- drag cursor down stringpublic java.lang.String getDragCursorHover()
public Scrollbar setDragCursorHover(java.lang.String dragCursorHover)
dragCursorHover
- drag cursor hover stringpublic java.lang.Integer getTabIndex()
public Scrollbar setTabIndex(java.lang.Integer tabIndex)
tabIndex
- tab indexpublic java.lang.String getAccessibleLabel()
public Scrollbar setAccessibleLabel(java.lang.String accessibleLabel)
AbstractGraph.tabIndex
is set to some number) on the grips or draggable part of a scrollbar. Text is
added as aria-label tag. Not all screen readers and browsers support this. Note, you should set tabIndex to
some number in order it would be possible to zoom chart using cursor keys. If not set the default value is
"Zoom chart using cursor arrows".accessibleLabel
- accessible label stringpublic java.lang.String getHResizeCursor()
public void setHResizeCursor(java.lang.String hResizeCursor)
hResizeCursor
- hResizeCursor valuepublic java.lang.String getHResizeCursorDown()
public void setHResizeCursorDown(java.lang.String hResizeCursorDown)
hResizeCursorDown
- CSS valuepublic java.lang.String getHResizeCursorHover()
public void setHResizeCursorHover(java.lang.String hResizeCursorHover)
hResizeCursorHover
- CSS valuepublic java.lang.String getVResizeCursor()
public void setVResizeCursor(java.lang.String vResizeCursor)
vResizeCursor
- vResizeCursor valuepublic java.lang.String getVResizeCursorDown()
public void setVResizeCursorDown(java.lang.String vResizeCursorDown)
vResizeCursorDown
- CSS valuepublic java.lang.String getVResizeCursorHover()
public void setVResizeCursorHover(java.lang.String vResizeCursorHover)
vResizeCursorHover
- CSS value