AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.core.ui.ScrollBar Improve this Doc

Extends: anychart.core.VisualBaseWithBounds

Scroll bar.

Methods Overview

Specific settings
buttonsVisible()Enable/disable scroll button
Coloring
backgroundFill()Background fill settings.
backgroundStroke()Background stroke settings.
mouseOutOpacity()The mouse out opacity
mouseOverOpacity()The mouse over opacity
sliderFill()Slider fill settings.
sliderStroke()Slider stroke settings.
Events
listen()Adds an event listener.
listenOnce()Adds a single time event listener.
removeAllListeners()Removes all listeners.
unlisten()Removes the listener.
unlistenByKey()Removes the listener by the key.
Export
print()Prints all elements.
Interactivity
enabled()Element state (enabled or disabled).
Size and Position
barSize()Bar size settings.
bottom()Bottom bound settings.
bounds()Bounds settings.
cornersRadius()Corners radius
getPixelBounds()Returns pixel bounds.
height()Height settings.
left()Left bound settings.
maxHeight()Maximum height.
maxWidth()Maximum width.
minHeight()Minimum height.
minWidth()Minimum width.
right()Right bound settings.
top()Top bound settings.
width()Width settings.
zIndex()Z-index of the element.

Methods Description

backgroundFill

Getter for the background fill.

Returns:

anychart.graphics.vector.Fill string - Background fill settings.
Setter for background fill settings using an array or a string. Learn more about coloring.

Params:

Name Type Description
value anychart.graphics.vector.Fill Color as an array or string.

Returns:

anychart.core.ui.ScrollBar - Self instance for method chaining.
Background fill color with opacity.

Params:

Name Type Description
color string Color as a string.
opacity number Color opacity.

Returns:

anychart.core.ui.ScrollBar - Self instance for method chaining.

Try it:

Linear gradient fill for background. Learn more about coloring.

Params:

Name Type Description
keys Array.<(anychart.graphics.vector.GradientKey|string)> Gradient keys.
angle number Gradient angle.
mode boolean | anychart.graphics.vector.Rect | Object Gradient mode.
opacity number Gradient opacity.

Returns:

anychart.core.ui.ScrollBar - Self instance for method chaining.
Radial gradient fill for background. Learn more about coloring.

Params:

Name Type Description
keys Array.<(anychart.graphics.vector.GradientKey|string)> Color-stop gradient keys.
cx number X ratio of center radial gradient.
cy number Y ratio of center radial gradient.
mode anychart.graphics.math.Rect If defined then userSpaceOnUse mode, else objectBoundingBox.
opacity number Opacity of the gradient.
fx number X ratio of focal point.
fy number Y ratio of focal point.

Returns:

anychart.core.ui.ScrollBar - Self instance for method chaining.
Image fill for background. Learn more about coloring.

Params:

Name Type Description
imageSettings anychart.graphics.vector.Fill Object with settings.

Returns:

anychart.core.ui.ScrollBar - Self instance for method chaining.

backgroundStroke

Getter for the background stroke.

Returns:

anychart.graphics.vector.Stroke string - Background stroke settings.
See listing
var stroke = scrollBar.backgroundStroke();
Setter for the background stroke.

Params:

Name Type Description
stroke anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null Stroke settings.
thickness number Line thickness.
dashpattern string Controls the pattern of dashes and gaps used to stroke paths.
lineJoin string | anychart.graphics.vector.StrokeLineJoin Line join style.
lineCap string | anychart.graphics.vector.StrokeLineCap Line cap style.

Returns:

anychart.core.ui.ScrollBar - Self instance for method chaining.

Try it:

barSize

Getter for the bar size.

Returns:

number - Bar size.
See listing
var barSize = scrollBar.barSize();
Setter for the bar size.

Params:

Name Type Default Description
value number
10
Bar size to set.

Returns:

anychart.core.ui.ScrollBar - Self instance for method chaining.

Try it:

bottom

Getter for element bottom bound settings.

Returns:

number string undefined - Element's bottom bound setting.
Setter for element bottom bound settings.

Params:

Name Type Default Description
value number | string | null
null
Bottom bound settings for the element.

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

bounds

Getter for element bounds settings.

Returns:

anychart.core.utils.Bounds - Bounds of the element.
Setter for bounds of the element using one parameter.

Params:

Name Type Description
value anychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.Bounds Bounds of element.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

Setter for element bounds settings.

Params:

Name Type Default Description
x number | string
null
X-coordinate.
y number | string
null
Y-coordinate.
width number | string
null
Width.
height number | string
null
Height.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

buttonsVisible

Getter for the adding/removing the scroll button from the scroll bar.

Returns:

boolean - ButtonsVisible Flag.
See listing
var buttonsVisible = scrollBar.buttonsVisible();
Setter for the adding/removing the scroll button from the scroll bar.

Params:

Name Type Default Description
value boolean
false
Whether show or hide the scroll buttons.

Returns:

boolean anychart.core.ui.ScrollBar - Self instance for method chaining.

Try it:

cornersRadius

Getter for corners radius.

Returns:

number - Scrollbar corners radius.
See listing
var cornersRadius = scrollBar.cornersRadius()
Setter for corners radius.
Note: corners radius can't exceed the half of the smallest scroll bar side.

Params:

Name Type Description
value number Radius to set.

Returns:

anychart.core.ui.ScrollBar - Self instance for method chaining.

Try it:

enabled

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.

Try it:

Setter for the element enabled state.

Params:

Name Type Default Description
value boolean
true
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.
Example.
if (!element.enabled())
   element.enabled(true);

Try it:

getPixelBounds

Returns pixel bounds of the element due to parent bounds and self bounds settings.

Returns:

anychart.math.Rect - Pixel bounds of the element.

height

Getter for element height settings.

Returns:

number string undefined - Element's height setting.
Setter for element height setting.

Params:

Name Type Default Description
value number | string | null
null
Height settings for the element.

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

left

Getter for element left bound settings.

Returns:

number string undefined - Element's left bound setting.
Setter for element left bound settings.

Params:

Name Type Default Description
value number | string | null
null
Left bound setting for the element.

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

listen

Adds an event listener to an implementing object.

Params:

Name Type Default Description
type string
The event type id.
listener function(Object e)
Callback method. Function that looks like function(event){ // event.actualTarget - actual event target // event.currentTarget - current event target // event.iterator - event iterator // event.originalEvent - original event // event.point - event point // event.pointIndex - event point index }.
useCapture boolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope Object
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

listenOnce

Adds an event listener to an implementing object.

Params:

Name Type Default Description
type string
The event type id.
listener function(Object e)
Callback method.
useCapture boolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope Object
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

maxHeight

Getter for the maximum height.

Returns:

number string null - Element's maximum height.
Setter for the maximum height.

Params:

Name Type Default Description
value number | string | null
null
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

maxWidth

Getter for the maximum width.

Returns:

number string null - Element's maximum width.
Setter for the maximum width.

Params:

Name Type Default Description
value number | string | null
null
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

minHeight

Getter for the minimum height.

Returns:

number string null - Element's minimum height.
Setter for the minimum height.

Params:

Name Type Default Description
value number | string | null
null
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

minWidth

Getter for the minimum width.

Returns:

number string null - Element's minimum width.
Setter for the minimum width.

Params:

Name Type Default Description
value number | string | null
null
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

mouseOutOpacity

Getter for the mouse out opacity.

Returns:

number - The mouse out opacity.
See listing
var mouseOutOpacity = scrollBar.mouseOutOpacity();
Setter for the mouse out opacity.

Params:

Name Type Default Description
value number
0.25
Value to set.

Returns:

anychart.core.ui.ScrollBar - Self instance for method chaining.

Try it:

mouseOverOpacity

Getter for the mouse over opacity.

Returns:

number - The mouse over opacity.
See listing
var mouseOverOpacity = scrollBar.mouseOverOpacity();
Setter for the mouse over opacity.

Params:

Name Type Description
value number Value to set.

Returns:

anychart.core.ui.ScrollBar - Self instance for method chaining.

Try it:

print

Prints all elements on related stage.

Params:

Name Type Default Description
paperSizeOrOptions anychart.graphics.vector.PaperSize | Object
Paper size or object with options.
landscape boolean
false
Flag of landscape.

Try it:

removeAllListeners

Removes all listeners from an object. You can also optionally remove listeners of some particular type.

Params:

Name Type Description
type string Type of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

Try it:

Getter for element right bound settings.

Returns:

number string undefined - Element's right bound setting.
Setter for element right bound setting.

Params:

Name Type Default Description
value number | string | null
null
Right bound setting for the element.

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

sliderFill

Getter for the slider fill.

Returns:

anychart.graphics.vector.Fill string - Slider fill settings.
See listing
var sliderFill = scrollBar.sliderFill();
Setter for slider fill settings using an array or a string. Learn more about coloring.

Params:

Name Type Description
value anychart.graphics.vector.Fill Color as an array or string.

Returns:

anychart.core.ui.ScrollBar - Self instance for method chaining.
Slider fill color with opacity.

Params:

Name Type Description
color string Color as a string.
opacity number Color opacity.

Returns:

anychart.core.ui.ScrollBar - Self instance for method chaining.

Try it:

Linear gradient fill for slider. Learn more about coloring.

Params:

Name Type Description
keys Array.<(anychart.graphics.vector.GradientKey|string)> Gradient keys.
angle number Gradient angle.
mode boolean | anychart.graphics.vector.Rect | Object Gradient mode.
opacity number Gradient opacity.

Returns:

anychart.core.ui.ScrollBar - Self instance for method chaining.
Radial gradient fill for slider. Learn more about coloring.

Params:

Name Type Description
keys Array.<(anychart.graphics.vector.GradientKey|string)> Color-stop gradient keys.
cx number X ratio of center radial gradient.
cy number Y ratio of center radial gradient.
mode anychart.graphics.math.Rect If defined then userSpaceOnUse mode, else objectBoundingBox.
opacity number Opacity of the gradient.
fx number X ratio of focal point.
fy number Y ratio of focal point.

Returns:

anychart.core.ui.ScrollBar - Self instance for method chaining.
Image fill for slider. Learn more about coloring.

Params:

Name Type Description
imageSettings anychart.graphics.vector.Fill Object with settings.

Returns:

anychart.core.ui.ScrollBar - Self instance for method chaining.

sliderStroke

Getter for the slider stroke.

Returns:

anychart.graphics.vector.Stroke string - Slider stroke settings.
See listing
var sliderStroke = scrollBar.sliderStroke();
Setter for the slider stroke.

Params:

Name Type Description
stroke anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null Stroke settings.
thickness number Line thickness.
dashpattern string Controls the pattern of dashes and gaps used to stroke paths.
lineJoin string | anychart.graphics.vector.StrokeLineJoin Line join style.
lineCap string | anychart.graphics.vector.StrokeLineCap Line cap style.

Returns:

anychart.core.ui.ScrollBar - Self instance for method chaining.

Try it:

top

Getter for element top bound settings.

Returns:

number string undefined - Element's top bound setting.
Setter for element top bound settings.

Params:

Name Type Default Description
value number | string | null
null
Top bound setting for the element.

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

unlisten

Removes a listener added using listen() or listenOnce() methods.

Params:

Name Type Default Description
type string
The event type id.
listener function
Callback method.
useCapture boolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope Object
Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

Try it:

unlistenByKey

Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().

Params:

Name Type Description
key Object The key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

Try it:

width

Getter for element width settings.

Returns:

number string undefined - Element's width setting.
Setter for element width setting.

Params:

Name Type Default Description
value number | string | null
null
Width settings for the element.

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

zIndex

Getter for the Z-index of the element.

Returns:

number - Z-index.

Try it:

Setter for the Z-index of the element.

Params:

Name Type Default Description
value number
0
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it: