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

backgroundFill()Since version 7.12.0

Getter for the background fill.

Returns:

anychart.graphics.vector.Fill | string - The background fill.

backgroundFill(fillOrColorOrKeys, opacityOrAngleOrCx, modeOrCy, opacityOrMode, opacity, fx, fy)Since version 7.12.0

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.

Try it:

backgroundStroke

backgroundStroke()Since version 7.12.0

Getter for the background stroke.

Returns:

anychart.graphics.vector.Stroke | string - The background stroke.

See listing

var currentStroke = scrollBar.backgroundStroke();

backgroundStroke(stroke, thickness, dashpattern, lineJoin, lineCap)Since version 7.12.0

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:

Usage sample

barSize

barSize()Since version 7.12.0

Getter for the bar size.

Returns:

number - Bar size settings.

See listing

var currentBarSize = scrollBar.barSize();

barSize(value)Since version 7.12.0

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:

Usage sample

bottom

bottom()

Getter for element bottom bound setting.

Returns:

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

bottom(value)

Sets element bottom bound setting.

Params:

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

Returns:

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

Try it:

Usage sample

bounds

bounds()

Getter for the element bounds settings.

Returns:

anychart.core.utils.Bounds - Current bounds of the element.

bounds(value)

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.ui.ScrollBar - Self instance for method chaining.

Try it:

Usage sample

bounds(x, y, width, height)

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.ui.ScrollBar - Self instance for method chaining.

Try it:

Usage sample

buttonsVisible

buttonsVisible()Since version 7.12.0

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

Returns:

boolean - Flag.

See listing

var currentFlag = scrollBar.buttonsVisible();

buttonsVisible(value)Since version 7.12.0

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:

Usage sample

enabled

enabled()

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

Returns:

boolean - The current element state.

Try it:

Usage sample

Name	Type	Default	Description
value	boolean	true	Value to set.

getPixelBounds

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

height()

Getter for element height setting.

Returns:

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

height(value)

Sets element height setting.

Params:

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

Returns:

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

Try it:

Usage sample

left

left()

Getter for element left bound setting.

Returns:

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

left(value)

Sets element left bound setting.

Params:

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

Returns:

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

Try it:

Usage sample

listen

listen(type, listener, useCapture, listenerScope)

Adds an event listener to an implementing object.

Detailed description

The listener can be added to an object once, and if it is added one more time, its key will be returned.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.

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:

Usage sample

listenOnce

listenOnce(type, listener, useCapture, listenerScope)

Adds an event listener to an implementing object.

Detailed description

After the event is called, its handler will be deleted.
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).

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:

Usage sample

maxHeight

maxHeight()

Getter for maximum height.

Returns:

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

maxHeight(value)

Setter for maximum height.

Params:

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

Returns:

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

Try it:

Usage sample

maxWidth

maxWidth()

Getter for maximum width.

Returns:

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

maxWidth(value)

Setter for maximum width.

Params:

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

Returns:

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

Try it:

Usage sample

minHeight

minHeight()

Getter for minimum height.

Returns:

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

minHeight(value)

Setter for minimum height.

Detailed description

The method sets a minimum height of elements, that will be to remain after a resize of element.

Params:

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

Returns:

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

Try it:

Usage sample

minWidth

minWidth()

Getter for minimum width.

Returns:

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

minWidth(value)

Setter for minimum width.

Detailed description

The method sets a minimum width of elements, that will be to remain after a resize of element.

Params:

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

Returns:

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

Try it:

Usage sample

mouseOutOpacity

mouseOutOpacity()Since version 7.12.0

Getter for the mouse out opacity.

Returns:

number - The mouse out opacity.

See listing

var currentOpacity = scrollBar.mouseOutOpacity();

mouseOutOpacity(value)Since version 7.12.0

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:

Usage sample

mouseOverOpacity

mouseOverOpacity()Since version 7.12.0

Getter for the mouse over opacity.

Returns:

number - The mouse over opacity.

See listing

var currentOpacity = scrollBar.mouseOverOpacity();

mouseOverOpacity(value)Since version 7.12.0

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:

Usage sample

print

print(paperSizeOrOptions, landscape)

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:

Usage sample

removeAllListeners

removeAllListeners(type)

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:

Usage sample

right

right()

Getter for element right bound setting.

Returns:

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

right(value)

Sets element right bound setting.

Params:

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

Returns:

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

Try it:

Usage sample

sliderFill

sliderFill()Since version 7.12.0

Getter for the slider fill.

Returns:

anychart.graphics.vector.Fill | string - The slider fill.

See listing

var currentFill = scrollBar.sliderFill();

sliderFill(fillOrColorOrKeys, opacityOrAngleOrCx, modeOrCy, opacityOrMode, opacity, fx, fy)Since version 7.12.0

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.

Try it:

sliderStroke

sliderStroke()Since version 7.12.0

Getter for the slider stroke.

Returns:

anychart.graphics.vector.Stroke | string - The slider stroke.

See listing

var currentStroke = scrollBar.sliderStroke();

sliderStroke(stroke, thickness, dashpattern, lineJoin, lineCap)Since version 7.12.0

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:

Usage sample

top

top()

Getter for element top bound setting.

Returns:

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

top(value)

Sets element top bound setting.

Params:

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

Returns:

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

Try it:

Usage sample

unlisten

unlisten(type, listener, useCapture, listenerScope)

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.