AnyChart
API Reference
Still have questions?
Contact support
Top

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.
stroke()Stroke settings.
Interactivity
autoHide()Auto hide
enabled()Thumbs state (enabled or disabled).
hovered()Hovered state settings.
normal()Normal state settings.

Methods Description

autoHide

Getter for the auto hide.

Returns:

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

Params:

NameTypeDefaultDescription
enabledboolean
false
Boolean value.

Returns:

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

enabled

Getter for the thumbs state (enabled or disabled)

Returns:

boolean - Thumbs state.
Setter for the thumbs state. Whether the thumbs should be drawn.

Params:

NameTypeDescription
enabledbooleanEnabled state to set.

Returns:

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

fill

Getter for thumbs fill color.

Returns:

anychart.graphics.vector.Fill - Fill color.
Setter for thumbs fill settings using an array, an object or a string. Learn more about coloring.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)>
'#f7f7f7'
Color as an array, an object 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.

hovered

Getter for hovered state settings.

Returns:

anychart.core.StateSettings - Hovered state settings
Setter for hovered state settings.

Params:

NameTypeDescription
settingsObjectState settings to set.

Returns:

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

normal

Getter for normal state settings.

Returns:

anychart.core.StateSettings - Normal state settings.
Setter for normal state settings.

Params:

NameTypeDescription
settingsObjectState settings to set.

Returns:

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

stroke

Getter for thumbs stroke settings.

Returns:

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

Params:

NameTypeDefaultDescription
coloranychart.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.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.core.ui.Scroller.Thumbs - Self instance for method chaining.
Setter for stroke using an object.

Params:

NameTypeDescription
settingsObjectStroke settings from anychart.graphics.vector.Stroke.

Returns:

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