Top
You are looking at an outdated 7.13.1 version of this document. Switch to the 7.14.0 version to see the up to date information.

class anychart.core.linearGauge.pointers.RangeBar Improve this Doc

Extends: anychart.core.linearGauge.pointers.Bar

Range bar pointer class.

Methods Overview

Specific settings
hoverLabel()Hover label settings.
label()Label settings.
legendItem()Legend item settings.
selectLabel()Select label settings.
Axes and Scales
scale()Scale settings.
Coloring
color()Color settings.
fill()Fill settings.
hatchFill()Hatch fill settings.
hoverFill()Fill settings.
hoverHatchFill()Hatch fill settings.
hoverStroke()Stroke settings.
selectFill()Select fill settings.
selectHatchFill()Hatch fill settings.
selectStroke()Stroke settings.
stroke()Stroke settings.
Data
dataIndex()Pointer name settings.
name()Pointer name 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.
Gauges
getGauge()Getter for the gauge.
Interactivity
enabled()Element state (enabled or disabled).
hover()Hovers a pointer.
select()Selects a pointer.
unhover()Removes hover from the pointer.
unselect()Deselects a pointer.
Size and Position
offset()Offset settings.
width()Width settings
zIndex()Z-index of the element.

Methods Description

color

Getter for the pointer color.

Returns:

string - The pointer color.

Try it:

Setter for the pointer color.

Params:

Name Type Description
value string Color as a string.

Returns:

anychart.core.linearGauge.pointers.Base - Self instance for method chaining.

Try it:

dataIndex

Getter for the data index.

Returns:

number - Data index.

Try it:

Setter for the data index.

Params:

Name Type Description
index number Data index to set.

Returns:

anychart.core.linearGauge.pointers.Base - 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:

fill

Getter for the pointer fill color.

Returns:

anychart.graphics.vector.Fill function - Pointer fill color.

Try it:

Setter for fill settings using an array or a string. Learn more about coloring.

Params:

Name Type Default Description
value anychart.graphics.vector.Fill
Color as an object or a string.

Returns:

anychart.core.linearGauge.pointers.Base - Self instance for method chaining.
Fill color with opacity. Fill as a string or an object.

Params:

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

Returns:

anychart.core.linearGauge.pointers.Base - 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.linearGauge.pointers.Base - 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.linearGauge.pointers.Base - Self instance for method chaining.

Try it:

Params:

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

Returns:

anychart.core.linearGauge.pointers.Base - Self instance for method chaining.

Try it:

getGauge

Getter for the gauge.

Returns:

anychart.charts.LinearGauge - Gauge.

Try it:

hatchFill

Getter for pointer hatch fill settings.

Returns:

anychart.graphics.vector.PatternFill anychart.graphics.vector.HatchFill function - The pointer hatch fill.

Try it:

Setter for hatch fill settings.

Params:

Name Type Default Description
patternFillOrType anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | string | boolean
false
PatternFill or HatchFill instance or type of hatch fill.
color string
Color.
thickness number
Thickness.
size number
Pattern size.

Returns:

anychart.core.linearGauge.pointers.Base - Self instance for method chaining.

Try it:

hover

Hovers a pointer.

Returns:

anychart.core.linearGauge.pointers.Base - Self instance for method chaining.

Try it:

hoverFill

Getter for the hover fill color.

Returns:

anychart.graphics.vector.Fill function - Pointer hover fill color.

Try it:

Setter for the hover fill settings using an array or a string. Learn more about coloring.

Params:

Name Type Default Description
value anychart.graphics.vector.Fill
Color as an object or a string.

Returns:

anychart.core.linearGauge.pointers.Base - Self instance for method chaining.
Fill color with opacity. Fill as a string or an object.

Params:

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

Returns:

anychart.core.linearGauge.pointers.Base - 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.linearGauge.pointers.Base - 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.linearGauge.pointers.Base - Self instance for method chaining.

Try it:

Params:

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

Returns:

anychart.core.linearGauge.pointers.Base - Self instance for method chaining.

Try it:

hoverHatchFill

Getter for pointer hover hatch fill settings.

Returns:

anychart.graphics.vector.PatternFill anychart.graphics.vector.HatchFill function - Pointer hover hatch fill settings.

Try it:

Setter for hover hatch fill settings.

Params:

Name Type Default Description
patternFillOrType anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | string | boolean
false
PatternFill or HatchFill instance or type of hatch fill.
color string
Color.
thickness number
Thickness.
size number
Pattern size.

Returns:

anychart.core.linearGauge.pointers.Base - Self instance for method chaining.

Try it:

hoverLabel

Getter for the pointer hover label.

Returns:

anychart.core.ui.LabelsFactory - Labels factory instance.

Try it:

Setter for the pointer hover label.

Params:

Name Type Description
value anychart.core.ui.LabelsFactory | Object | boolean Pointer label settings.

Returns:

anychart.core.linearGauge.pointers.Base - Self instance for method chaining.

hoverStroke

Getter for the pointer hover stroke.

Returns:

anychart.graphics.vector.Stroke function - The pointer hover stroke.

Try it:

Setter for the pointer hover stroke using function. Learn more about hoverStroke settings.

Params:

Name Type Default Description
value anychart.graphics.vector.Stroke | function
// return hoverStroke from the default palette.
function() {
  return anychart.color.darken(this.sourceColor);
};
or Stroke, or Stroke-function, which should look like:function() { // this: { // index : number - the index of the current point // sourceColor : anychart.graphics.vector.Stroke - hoverStroke of the current point // } return myStroke; //anychart.graphics.vector.Stroke };.

Returns:

anychart.core.linearGauge.pointers.Base - Self instance for method chaining.

Try it:

Setter for the pointer hover stroke using several parameters. Learn more about stroke settings.

Params:

Name Type Default Description
color anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
Stroke settings.
thickness number
1
Line thickness.
dashpattern string
Controls the pattern of dashes and gaps used to hoverStroke paths.
lineJoin anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCap anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.core.linearGauge.pointers.Base - Self instance for method chaining.

Try it:

label

Getter for the pointer label.

Returns:

anychart.core.ui.LabelsFactory - Labels factory instance.

Try it:

Setter for the pointer label.

Params:

Name Type Description
value anychart.core.ui.LabelsFactory | Object | boolean Pointer label settings.

Returns:

anychart.core.linearGauge.pointers.Base - Self instance for method chaining.

legendItem

Getter for the legend item settings.

Returns:

anychart.core.utils.LegendItemSettings - Legend item settings.

Try it:

Setter for the legend item settings.

Params:

Name Type Description
value Object Legend item settings object.

Returns:

anychart.core.linearGauge.pointers.Base - Self instance for method chaining.

Try it:

listen

Adds an event listener to an implementing object.

Params:

Name Type 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 Whether to fire in capture phase (defaults to false).
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 Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope Object Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

name

Getter for the pointer name.

Returns:

string - The pointer name.

Try it:

Setter for the pointer name.

Params:

Name Type Description
value string Pointer name.

Returns:

anychart.core.linearGauge.pointers.Base - Self instance for method chaining.

Try it:

offset

Getter for the pointer offset.

Returns:

string - The pointer offset.

Try it:

Setter for the pointer offset.

Params:

Name Type Description
value string Percent offset.

Returns:

anychart.core.linearGauge.pointers.Base - 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:

scale

Getter for the pointer scale.

Returns:

anychart.scales.Base - Pointer scale.

Try it:

Setter for the pointer scale.

Params:

Name Type Description
value anychart.scales.Base Pointer scale.

Returns:

anychart.core.linearGauge.pointers.Base - Self instance for method chaining.

Try it:

select

Selects a pointer.

Params:

Name Type Description
event anychart.core.MouseEvent Event that initiate point selecting.

Returns:

anychart.core.linearGauge.pointers.Base - Self instance for method chaining.

Try it:

selectFill

Getter for the select fill color.

Returns:

anychart.graphics.vector.Fill function - Pointer fill color.

Try it:

Setter for the select fill settings using an array or a string. Learn more about coloring.

Params:

Name Type Default Description
value anychart.graphics.vector.Fill
Color as an object or a string.

Returns:

anychart.core.linearGauge.pointers.Base - Self instance for method chaining.
Fill color with opacity. Fill as a string or an object.

Params:

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

Returns:

anychart.core.linearGauge.pointers.Base - 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.linearGauge.pointers.Base - 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.linearGauge.pointers.Base - Self instance for method chaining.

Try it:

Params:

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

Returns:

anychart.core.linearGauge.pointers.Base - Self instance for method chaining.

Try it:

selectHatchFill

Getter for pointer select hatch fill settings.

Returns:

anychart.graphics.vector.PatternFill anychart.graphics.vector.HatchFill function - The pointer select hatch fill.

Try it:

Setter for the pointer select hatch fill settings.

Params:

Name Type Default Description
patternFillOrType anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | string | boolean
false
PatternFill or HatchFill instance or type of hatch fill.
color string
Color.
thickness number
Thickness.
size number
Pattern size.

Returns:

anychart.core.linearGauge.pointers.Base - Self instance for method chaining.

Try it:

selectLabel

Getter for the pointer select label.

Returns:

anychart.core.ui.LabelsFactory - Labels factory instance.

Try it:

Setter for the pointer select label.

Params:

Name Type Description
value anychart.core.ui.LabelsFactory | Object Pointer select label.

Returns:

anychart.core.linearGauge.pointers.Base - Self instance for method chaining.

selectStroke

Getter for the pointer select stroke.

Returns:

anychart.graphics.vector.Stroke function - The pointer select stroke.

Try it:

Setter for the pointer select stroke using function. Learn more about selectStroke settings.

Params:

Name Type Default Description
value function
// return selectStroke from the default palette.
function() {
  return anychart.color.darken(this.sourceColor);
};
or Stroke, or Stroke-function, which should look like:function() { // this: { // index : number - the index of the current point // sourceColor : anychart.graphics.vector.Stroke - selectStroke of the current point // } return myStroke; //anychart.graphics.vector.Stroke };.

Returns:

anychart.core.linearGauge.pointers.Base - Self instance for method chaining.

Try it:

Setter for the pointer select stroke using several parameters. Learn more about stroke settings.

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 selectStroke paths.
lineJoin anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCap anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.core.linearGauge.pointers.Base - Self instance for method chaining.

Try it:

stroke

Getter for the pointer stroke.

Returns:

anychart.graphics.vector.Stroke function - The pointer stroke.

Try it:

Setter for the pointer stroke using function. Learn more about stroke settings.

Params:

Name Type Default Description
value anychart.graphics.vector.Stroke | function
// return stroke from the default palette.
function() {
  return anychart.color.darken(this.sourceColor);
};
or Stroke, or stroke-function, which should look like:function() { // this: { // index : number - the index of the current point // sourceColor : anychart.graphics.vector.Stroke - stroke of the current point // } return myStroke; //anychart.graphics.vector.Stroke };.

Returns:

anychart.core.linearGauge.pointers.Base - Self instance for method chaining.

Try it:

Setter for the pointer stroke using several parameters. Learn more about stroke settings.

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.linearGauge.pointers.Base - Self instance for method chaining.

Try it:

unhover

Removes hover from the pointer.

Returns:

anychart.core.linearGauge.pointers.Base - Self instance for method chaining.

Try it:

unlisten

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

Params:

Name Type Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
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:

unselect

Deselects a pointer.

Returns:

anychart.core.linearGauge.pointers.Base - Self instance for method chaining.

Try it:

width

Getter for the pointer width.

Returns:

string - The pointer width.

Try it:

Setter for the pointer width.

Params:

Name Type Default Description
value string
"10%"
Pointer width

Returns:

anychart.core.linearGauge.pointers.Base - Self instance for method chaining.

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: