Top
You are looking at an outdated 7.14.0 version of this document. Switch to the 8.0.1 version to see the up to date information.

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 setting.
bounds()Bounds settings.
getPixelBounds()Returns pixel bounds.
height()Height setting.
left()Left bound setting.
maxHeight()Maximum height.
maxWidth()Maximum width.
minHeight()Minimum height.
minWidth()Minimum width.
right()Right bound setting.
top()Top bound setting.
width()Width setting.
zIndex()Z-index of the element.

Methods Description

backgroundFill

Getter for the background fill.

Returns:

anychart.graphics.vector.Fill string - The background fill.
Setter for the background fill.

Params:

Name Type Description
fillOrColorOrKeys anychart.graphics.vector.Fill | !Array.<(anychart.graphics.vector.GradientKey|string)> | null Fill, color or gradient keys.
opacityOrAngleOrCx number Fill opacity, gradient angle, or X ratio of center radial gradient.
modeOrCy number | boolean | anychart.math.Rect | Object Gradient mode or Y ratio of center radial gradient.
opacityOrMode number | anychart.math.Rect | Object | null Gradient opacity or mode.
opacity number Gradient opacity.
fx number X ratio of focal point.
fy number Y ratio of focal point.

Returns:

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

backgroundStroke

Getter for the background stroke.

Returns:

anychart.graphics.vector.Stroke string - The background stroke.
See listing
var currentStroke = 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 anychart.graphics.vector.StrokeLineJoin Line join style.
lineCap 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 settings.
See listing
var currentBarSize = 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 setting.

Returns:

number string undefined - Current element's bottom bound setting.
Sets element bottom bound setting.

Params:

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

Returns:

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

Try it:

bounds

Getter for the element bounds settings.

Returns:

anychart.core.utils.Bounds - Current bounds of the element.
Sets 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 the 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 - Flag.
See listing
var currentFlag = 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:

enabled

Getter for the current element state (enabled or disabled).

Returns:

boolean - The current 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 setting.

Returns:

number string undefined - Current element's height setting.
Sets element height setting.

Params:

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

Returns:

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

Try it:

left

Getter for element left bound setting.

Returns:

number string undefined - Current element's left bound setting.
Sets element left bound setting.

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
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
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 maximum height.

Returns:

number string null - Current element's maximum height.
Setter for 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 maximum width.

Returns:

number string null - Current element's maximum width.
Setter for 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 minimum height.

Returns:

number string null - Current element's minimum height.
Setter for 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 minimum width.

Returns:

number string null - Current element's minimum width.
Setter for 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 currentOpacity = 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 currentOpacity = 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 setting.

Returns:

number string undefined - Current element's right bound setting.
Sets 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 - The slider fill.
See listing
var currentFill = scrollBar.sliderFill();
Setter for the slider fill.

Params:

Name Type Description
fillOrColorOrKeys anychart.graphics.vector.Fill | !Array.<(anychart.graphics.vector.GradientKey|string)> | null Fill, color or gradient keys..
opacityOrAngleOrCx number Fill opacity, gradient angle, or X ratio of center radial gradient.
modeOrCy number | boolean | anychart.math.Rect | Object Gradient mode or Y ratio of center radial gradient.
opacityOrMode number | anychart.math.Rect | Object | null Gradient opacity or mode.
opacity number Gradient opacity.
fx number X ratio of focal point.
fy number Y ratio of focal point.

Returns:

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

sliderStroke

Getter for the slider stroke.

Returns:

anychart.graphics.vector.Stroke string - The slider stroke.
See listing
var currentStroke = 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 anychart.graphics.vector.StrokeLineJoin Line join style.
lineCap 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 setting.

Returns:

number string undefined - Current element's top bound setting.
Sets element top bound setting.

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 setting.

Returns:

number string undefined - Current element's width setting.
Sets element width setting.

Params:

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

Returns:

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

Try it:

zIndex

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.

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: