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

class anychart.core.ui.Scroller.Thumbs Improve this Doc

Thumbs settings. Doesn't draw anything, just contains settings and notifies the scroller about their change.

Methods Overview

Coloring
fill()Fill settings.
hoverFill()Fill settings in hover mode.
hoverStroke()Stroke settings in hover mode.
stroke()Stroke settings.
Interactivity
autoHide()Auto hide
enabled()Thumbs state (enabled or disabled).

Methods Description

autoHide

Getter for the current auto hide.

Returns:

boolean - The current auto hide.
Setter for the auto hide. Whether the thumbs should be hidden on scroller mouse out event.

Params:

NameTypeDefaultDescription
valueboolean
false
Boolean value.

Returns:

anychart.core.ui.Scroller.Thumbs - Self instance for method chaining.

enabled

Getter for the current thumbs state (enabled or disabled)

Returns:

boolean - The current thumbs state.
Getter for the current thumbs state. Whether the thumbs should be drawn.

Params:

NameTypeDescription
valuebooleanValue to set.

Returns:

anychart.core.ui.Scroller.Thumbs - Self instance for method chaining.

fill

Getter for current thumbs fill color.

Returns:

anychart.graphics.vector.Fill - The current fill color.
Sets thumbs fill settings using an array or a string. Learn more about coloring.

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Fill
"#f7f7f7"
Color as an array or a string.

Returns:

anychart.core.ui.Scroller.Thumbs - Self instance for method chaining.
Thumbs fill color with opacity.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.ui.Scroller.Thumbs - Self instance for method chaining.
Linear gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

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

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

anychart.core.ui.Scroller.Thumbs - Self instance for method chaining.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

anychart.core.ui.Scroller.Thumbs - Self instance for method chaining.

hoverFill

Getter for current thumbs fill color in hover mode.

Returns:

anychart.graphics.vector.Fill - The current fill color.
Sets thumbs fill settings in hover mode using an array or a string. Learn more about coloring.

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Fill
"#ffffff"
Color as an object or a string.

Returns:

anychart.core.ui.Scroller.Thumbs - Self instance for method chaining.
Thumbs fill color with opacity in hover mode.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.ui.Scroller.Thumbs - Self instance for method chaining.
Linear gradient fill in hover mode. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.core.ui.Scroller.Thumbs - Self instance for method chaining.
Radial gradient fill in hover mode. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

anychart.core.ui.Scroller.Thumbs - Self instance for method chaining.
Image fill in hover mode. Learn more about coloring.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

anychart.core.ui.Scroller.Thumbs - Self instance for method chaining.

hoverStroke

Getter for the current thumbs stroke settings in hover mode.

Returns:

anychart.graphics.vector.Stroke - The current stroke settings.
Setter for thumbs stroke settings in hover mode. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
"#545f69"
Stroke settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinanychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapanychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.core.ui.Scroller.Thumbs - Self instance for method chaining.

stroke

Getter for the current thumbs stroke settings.

Returns:

anychart.graphics.vector.Stroke - The current stroke settings.
Setter for thumbs stroke settings. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
"#7c868e"
Stroke settings.
thicknessnumber
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinanychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapanychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.core.ui.Scroller.Thumbs - Self instance for method chaining.