AnyChart
API Reference
Still have questions?
Contact support
Top
You are looking at an outdated 7.13.0 version of this document. Switch to the 8.4.0 version to see the up to date information.

class anychart.core.ui.ScrollBar Improve this Doc

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:

NameTypeDescription
fillOrColorOrKeysanychart.graphics.vector.Fill | !Array.<(anychart.graphics.vector.GradientKey|string)> | nullFill, color or gradient keys.
opacityOrAngleOrCxnumberFill opacity, gradient angle, or X ratio of center radial gradient.
modeOrCynumber | boolean | anychart.math.Rect | ObjectGradient mode or Y ratio of center radial gradient.
opacityOrModenumber | anychart.math.Rect | Object | nullGradient opacity or mode.
opacitynumberGradient opacity.
fxnumberX ratio of focal point.
fynumberY 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:

NameTypeDescription
strokeanychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | nullStroke settings.
thicknessnumberLine thickness.
dashpatternstringControls the pattern of dashes and gaps used to stroke paths.
lineJoinanychart.graphics.vector.StrokeLineJoinLine join style.
lineCapanychart.graphics.vector.StrokeLineCapLine cap style.

Returns:

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

barSize

Getter for the bar size.

Returns:

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

Params:

NameTypeDefaultDescription
valuenumber
10
Bar size to set.

Returns:

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

bottom

Getter for element bottom bound setting.

Returns:

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

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Bottom bound setting for the element.

Returns:

anychart.core.ui.ScrollBar - Returns self for method chaining.

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:

NameTypeDescription
valueanychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.BoundsBounds of element.

Returns:

anychart.core.ui.ScrollBar - Self instance for method chaining.
Setter for the element bounds settings.

Params:

NameTypeDefaultDescription
xnumber | string
null
X-coordinate.
ynumber | string
null
Y-coordinate.
widthnumber | string
null
Width.
heightnumber | string
null
Height.

Returns:

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

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:

NameTypeDefaultDescription
valueboolean
false
Whether show or hide the scroll buttons.

Returns:

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

enabled

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

Returns:

boolean - The current element state.
Setter for the element enabled state.

Params:

NameTypeDefaultDescription
valueboolean
true
Value to set.

Returns:

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

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:

NameTypeDefaultDescription
valuenumber | string | null
null
Height setting for the element.

Returns:

anychart.core.ui.ScrollBar - Returns self for method chaining.

left

Getter for element left bound setting.

Returns:

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

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Left bound setting for the element.

Returns:

anychart.core.ui.ScrollBar - Returns self for method chaining.

listen

Adds an event listener to an implementing object.

Params:

NameTypeDescription
typestringThe event type id.
listenerfunctionCallback 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 }.
useCapturebooleanWhether to fire in capture phase (defaults to false).
listenerScopeObjectObject in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDescription
typestringThe event type id.
listenerfunctionCallback method.
useCapturebooleanWhether to fire in capture phase (defaults to false).
listenerScopeObjectObject in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

maxHeight

Getter for maximum height.

Returns:

number | string | null - Current element's maximum height.
Setter for maximum height.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

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

maxWidth

Getter for maximum width.

Returns:

number | string | null - Current element's maximum width.
Setter for maximum width.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

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

minHeight

Getter for minimum height.

Returns:

number | string | null - Current element's minimum height.
Setter for minimum height.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

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

minWidth

Getter for minimum width.

Returns:

number | string | null - Current element's minimum width.
Setter for minimum width.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

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

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:

NameTypeDefaultDescription
valuenumber
0.25
Value to set.

Returns:

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

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:

NameTypeDescription
valuenumberValue to set.

Returns:

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

print

Prints all elements on related stage.

Params:

NameTypeDefaultDescription
paperSizeOrOptionsanychart.graphics.vector.PaperSize | Object
Paper size or object with options.
landscapeboolean
false
Flag of landscape.

removeAllListeners

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

Params:

NameTypeDescription
typestringType of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.
Getter for element right bound setting.

Returns:

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

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Right bound setting for the element.

Returns:

anychart.core.ui.ScrollBar - Returns self for method chaining.

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:

NameTypeDescription
fillOrColorOrKeysanychart.graphics.vector.Fill | !Array.<(anychart.graphics.vector.GradientKey|string)> | nullFill, color or gradient keys..
opacityOrAngleOrCxnumberFill opacity, gradient angle, or X ratio of center radial gradient.
modeOrCynumber | boolean | anychart.math.Rect | ObjectGradient mode or Y ratio of center radial gradient.
opacityOrModenumber | anychart.math.Rect | Object | nullGradient opacity or mode.
opacitynumberGradient opacity.
fxnumberX ratio of focal point.
fynumberY 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:

NameTypeDescription
strokeanychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | nullStroke settings.
thicknessnumberLine thickness.
dashpatternstringControls the pattern of dashes and gaps used to stroke paths.
lineJoinanychart.graphics.vector.StrokeLineJoinLine join style.
lineCapanychart.graphics.vector.StrokeLineCapLine cap style.

Returns:

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

top

Getter for element top bound setting.

Returns:

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

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Top bound setting for the element.

Returns:

anychart.core.ui.ScrollBar - Returns self for method chaining.

unlisten

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

Params:

NameTypeDescription
typestringThe event type id.
listenerfunctionCallback method.
useCapturebooleanWhether to fire in capture phase (defaults to false).
listenerScopeObjectObject in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

unlistenByKey

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

Params:

NameTypeDescription
keyObjectThe key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

width

Getter for element width setting.

Returns:

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

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Width setting for the element.

Returns:

anychart.core.ui.ScrollBar - Returns self for method chaining.

zIndex

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
valuenumber
0
Value to set.

Returns:

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