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

class anychart.standalones.Scroller Improve this Doc

Extends: anychart.core.ui.Scroller

Scroller standalone class.

Methods Overview

Specific settings
allowRangeChange()Mode of the range changing.
endRatio()Ending ratio.
setRange()Sets range.
startRatio()Starting ratio.
thumbs()Thumbs settings.
Coloring
fill()Fill settings.
outlineStroke()Stroke settings.
selectedFill()Fill 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
autoHide()Auto hide setting.
enabled()Element state (enabled or disabled).
Size and Position
getRemainingBounds()Returns the remaining (after scroller placement) part of the container.
height()Scroller height.
maxHeight()Scroller maximum height.
minHeight()Scroller minimum height.
orientation()Scroller orientation.
parentBounds()Parent bounds settings.
zIndex()Z-index of the element.
Miscellaneous
container()Getter for the scroller current container.
draw()Draws scroller.

Methods Description

allowRangeChange

Getter for mode of the range changing.

Returns:

boolean - The current mode of the range changing.
See listing
var scroller = chart.xScroller();
currentScroller.allowRangeChange();
Setter for mode of the range changing. If the range changing is allowed.

Params:

NameTypeDefaultDescription
valueboolean
true
Value to set.

Returns:

anychart.standalones.Scroller - Self instance for method chaining.

autoHide

Getter for scroller auto hide setting.

Returns:

boolean - The current value.
See listing
var currentScroller = chart.xScroller();
currentScroller.autoHide();
Setter for scroller auto hide setting.

Params:

NameTypeDefaultDescription
valueboolean
false
Value to set.

Returns:

anychart.standalones.Scroller - Self instance for method chaining.

container

Getter for the scroller current container.

Returns:

string | Element - The current container.
Setter for the scroller container.

Params:

NameTypeDescription
valuestring | ElementThe value to set.

Returns:

anychart.standalones.Scroller - Self instance for method chaining.

draw

Draws scroller.

Returns:

anychart.standalones.Scroller - 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.standalones.Scroller - Self instance for method chaining.
Example.
if (!element.enabled())
   element.enabled(true);

endRatio

Getter for the current ending ratio.

Returns:

number - The current ending ratio.
Setter for the ending ratio. Note: It is always greater than the startRatio.

Params:

NameTypeDefaultDescription
valuenumber
1
Value to set.

Returns:

anychart.standalones.Scroller - Self instance for method chaining.

fill

Getter for current scroller fill.

Returns:

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

Params:

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

Returns:

anychart.standalones.Scroller - Self instance for method chaining.
Scroller fill color with opacity.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.standalones.Scroller - 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.standalones.Scroller - 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.standalones.Scroller - Self instance for method chaining.
Image fill. Learn more about coloring.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

anychart.standalones.Scroller - Self instance for method chaining.

getRemainingBounds

Returns the remaining (after scroller placement) part of the container.

Returns:

anychart.math.Rect - Parent bounds without the space used by the scroller.

height

Getter for the current scroller height.

Returns:

number | string - The current scroller height.
Setter for the scroller height.

Params:

NameTypeDefaultDescription
valuenumber | string
40
Scroller height

Returns:

anychart.standalones.Scroller - Self instance 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 the current scroller maximum height.

Returns:

number | string | null - The current scroller maximum height.
Setter for the scroller maximum height.

Params:

NameTypeDescription
valuenumber | string | nullMaximum height

Returns:

anychart.standalones.Scroller - Self instance for method chaining.

minHeight

Setter for the current scroller minimum height.

Returns:

number | string | null - The current scroller minimum height.
Setter for the scroller minimum height.

Params:

NameTypeDescription
valuenumber | string | nullMinimum height.

Returns:

anychart.standalones.Scroller - Self instance for method chaining.

orientation

Getter for the current scroller orientation.

Returns:

anychart.enums.Orientation | string - Scroller orientation.
Setter for the scroller orientation.

Params:

NameTypeDefaultDescription
valueanychart.enums.Orientation | string
"bottom"
Scroller orientation.

Returns:

anychart.standalones.Scroller - Self instance for method chaining.

outlineStroke

Getter for the current outline stroke settings.

Returns:

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

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
"#cecece"
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.standalones.Scroller - Self instance for method chaining.

parentBounds

Getter for bounds. As a getter falls back to stage bounds.

Returns:

anychart.math.Rect - Current bounds.
Setter for bounds using single value.

Params:

NameTypeDescription
valueanychart.math.Rect | Object | nullValue to set

Returns:

anychart.standalones.Scroller - Self instance for method chaining.
Setter for bounds using several value.

Params:

NameTypeDescription
leftnumberLeft space.
topnumberTop space.
widthnumberA width for a scroller.
heightnumberA height for a scroller.

Returns:

anychart.standalones.Scroller - Self instance for method chaining.

print

Prints all elements on related stage.

Params:

NameTypeDefaultDescription
paperSizeanychart.graphics.vector.PaperSize
Paper size.
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.

selectedFill

Getter for current scroller fill in selected mode.

Returns:

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

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Fill
{color: "#1976d2", opacity: 0.2}
Color as an array or a string.

Returns:

anychart.standalones.Scroller - Self instance for method chaining.
Scroller fill color in selected mode with opacity.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.standalones.Scroller - Self instance for method chaining.
Linear gradient fill in selected 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.standalones.Scroller - Self instance for method chaining.
Radial gradient fill in selected 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.standalones.Scroller - Self instance for method chaining.
Image fill in selected mode. Learn more about coloring.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

anychart.standalones.Scroller - Self instance for method chaining.

setRange

Changes current selected range to the passed one.

Params:

NameTypeDescription
startRationumberClamped to [0..1].
endRationumberClamped to [0..1].

Returns:

anychart.standalones.Scroller - Self instance for method chaining.

startRatio

Getter for the current starting ratio.

Returns:

number - The current starting ratio.
Setter for the starting ratio. Note: It is always less than the endRatio.

Params:

NameTypeDefaultDescription
valuenumber
0
Value to set.

Returns:

anychart.standalones.Scroller - Self instance for method chaining.

thumbs

Getter for the current thumbs.

Returns:

anychart.core.ui.Scroller.Thumbs - Thumbs instance.
Setter for the thumbs settings.

Params:

NameTypeDefaultDescription
valueboolean | Object | null
null
Thumbs settings.

Returns:

anychart.standalones.Scroller - Self instance 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.

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.standalones.Scroller - Self instance for method chaining.