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

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

Extends: anychart.core.linearGauge.pointers.Base

Led pointer class.

Methods Overview

Specific settings
count()Interval settings.
hoverLabel()Hover label settings.
label()Label settings.
legendItem()Legend item setting
selectLabel()Select label settings.
Axes and Scales
colorScale()Color scale settings.
scale()Scale settings
Coloring
color()Color settings.
dimmer()Dimmer 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
Gauges
getGauge()Getter for the gauge.
Interactivity
hover()Hovers a pointer.
select()Selects a pointer.
unhover()Removes hover from the pointer.
unselect()Deselects a pointer.
Size and Position
gap()Gap settings.
offset()Offset settings
size()Size settings.
width()Width settings

Methods Description

color

Getter for the pointer color.

Returns:

anychart.graphics.vector.Fill - The current series color.

Try it:

Setter for the color settings using an array or a string.

Params:

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

Returns:

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

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. 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. 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:

colorScale

Getter for led color scale.

Returns:

anychart.core.linearGauge.pointers.Led - The led color scale.
See listing
var ledPointer = chart.led(2);
var currentColorScale = ledPointer.colorScale();
Setter for the led color scale.

Params:

Name Type Description
value anychart.scales.LinearColor | anychart.scales.OrdinalColor Led color scale.

Returns:

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

Try it:

count

Getter for the led interval.

Returns:

number - The led interval.
See listing
var ledPointer = chart.led(2);
var currentCount = ledPointer.count();
Setter for the led interval.

Params:

Name Type Description
value number Led interval.

Returns:

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

dimmer

Getter for the dimmer.

Returns:

function - Led dimmer.
See listing
var ledPointer = chart.led(2);
var currentDimmer = ledPointer.dimmer();
Setter for the dimmer.

Params:

Name Type Description
value function Dimmer function.

Returns:

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

Try it:

fill

Getter for the fill color.

Returns:

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

Try it:

Setter for the 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:

gap

Getter for the led gap.

Returns:

number string - The led gap.

Try it:

Setter for the led gap.

Params:

Name Type Default Description
value number | string
"1%"
Led gap.

Returns:

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

Try it:

getGauge

Getter for the gauge.

Returns:

anychart.charts.LinearGauge - Gauge.

Try it:

hatchFill

Getter for the pointer hatch fill settings.

Returns:

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

Try it:

Setter for the 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 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 the pointer hover hatch fill settings.

Returns:

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

Try it:

Setter for the 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
value 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 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 setting.

Returns:

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

Try it:

Setter for the legend item setting.

Params:

Name Type Description
value Object Legend item settings object.

Returns:

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

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:

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 object 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 the 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 anychart.graphics.vector.Stroke | 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
value 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:

size

Getter for the led size.

Returns:

number string - The led size.

Try it:

Setter for the led size.

Params:

Name Type Default Description
value number | string
"2%"
Led size.

Returns:

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

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: