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

backgroundFill()Since version 7.12.0

Getter for the background fill.

Returns:

anychart.graphics.vector.Fill | string - Background fill settings.

backgroundFill(color)Since version 7.12.0

Setter for background fill settings using an array, an object or a string. Learn more about coloring.

Params:

Name	Type	Description
color	anychart.graphics.vector.Fill \| Array.<(anychart.graphics.vector.GradientKey\|string)>	Color as an array, an object or string.

Returns:

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

Try it:

backgroundFill(color, opacity)Since version 7.12.0

Background fill color with opacity.

Detailed description

Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 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:

Using opacity

backgroundFill(keys, angle, mode, opacity)Since version 7.12.0

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.

backgroundFill(keys, cx, cy, mode, opacity, fx, fy)Since version 7.12.0

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.

backgroundFill(imageSettings)Since version 7.12.0

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

backgroundStroke()Since version 7.12.0

Getter for the background stroke.

Returns:

anychart.graphics.vector.Stroke | string - Background stroke settings.

See listing

var stroke = scrollBar.backgroundStroke();

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

Setter for the background stroke.

Params:

Name	Type	Description
color	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:

Usage sample

barSize

barSize()Since version 7.12.0

Getter for the bar size.

Returns:

number - Bar size.

See listing

var barSize = scrollBar.barSize();

barSize(size)Since version 7.12.0

Setter for the bar size.

Params:

Name	Type	Default	Description
size	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 settings.

Returns:

number | string | undefined - Element's bottom bound setting.

bottom(bottom)

Setter for element bottom bound settings.

Params:

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

Returns:

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

Try it:

Usage sample

bounds

bounds()

Getter for element bounds settings.

Returns:

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

bounds(bounds)

Setter for bounds of the element using one parameter.

Params:

Name	Type	Description
bounds	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 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 - ButtonsVisible Flag.

See listing

var buttonsVisible = scrollBar.buttonsVisible();

buttonsVisible(enabled)Since version 7.12.0

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

Params:

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

Returns:

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

Try it:

Usage sample

cornersRadius

cornersRadius()Since version 7.14.0

Getter for corners radius.

Returns:

number - Scrollbar corners radius.

See listing

var cornersRadius = scrollBar.cornersRadius()

cornersRadius(radius)Since version 7.14.0

Setter for corners radius.
Note: corners radius can't exceed the half of the smallest scroll bar side.

Params:

Name	Type	Description
radius	number	Corners radius to set.

Returns:

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

Try it:

Usage sample

enabled

enabled()

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.

Try it:

Usage sample

enabled(enabled)

Setter for the element enabled state.

Params:

Name	Type	Default	Description
enabled	boolean	true	Enabled state to set.

Returns:

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

Example.

if (!element.enabled())
   element.enabled(true);

Try it:

Usage sample

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

Returns:

number | string | undefined - Element's height setting.

height(height)

Setter for element height setting.

Params:

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

Returns:

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

Try it:

Usage sample

left

left()

Getter for element left bound settings.

Returns:

number | string | undefined - Element's left bound setting.

left(left)

Setter for element left bound settings.

Params:

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

Returns:

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

Try it:

Usage sample

maxHeight

maxHeight()

Getter for the maximum height.

Returns:

number | string | null - Element's maximum height.

maxHeight(height)

Setter for the maximum height.

Params:

Name	Type	Default	Description
height	number \| string \| null	null	Maximum height to set.

Returns:

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

Try it:

Usage sample

maxWidth

maxWidth()

Getter for the maximum width.

Returns:

number | string | null - Element's maximum width.

maxWidth(width)

Setter for the maximum width.

Params:

Name	Type	Default	Description
width	number \| string \| null	null	Maximum width to set.

Returns:

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

Try it:

Usage sample

minHeight

minHeight()

Getter for the minimum height.

Returns:

number | string | null - Element's minimum height.

minHeight(height)

Setter for the 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
height	number \| string \| null	null	Minimum height to set.

Returns:

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

Try it:

Usage sample

minWidth

minWidth()

Getter for the minimum width.

Returns:

number | string | null - Element's minimum width.

minWidth(width)

Setter for the 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
width	number \| string \| null	null	Minimum width 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 mouseOutOpacity = scrollBar.mouseOutOpacity();

mouseOutOpacity(opacity)Since version 7.12.0

Setter for the mouse out opacity.

Params:

Name	Type	Default	Description
opacity	number	0.25	Opacity 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 mouseOverOpacity = scrollBar.mouseOverOpacity();

mouseOverOpacity(opacity)Since version 7.12.0

Setter for the mouse over opacity.

Params:

Name	Type	Description
opacity	number	Opacity to set.

Returns:

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

Try it:

Usage sample

right

right()

Getter for element right bound settings.

Returns:

number | string | undefined - Element's right bound setting.

right(right)

Setter for element right bound setting.

Params:

Name	Type	Default	Description
right	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 - Slider fill settings.

See listing

var sliderFill = scrollBar.sliderFill();

sliderFill(color)Since version 7.12.0

Setter for slider fill settings using an array, an object or a string. Learn more about coloring.

Params:

Name	Type	Description
color	anychart.graphics.vector.Fill \| Array.<(anychart.graphics.vector.GradientKey\|string)>	Color as an array, an object or string.

Returns:

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

Try it:

sliderFill(color, opacity)Since version 7.12.0

Slider fill color with opacity.

Detailed description

Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 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:

Using opacity

sliderFill(keys, angle, mode, opacity)Since version 7.12.0

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.

sliderFill(keys, cx, cy, mode, opacity, fx, fy)Since version 7.12.0

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.

sliderFill(imageSettings)Since version 7.12.0

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

sliderStroke()Since version 7.12.0

Getter for the slider stroke.

Returns:

anychart.graphics.vector.Stroke | string - Slider stroke settings.

See listing

var sliderStroke = scrollBar.sliderStroke();

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

Setter for the slider stroke.

Params:

Name	Type	Description
color	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.