Top
You are looking at an outdated 7.14.0 version of this document. Switch to the 7.14.3 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:

Name Type Default Description
value boolean
true
Value to set.

Returns:

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

Try it:

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:

Name Type Default Description
value boolean
false
Value to set.

Returns:

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

Try it:

container

Getter for the scroller current container.

Returns:

string Element - The current container.

Try it:

Setter for the scroller container.

Params:

Name Type Description
value string | Element The value to set.

Returns:

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

Try it:

draw

Draws scroller.

Returns:

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

Try it:

enabled

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

Returns:

boolean - The current element state.

Try it:

Setter for the element enabled state.

Params:

Name Type Default Description
value boolean
true
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.
Example.
if (!element.enabled())
   element.enabled(true);

Try it:

endRatio

Getter for the current ending ratio.

Returns:

number - The current ending ratio.

Try it:

Setter for the ending ratio. Note: It is always greater than the startRatio.

Params:

Name Type Default Description
value number
1
Value to set.

Returns:

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

Try it:

fill

Getter for current scroller fill.

Returns:

anychart.graphics.vector.Fill - The current fill color.

Try it:

Sets scroller fill settings using an array or a string. Learn more about coloring.

Params:

Name Type Default Description
value anychart.graphics.vector.Fill
"#fff"
Color as an array or a string.

Returns:

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

Params:

Name Type Description
color string Color as a string.
opacity number Color opacity.

Returns:

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

Try it:

Linear gradient fill. 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.Scroller - Self instance for method chaining.

Try it:

Radial gradient fill. 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.Scroller - Self instance for method chaining.

Try it:

Image fill. Learn more about coloring.

Params:

Name Type Description
imageSettings anychart.graphics.vector.Fill Object with settings.

Returns:

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

Try it:

getRemainingBounds

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

Returns:

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

Try it:

height

Getter for the current scroller height.

Returns:

number string - The current scroller height.

Try it:

Setter for the scroller height.

Params:

Name Type Default Description
value number | string
40
Scroller height

Returns:

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

Try it:

listen

Adds an event listener to an implementing object.

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:

listenOnce

Adds an event listener to an implementing object.

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:

maxHeight

Getter for the current scroller maximum height.

Returns:

number string null - The current scroller maximum height.

Try it:

Setter for the scroller maximum height.

Params:

Name Type Description
value number | string | null Maximum height

Returns:

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

Try it:

minHeight

Setter for the current scroller minimum height.

Returns:

number string null - The current scroller minimum height.

Try it:

Setter for the scroller minimum height.

Params:

Name Type Description
value number | string | null Minimum height.

Returns:

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

Try it:

orientation

Getter for the current scroller orientation.

Returns:

anychart.enums.Orientation string - Scroller orientation.

Try it:

Setter for the scroller orientation.

Params:

Name Type Default Description
value anychart.enums.Orientation | string
"bottom"
Scroller orientation.

Returns:

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

Try it:

outlineStroke

Getter for the current outline stroke settings.

Returns:

anychart.graphics.vector.Stroke - The current stroke settings.

Try it:

Setter for the outline stroke settings. Learn more about stroke settings.

Params:

Name Type Default Description
value anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
"#cecece"
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.Scroller - Self instance for method chaining.

Try it:

parentBounds

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

Returns:

anychart.math.Rect - Current bounds.

Try it:

Setter for bounds using single value.

Params:

Name Type Description
value anychart.math.Rect | Object | null Value to set

Returns:

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

Try it:

Setter for bounds using several value.

Params:

Name Type Description
left number Left space.
top number Top space.
width number A width for a scroller.
height number A height for a scroller.

Returns:

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

Try it:

print

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:

removeAllListeners

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:

selectedFill

Getter for current scroller fill in selected mode.

Returns:

anychart.graphics.vector.Fill - The current fill color.

Try it:

Sets scroller fill settings in selected mode using an array or a string. Learn more about coloring.

Params:

Name Type Default Description
value anychart.graphics.vector.Fill
{color: "#1976d2", opacity: 0.2}
Color as an array or a string.

Returns:

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

Params:

Name Type Description
color string Color as a string.
opacity number Color opacity.

Returns:

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

Try it:

Linear gradient fill in selected mode. 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.Scroller - Self instance for method chaining.

Try it:

Radial gradient fill in selected mode. 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.Scroller - Self instance for method chaining.

Try it:

Image fill in selected mode. Learn more about coloring.

Params:

Name Type Description
imageSettings anychart.graphics.vector.Fill Object with settings.

Returns:

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

Try it:

setRange

Changes current selected range to the passed one.

Params:

Name Type Description
startRatio number Clamped to [0..1].
endRatio number Clamped to [0..1].

Returns:

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

Try it:

startRatio

Getter for the current starting ratio.

Returns:

number - The current starting ratio.

Try it:

Setter for the starting ratio. Note: It is always less than the endRatio.

Params:

Name Type Default Description
value number
0
Value to set.

Returns:

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

Try it:

thumbs

Getter for the current thumbs.

Returns:

anychart.core.ui.Scroller.Thumbs - Thumbs instance.

Try it:

Setter for the thumbs settings.

Params:

Name Type Default Description
value boolean | Object | null
null
Thumbs settings.

Returns:

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

unlisten

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.

Returns:

boolean - Whether any listener was removed.

Try it:

unlistenByKey

Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().

Params:

Name Type Description
key Object The key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

Try it:

zIndex

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.

Try it:

Setter for the Z-index of the element.

Params:

Name Type Default Description
value number
0
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it: