class anychart.standalones.Scroller Improve this Doc
Extends: anychart.core.ui.Scroller
The Scroller class contains methods for configuring standalones scroller.
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() | Select fill settings. |
| 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. |
| inverted() | Inverted settings. |
| maxHeight() | Scroller maximum height. |
| minHeight() | Scroller minimum height. |
| orientation() | Scroller orientation. |
| padding() | Padding settings |
| parentBounds() | Parent bounds settings. |
| zIndex() | Z-index of the element. |
| Miscellaneous | |
| container() | Getter for the scroller container. |
| draw() | Draws scroller. |
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:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | true | Enabled state to set. |
Returns:
anychart.standalones.Scroller - Self instance for method chaining.Try it:
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.
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 |
|---|---|---|---|
| enabled | boolean | false | Enabled state to set. |
Returns:
anychart.standalones.Scroller - Self instance for method chaining.Try it:
container
Getter for the scroller container.
Try it:
Setter for the scroller container.
Params:
| Name | Type | Description |
|---|---|---|
| element | anychart.graphics.vector.Layer | anychart.graphics.vector.Stage | The value to set. |
Returns:
anychart.standalones.Scroller - Self instance for method chaining.Try it:
draw
enabled
Getter for the element state (enabled or disabled).
Returns:
boolean - Element state.Try it:
Setter for the element enabled state.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | true | Enabled state to set. |
Returns:
anychart.standalones.Scroller - Self instance for method chaining. Example.
if (!element.enabled()) element.enabled(true);
Try it:
endRatio
Setter for the end ratio.
Note: It is always greater than the startRatio.
Note: It is always greater than the startRatio.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| ratio | number | 1 | End ratio to set. |
Returns:
anychart.standalones.Scroller - Self instance for method chaining.Try it:
fill
Getter for the scroller fill.
Detailed description
This method can be used as getter only if the value has been previously set.
Returns:
anychart.graphics.vector.Fill - Fill color.Try it:
Setter for scroller fill settings using an array, an object 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 |
|---|---|---|---|
| color | anychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)> | '#fff' | Color as an array, an object or a string. |
Returns:
anychart.standalones.Scroller - Self instance for method chaining.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.standalones.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.standalones.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.standalones.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.standalones.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
Setter for the scroller height.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| height | number | string | 40 | Scroller height to set. |
Returns:
anychart.standalones.Scroller - Self instance for method chaining.Try it:
inverted
Getter for the scroller inversion.
Returns:
boolean - Inverted state.Setter for the scroller inversion.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | false | Whether scroller should be inverted or not. |
Returns:
anychart.standalones.Scroller - Self instance for method chaining.Try it:
maxHeight
Getter for the scroller maximum height.
Returns:
number | string | null - Scroller maximum height.Try it:
Setter for the scroller maximum height.
Params:
| Name | Type | Description |
|---|---|---|
| height | number | string | null | Maximum height |
Returns:
anychart.standalones.Scroller - Self instance for method chaining.Try it:
minHeight
Setter for the scroller minimum height.
Returns:
number | string | null - Scroller minimum height.Try it:
Setter for the scroller minimum height.
Params:
| Name | Type | Description |
|---|---|---|
| height | number | string | null | Minimum height. |
Returns:
anychart.standalones.Scroller - Self instance for method chaining.Try it:
orientation
Getter for the scroller orientation.
Returns:
anychart.enums.Orientation | string - Scroller orientation.Try it:
Setter for the scroller orientation.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| orientation | anychart.enums.Orientation | string | 'bottom' | Scroller orientation. |
Returns:
anychart.standalones.Scroller - Self instance for method chaining.Try it:
outlineStroke
Getter for outline stroke settings.
Returns:
anychart.graphics.vector.Stroke - Stroke settings.Try it:
Setter for outline stroke settings.
Learn more about stroke settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| color | 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 | string | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
| lineCap | string | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.standalones.Scroller - Self instance for method chaining.Try it:
Setter for outline stroke using an object.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | Stroke settings from anychart.graphics.vector.Stroke. |
Returns:
anychart.standalones.Scroller - Self instance for method chaining.Try it:
padding
Getter for the scroller padding.
Detailed description
Also, you can use anychart.core.utils.Padding#bottom, anychart.core.utils.Padding#left,
anychart.core.utils.Padding#right, anychart.core.utils.Padding#top methods to setting paddings.
Returns:
anychart.core.utils.Padding - Scroller padding.Setter for the scroller paddings in pixels using a single value.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| padding | Array.<(number|string)> | Object | {top: 0, right: 0, bottom: 0, left: 0} | Padding to set. |
Returns:
anychart.standalones.Scroller - Self instance for method chaining. Example.
scroller.padding([5, 15]);
or
scroller.padding({left: 10, top: 20, bottom: 30, right: "40%"}});Setter for the scroller paddings in pixels using several numbers.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value1 | string | number | 0 | Top or top-bottom space. |
| value2 | string | number | 0 | Right or right-left space. |
| value3 | string | number | 0 | Bottom space. |
| value4 | string | number | 0 | Left space. |
Returns:
anychart.standalones.Scroller - Self instance for method chaining. Example.
// 1) all 10px chart.padding(10); // 2) top and bottom 10px, left and right 15px chart.padding(10, '15px'); // 3) top 10px, left and right 15px, bottom 5px chart.padding(10, '15px', 5); // 4) top 10px, right 15%, bottom 5px, left 12px chart.padding(10, '15%', '5px', 12);
parentBounds
Getter for parent bounds.
As a getter falls back to stage bounds.
As a getter falls back to stage bounds.
Returns:
anychart.math.Rect - Parent bounds.Try it:
Setter for bounds using single value.
Params:
| Name | Type | Description |
|---|---|---|
| bounds | anychart.math.Rect | Object | null | Parent bounds to set. |
Returns:
anychart.standalones.Scroller - Self instance for method chaining.Try it:
Setter for bounds using several values.
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:
selectedFill
Getter for 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 - Select fill color.Try it:
Setter for 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 |
|---|---|---|---|
| color | anychart.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.standalones.Scroller - Self instance for method chaining.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.standalones.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.standalones.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.standalones.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.standalones.Scroller - Self instance for method chaining.Try it:
setRange
Changes 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
Setter for the starting ratio.
Note: It is always less than the endRatio.
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
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 |
|---|---|---|---|
| settings | boolean | Object | null | null | Thumbs settings. |
Returns:
anychart.standalones.Scroller - Self instance for method chaining.zIndex
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 |
|---|---|---|---|
| zIndex | number | 0 | Value to set. |
Returns:
anychart.standalones.Scroller - Self instance for method chaining.Try it: