AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.core.ui.ChartScroller Improve this Doc

Extends: anychart.core.ui.Scroller

Chart scroller class that also exposes position method that is used by chart.

Methods Overview

Specific settings
allowRangeChange()Mode of the range changing.
thumbs()Thumbs settings.
Coloring
fill()Fill settings.
outlineStroke()Stroke settings.
selectedFill()Select 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
height()Scroller height.
inverted()Inverted settings.
maxHeight()Scroller maximum height.
minHeight()Scroller minimum height.
orientation()Scroller orientation.
position()Scroller position.
zIndex()Z-index of the element.

Methods Description

allowRangeChange

Getter for the mode of the range changing.

Returns:

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

Params:

NameTypeDefaultDescription
enabledboolean
true
Enabled state to set.

Returns:

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

autoHide

Getter for scroller auto hide mode.

Returns:

boolean - Auto hide mode.
See listing
var scroller = chart.xScroller();
var state = scroller.autoHide();
Setter for scroller auto hide mode.

Params:

NameTypeDefaultDescription
enabledboolean
false
Enabled state to set.

Returns:

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

enabled

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.
Setter for the element enabled state.

Params:

NameTypeDefaultDescription
enabledboolean
true
Enabled state to set.

Returns:

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

fill

Getter for the scroller fill.

Returns:

anychart.graphics.vector.Fill - Fill color.
Setter for scroller 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)>
'#fff'
Color as an array, an object or a string.

Returns:

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

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

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

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

height

Getter for the scroller height.

Returns:

number | string - Scroller height.
Setter for the scroller height.

Params:

NameTypeDefaultDescription
heightnumber | string
40
Scroller height to set.

Returns:

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

inverted

Getter for the scroller inversion.

Returns:

boolean - Inverted state.
Setter for the scroller inversion.

Params:

NameTypeDefaultDescription
enabledboolean
false
Whether scroller should be inverted or not.

Returns:

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

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
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
}
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

maxHeight

Getter for the scroller maximum height.

Returns:

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

Params:

NameTypeDescription
heightnumber | string | nullMaximum height

Returns:

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

minHeight

Setter for the scroller minimum height.

Returns:

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

Params:

NameTypeDescription
heightnumber | string | nullMinimum height.

Returns:

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

orientation

Getter for the scroller orientation.

Returns:

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

Params:

NameTypeDefaultDescription
orientationanychart.enums.Orientation | string
'bottom'
Scroller orientation.

Returns:

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

outlineStroke

Getter for outline stroke settings.

Returns:

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

Params:

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

Returns:

anychart.core.ui.ChartScroller - Self instance for method chaining.
Setter for outline stroke using an object.

Params:

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

Returns:

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

position

Getter for the scroller position.

Returns:

anychart.enums.ChartScrollerPosition | string - Scroller position.
Setter for the scroller position.

Params:

NameTypeDefaultDescription
positionanychart.enums.ChartScrollerPosition | string
'afterAxis'
Position to set.

Returns:

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

print

Prints all elements on related stage.

Params:

NameTypeDefaultDescription
paperSizeOrOptionsanychart.graphics.vector.PaperSize | Object
Paper size or object with options.
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 scroller fill in selected mode.

Returns:

anychart.graphics.vector.Fill - Select fill color.
Setter for scroller fill settings in selected mode using an array or a string. Learn more about coloring.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)>
{color: "#1976d2", opacity: 0.2}
Color as an array, an object or a string.

Returns:

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

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.ui.ChartScroller - 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.core.ui.ChartScroller - 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.core.ui.ChartScroller - Self instance for method chaining.
Image fill in selected mode. Learn more about coloring.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

thumbs

Getter for the thumbs.

Returns:

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

Params:

NameTypeDefaultDescription
settingsboolean | Object | null
null
Thumbs settings.

Returns:

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

unlisten

Removes a listener added using listen() or listenOnce() methods.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object):boolean|undefined
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object 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 Z-index of the element.

Returns:

number - Z-index.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
zIndexnumber
0
Value to set.

Returns:

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