class anychart.core.ui.Scroller Improve this Doc
Extends: anychart.core.VisualBase
Scroller ui element
Methods Overview
| Specific settings | |
| allowRangeChange() | Mode of the range changing. |
| 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 | |
| height() | Scroller height. |
| maxHeight() | Scroller maximum height. |
| minHeight() | Scroller minimum height. |
| orientation() | Scroller orientation. |
| zIndex() | Z-index of the element. |
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.
Detailed description
If the scroller should be automatically hidden if it cannot be
changed (allowRangeChange(false)) and shows the full range (startRatio(0), endRatio(1)).
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean | false | Value to set. |
Returns:
anychart.core.ui.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.ui.Scroller - Self instance for method chaining. Example.
if (!element.enabled()) element.enabled(true);
Try it:
fill
Getter for current scroller fill.
Detailed description
This method can be used as getter only if the value has been previously set.
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.
Detailed description
Used to fill the background of selected part of the scroller.
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.Try it:
Scroller fill color with opacity.
Detailed description
Used to fill the background of selected part of the scroller.
Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which
means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 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.
Detailed description
Used to fill the background of selected part of the scroller.
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.
Detailed description
Used to fill the background of selected part of the scroller.
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.
Detailed description
Used to fill the background of selected part of the scroller.
Params:
| Name | Type | Description |
|---|---|---|
| imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.core.ui.Scroller - Self instance for method chaining.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.
Detailed description
The listener can be added to an object once, and if it is added one more time, its key will be returned.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.
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.
Detailed description
After the event is called, its handler will be deleted.
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).
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:
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.
Detailed description
This method can be used as getter only if the value has been previously set.
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.
Detailed description
Used to fill the background of selected part of the scroller.
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.Try it:
Scroller fill color in selected mode with opacity.
Detailed description
Used to fill the background of selected part of the scroller.
Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which
means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 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.
Detailed description
Used to fill the background of selected part of the scroller.
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.
Detailed description
Used to fill the background of selected part of the scroller.
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.
Detailed description
Used to fill the background of selected part of the scroller.
Params:
| Name | Type | Description |
|---|---|---|
| imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.core.ui.Scroller - Self instance for method chaining.Try it:
thumbs
Setter for the thumbs settings.
Detailed description
Sets thumbs settings depending on parameter type:
- null/boolean - disable or enable thumbs.
- object - sets 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.
Detailed description
The bigger the index - the higher the element position is.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | 0 | Value to set. |
Returns:
anychart.core.ui.Scroller - Self instance for method chaining.Try it: