class anychart.core.stock.scrollerSeries.RangeArea Improve this Doc
Extends: anychart.core.stock.scrollerSeries.Base
RangeArea Series Class.
Learn more about RangeArea series
Methods Overview
Coloring | |
fill() | Fill settings. |
hatchFill() | Hatch fill settings. |
highStroke() | High stroke settings. |
lowStroke() | Low stroke settings. |
selectFill() | Fill settings in selected mode. |
selectHatchFill() | Hatch fill settings in selected mode. |
selectHighStroke() | High stroke settings in selected mode. |
selectLowStroke() | Low stroke settings in selected mode. |
Data | |
data() | Data 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 | |
enabled() | Element state (enabled or disabled). |
Scales | |
yScale() | Y-scale settings. |
Series | |
rendering() | Rendering settings |
seriesType() | Switch the series type |
Size and Position | |
bottom() | Bottom bound setting. |
bounds() | Bounds settings. |
getPixelBounds() | Returns pixel bounds. |
height() | Height setting. |
left() | Left bound setting. |
maxHeight() | Maximum height. |
maxWidth() | Maximum width. |
minHeight() | Minimum height. |
minWidth() | Minimum width. |
right() | Right bound setting. |
top() | Top bound setting. |
width() | Width setting. |
zIndex() | Z-index of the element. |
Methods Description
bottom
Returns:
number | string | undefined - Current element's bottom bound setting.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Bottom bound setting for the element. |
Returns:
anychart.core.stock.scrollerSeries.RangeArea - Returns self for method chaining.Try it:
bounds
Returns:
anychart.core.utils.Bounds - Current bounds of the element.Params:
Name | Type | Description |
---|---|---|
value | anychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.Bounds | Bounds of element. |
Returns:
anychart.core.stock.scrollerSeries.RangeArea - Self instance for method chaining.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
x | number | string | null | X-coordinate. |
y | number | string | null | Y-coordinate. |
width | number | string | null | Width. |
height | number | string | null | Height. |
Returns:
anychart.core.stock.scrollerSeries.RangeArea - Self instance for method chaining.Try it:
data
Returns:
anychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | string - Returns current mapping.Params:
Name | Type | Description |
---|---|---|
value | anychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | string | Data for the scroller series. |
mappingSettings | Object.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}|number)> | Mapping settings. An object where keys are field names and values are objects with fields: - 'column': number - Column index, that the field should get values from; - 'type': anychart.enums.AggregationType - How to group values for the field. Defaults to 'close'. - 'weights': number - Column to get weights from for 'weightedAverage' grouping type. Note: If type set to 'weightedAverage', but opt_weightsColumn is not passed - uses 'average' grouping instead. or numbers - just the column index to get values from. In this case the grouping type will be set to 'close'. |
csvSettings | Object | CSV parser settings if the string is passed. |
Returns:
anychart.core.stock.scrollerSeries.RangeArea - Self instance for method chaining.Try it:
enabled
Returns:
boolean - The current element state.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | boolean | true | Value to set. |
Returns:
anychart.core.stock.scrollerSeries.RangeArea - Self instance for method chaining.if (!element.enabled()) element.enabled(true);
Try it:
fill
Returns:
anychart.graphics.vector.Fill - The current fill color.Try it:
Params:
Name | Type | Description |
---|---|---|
value | anychart.graphics.vector.Fill | Color as an object or a string. |
Returns:
anychart.core.stock.scrollerSeries.RangeArea - Self instance for method chaining.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
fillFunction | function | function() { return anychart.color.darken(this.sourceColor); } | Function that looks like function(){
// this.index - series index.
// this.sourceColor - color returned by fill() getter.
// this.iterator - series point iterator.
return fillValue; // type anychart.graphics.vector.Fill
} . |
Returns:
anychart.core.stock.scrollerSeries.RangeArea - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
color | string | Color as a string. |
opacity | number | Color opacity. |
Returns:
anychart.core.stock.scrollerSeries.RangeArea - Self instance for method chaining.Try it:
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.stock.scrollerSeries.RangeArea - Self instance for method chaining.Try it:
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.stock.scrollerSeries.RangeArea - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.core.stock.scrollerSeries.RangeArea - Self instance for method chaining.Try it:
getPixelBounds
Returns:
anychart.math.Rect - Pixel bounds of the element.hatchFill
Returns:
anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - The hatch fill.var currentHatchFill = series.hatchFill();
Params:
Name | Type | Default | Description |
---|---|---|---|
patternFillOrType | anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | string | false | PatternFill or HatchFill instance or type of hatch fill. |
color | string | Color. | |
thickness | number | Thickness. | |
size | number | Pattern size. |
Returns:
anychart.core.stock.scrollerSeries.RangeArea - Self instance for method chaining.Try it:
height
Returns:
number | string | undefined - Current element's height setting.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Height setting for the element. |
Returns:
anychart.core.stock.scrollerSeries.RangeArea - Returns self for method chaining.Try it:
highStroke
Returns:
anychart.graphics.vector.Stroke | function - The high stroke settings.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
strokeFunction | function | function() { return anychart.color.darken(this.sourceColor); } | Function that looks like function(){
// this.index - series index.
// this.sourceColor - color returned by fill() getter.
// this.iterator - series point iterator.
return strokeValue; // type anychart.graphics.vector.Stroke or anychart.graphics.vector.ColoredFill
} . |
Returns:
anychart.core.stock.scrollerSeries.RangeArea - Self instance for method chaining.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
color | anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null | Stroke settings. | |
thickness | number | 1 | 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.stock.scrollerSeries.RangeArea - Self instance for method chaining.Try it:
left
Returns:
number | string | undefined - Current element's left bound setting.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Left bound setting for the element. |
Returns:
anychart.core.stock.scrollerSeries.RangeArea - Returns self for method chaining.Try it:
listen
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
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:
lowStroke
Returns:
anychart.graphics.vector.Stroke | function - The low stroke settings.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
strokeFunction | function | function() { return anychart.color.darken(this.sourceColor); } | Function that looks like function(){
// this.index - series index.
// this.sourceColor - color returned by fill() getter.
// this.iterator - series point iterator.
return strokeValue; // type anychart.graphics.vector.Stroke or anychart.graphics.vector.ColoredFill
} . |
Returns:
anychart.core.stock.scrollerSeries.RangeArea - Self instance for method chaining.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
color | anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null | Stroke settings. | |
thickness | number | 1 | 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.stock.scrollerSeries.RangeArea - Self instance for method chaining.Try it:
maxHeight
Returns:
number | string | null - Current element's maximum height.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Value to set. |
Returns:
anychart.core.stock.scrollerSeries.RangeArea - Self instance for method chaining.Try it:
maxWidth
Returns:
number | string | null - Current element's maximum width.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Value to set. |
Returns:
anychart.core.stock.scrollerSeries.RangeArea - Self instance for method chaining.Try it:
minHeight
Returns:
number | string | null - Current element's minimum height.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Value to set. |
Returns:
anychart.core.stock.scrollerSeries.RangeArea - Self instance for method chaining.Try it:
minWidth
Returns:
number | string | null - Current element's minimum width.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Value to set. |
Returns:
anychart.core.stock.scrollerSeries.RangeArea - Self instance for method chaining.Try it:
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
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:
rendering
Returns:
anychart.core.series.RenderingSettings - Rendering settings.Try it:
Params:
Name | Type | Description |
---|---|---|
value | Object | function | Value to set. |
Returns:
anychart.core.stock.scrollerSeries.RangeArea - Self instance for method chaining.Try it:
right
Returns:
number | string | undefined - Current element's right bound setting.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Right bound setting for the element. |
Returns:
anychart.core.stock.scrollerSeries.RangeArea - Returns self for method chaining.Try it:
selectFill
Returns:
anychart.graphics.vector.Fill - The fill color.Try it:
Params:
Name | Type | Description |
---|---|---|
value | anychart.graphics.vector.Fill | Color as an object or a string. |
Returns:
anychart.core.stock.scrollerSeries.RangeArea - Self instance for method chaining.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
fillFunction | function | function() { return anychart.color.darken(this.sourceColor); } | Function that looks like function(){
// this.index - series index.
// this.sourceColor - color returned by fill() getter.
// this.iterator - series point iterator.
return fillValue; // type anychart.graphics.vector.Fill
} . |
Returns:
anychart.core.stock.scrollerSeries.RangeArea - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
color | string | Color as a string. |
opacity | number | Color opacity. |
Returns:
anychart.core.stock.scrollerSeries.RangeArea - Self instance for method chaining.Try it:
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.stock.scrollerSeries.RangeArea - Self instance for method chaining.Try it:
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.stock.scrollerSeries.RangeArea - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.core.stock.scrollerSeries.RangeArea - Self instance for method chaining.Try it:
selectHatchFill
Returns:
anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - The current hatch fill.var currentSelectHatchFill = series.selectHatchFill();
Params:
Name | Type | Default | Description |
---|---|---|---|
patternFillOrType | anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | string | false | PatternFill or HatchFill instance or type of hatch fill. |
color | string | Color. | |
thickness | number | Thickness. | |
size | number | Pattern size. |
Returns:
anychart.core.stock.scrollerSeries.RangeArea - Self instance for method chaining.Try it:
selectHighStroke
Returns:
anychart.graphics.vector.Stroke | function - The high stroke settings.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
strokeFunction | function | function() { return anychart.color.darken(this.sourceColor); } | Function that looks like function(){
// this.index - series index.
// this.sourceColor - color returned by fill() getter.
// this.iterator - series point iterator.
return strokeValue; // type anychart.graphics.vector.Stroke or anychart.graphics.vector.ColoredFill
} . |
Returns:
anychart.core.stock.scrollerSeries.RangeArea - Self instance for method chaining.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
color | anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null | Stroke settings. | |
thickness | number | 1 | 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.stock.scrollerSeries.RangeArea - Self instance for method chaining.Try it:
selectLowStroke
Returns:
anychart.graphics.vector.Stroke | function - The current low stroke settings.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
strokeFunction | function | function() { return anychart.color.darken(this.sourceColor); } | Function that looks like function(){
// this.index - series index.
// this.sourceColor - color returned by fill() getter.
// this.iterator - series point iterator.
return strokeValue; // type anychart.graphics.vector.Stroke or anychart.graphics.vector.ColoredFill
} . |
Returns:
anychart.core.stock.scrollerSeries.RangeArea - Self instance for method chaining.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
color | anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null | Stroke settings. | |
thickness | number | 1 | 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.stock.scrollerSeries.RangeArea - Self instance for method chaining.Try it:
seriesType
Params:
Name | Type | Description |
---|---|---|
value | string | Series type. |
Returns:
anychart.core.stock.scrollerSeries.RangeArea - Self instance for method chaining.Try it:
top
Returns:
number | string | undefined - Current element's top bound setting.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Top bound setting for the element. |
Returns:
anychart.core.stock.scrollerSeries.RangeArea - Returns self for method chaining.Try it:
unlisten
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
Params:
Name | Type | Description |
---|---|---|
key | Object | The key returned by listen() or listenOnce(). |
Returns:
boolean - Whether any listener was removed.Try it:
width
Returns:
number | string | undefined - Current element's width setting.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Width setting for the element. |
Returns:
anychart.core.stock.scrollerSeries.RangeArea - Returns self for method chaining.Try it:
yScale
Returns:
anychart.scales.ScatterBase - Series Y-scale.var lineScroller = chart.scroller(); var scrollerSeries = lineScroller.line(data); scrollerSeries.yScale();
Params:
Name | Type | Description |
---|---|---|
value | anychart.scales.ScatterBase | Value to set. |
Returns:
anychart.core.stock.scrollerSeries.RangeArea - Self instance for method chaining.Try it:
zIndex
Returns:
number - The current zIndex.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | 0 | Value to set. |
Returns:
anychart.core.stock.scrollerSeries.RangeArea - Self instance for method chaining.Try it: