Class Scrollbar
- java.lang.Object
-
- com.vaadin.flow.component.charts.model.AbstractConfigurationObject
-
- com.vaadin.flow.component.charts.model.Scrollbar
-
- All Implemented Interfaces:
Serializable
public class Scrollbar extends AbstractConfigurationObject
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-riflesand.highcharts-scrollbar-track.- See Also:
- Serialized Form
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ColorgetBarBackgroundColor()ColorgetBarBorderColor()NumbergetBarBorderRadius()NumbergetBarBorderWidth()ColorgetButtonArrowColor()ColorgetButtonBackgroundColor()ColorgetButtonBorderColor()NumbergetButtonBorderRadius()NumbergetButtonBorderWidth()BooleangetEnabled()NumbergetHeight()BooleangetLiveRedraw()NumbergetMargin()NumbergetMinWidth()ColorgetRifleColor()BooleangetShowFull()NumbergetSize()ColorgetTrackBackgroundColor()ColorgetTrackBorderColor()NumbergetTrackBorderRadius()NumbergetZIndex()voidsetBarBackgroundColor(Color barBackgroundColor)The background color of the scrollbar itself.voidsetBarBorderColor(Color barBorderColor)The color of the scrollbar's border.voidsetBarBorderRadius(Number barBorderRadius)The border rounding radius of the bar.voidsetBarBorderWidth(Number barBorderWidth)The width of the bar's border.voidsetButtonArrowColor(Color buttonArrowColor)The color of the small arrow inside the scrollbar buttons.voidsetButtonBackgroundColor(Color buttonBackgroundColor)The color of scrollbar buttons.voidsetButtonBorderColor(Color buttonBorderColor)The color of the border of the scrollbar buttons.voidsetButtonBorderRadius(Number buttonBorderRadius)The corner radius of the scrollbar buttons.voidsetButtonBorderWidth(Number buttonBorderWidth)The border width of the scrollbar buttons.voidsetEnabled(Boolean enabled)Enable the scrollbar on the Y axis.voidsetHeight(Number height)The height of the scrollbar.voidsetLiveRedraw(Boolean liveRedraw)Whether to redraw the main chart as the scrollbar or the navigator zoomed window is moved.voidsetMargin(Number margin)Pixel margin between the scrollbar and the axis elements.voidsetMinWidth(Number minWidth)The minimum width of the scrollbar.voidsetRifleColor(Color rifleColor)The color of the small rifles in the middle of the scrollbar.voidsetShowFull(Boolean showFull)Whether to show the scrollbar when it is fully zoomed out at max range.voidsetSize(Number size)The width of a vertical scrollbar or height of a horizontal scrollbar.voidsetTrackBackgroundColor(Color trackBackgroundColor)The color of the track background.voidsetTrackBorderColor(Color trackBorderColor)The color of the border of the scrollbar track.voidsetTrackBorderRadius(Number trackBorderRadius)The corner radius of the border of the scrollbar track.voidsetZIndex(Number zIndex)Z index of the scrollbar elements.
-
-
-
Constructor Detail
-
Scrollbar
public Scrollbar()
-
Scrollbar
public Scrollbar(Boolean enabled)
-
-
Method Detail
-
getBarBackgroundColor
public Color getBarBackgroundColor()
- See Also:
setBarBackgroundColor(Color)
-
setBarBackgroundColor
public void setBarBackgroundColor(Color barBackgroundColor)
The background color of the scrollbar itself.Defaults to: #cccccc
-
getBarBorderColor
public Color getBarBorderColor()
- See Also:
setBarBorderColor(Color)
-
setBarBorderColor
public void setBarBorderColor(Color barBorderColor)
The color of the scrollbar's border.Defaults to: #cccccc
-
getBarBorderRadius
public Number getBarBorderRadius()
- See Also:
setBarBorderRadius(Number)
-
setBarBorderRadius
public void setBarBorderRadius(Number barBorderRadius)
The border rounding radius of the bar.Defaults to: 0
-
getBarBorderWidth
public Number getBarBorderWidth()
- See Also:
setBarBorderWidth(Number)
-
setBarBorderWidth
public void setBarBorderWidth(Number barBorderWidth)
The width of the bar's border.Defaults to: 1
-
getButtonArrowColor
public Color getButtonArrowColor()
- See Also:
setButtonArrowColor(Color)
-
setButtonArrowColor
public void setButtonArrowColor(Color buttonArrowColor)
The color of the small arrow inside the scrollbar buttons.Defaults to: #333333
-
getButtonBackgroundColor
public Color getButtonBackgroundColor()
- See Also:
setButtonBackgroundColor(Color)
-
setButtonBackgroundColor
public void setButtonBackgroundColor(Color buttonBackgroundColor)
The color of scrollbar buttons.Defaults to: #e6e6e6
-
getButtonBorderColor
public Color getButtonBorderColor()
- See Also:
setButtonBorderColor(Color)
-
setButtonBorderColor
public void setButtonBorderColor(Color buttonBorderColor)
The color of the border of the scrollbar buttons.Defaults to: #cccccc
-
getButtonBorderRadius
public Number getButtonBorderRadius()
- See Also:
setButtonBorderRadius(Number)
-
setButtonBorderRadius
public void setButtonBorderRadius(Number buttonBorderRadius)
The corner radius of the scrollbar buttons.Defaults to: 0
-
getButtonBorderWidth
public Number getButtonBorderWidth()
- See Also:
setButtonBorderWidth(Number)
-
setButtonBorderWidth
public void setButtonBorderWidth(Number buttonBorderWidth)
The border width of the scrollbar buttons.Defaults to: 1
-
getEnabled
public Boolean getEnabled()
- See Also:
setEnabled(Boolean)
-
setEnabled
public void setEnabled(Boolean enabled)
Enable the scrollbar on the Y axis.Defaults to: false
-
getLiveRedraw
public Boolean getLiveRedraw()
- See Also:
setLiveRedraw(Boolean)
-
setLiveRedraw
public void setLiveRedraw(Boolean liveRedraw)
Whether to redraw the main chart as the scrollbar or the navigator zoomed window is moved. Defaults totruefor modern browsers andfalsefor legacy IE browsers as well as mobile devices.
-
getMargin
public Number getMargin()
- See Also:
setMargin(Number)
-
setMargin
public void setMargin(Number margin)
Pixel margin between the scrollbar and the axis elements.Defaults to: 10
-
getMinWidth
public Number getMinWidth()
- See Also:
setMinWidth(Number)
-
setMinWidth
public void setMinWidth(Number minWidth)
The minimum width of the scrollbar.Defaults to: 6
-
getRifleColor
public Color getRifleColor()
- See Also:
setRifleColor(Color)
-
setRifleColor
public void setRifleColor(Color rifleColor)
The color of the small rifles in the middle of the scrollbar.Defaults to: #333333
-
getShowFull
public Boolean getShowFull()
- See Also:
setShowFull(Boolean)
-
setShowFull
public void setShowFull(Boolean showFull)
Whether to show the scrollbar when it is fully zoomed out at max range. Setting it tofalseon the Y axis makes the scrollbar stay hidden until the user zooms in, like common in browsers.Defaults to: true
-
getSize
public Number getSize()
- See Also:
setSize(Number)
-
setSize
public void setSize(Number size)
The width of a vertical scrollbar or height of a horizontal scrollbar. Defaults to 20 on touch devices.Defaults to: 14
-
getTrackBackgroundColor
public Color getTrackBackgroundColor()
- See Also:
setTrackBackgroundColor(Color)
-
setTrackBackgroundColor
public void setTrackBackgroundColor(Color trackBackgroundColor)
The color of the track background.Defaults to: #f2f2f2
-
getTrackBorderColor
public Color getTrackBorderColor()
- See Also:
setTrackBorderColor(Color)
-
setTrackBorderColor
public void setTrackBorderColor(Color trackBorderColor)
The color of the border of the scrollbar track.Defaults to: #f2f2f2
-
getTrackBorderRadius
public Number getTrackBorderRadius()
- See Also:
setTrackBorderRadius(Number)
-
setTrackBorderRadius
public void setTrackBorderRadius(Number trackBorderRadius)
The corner radius of the border of the scrollbar track.Defaults to: 0
-
getZIndex
public Number getZIndex()
- See Also:
setZIndex(Number)
-
setZIndex
public void setZIndex(Number zIndex)
Z index of the scrollbar elements.Defaults to: 3
-
getHeight
public Number getHeight()
- See Also:
setHeight(Number)
-
setHeight
public void setHeight(Number height)
The height of the scrollbar. The height also applies to the width of the scroll arrows so that they are always squares. Defaults to 20 for touch devices and 14 for mouse devices.
-
-