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

Base class for pointers.

Methods Overview

Specific Settings
id()	Pointer id.
Specific settings
labels()	Labels settings.
legendItem()	Legend item settings.
Axes and Scales
scale()	Scale settings.
Coloring
color()	Color settings.
fill()	Fill settings.
hatchFill()	Hatch fill settings.
stroke()	Stroke settings.
Data
data()	Data for pointers.
dataIndex()	Pointer name settings.
name()	Pointer name settings.
Gauges
getGauge()	Getter for the gauge.
Interactivity
enabled()	Element state (enabled or disabled).
hover()	Hovers a pointer.
hovered()	Hovered state settings.
normal()	Normal state settings.
select()	Selects a pointer.
selected()	Selected state settings.
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

color()Since version 7.11.0

Getter for the pointer color.

Returns:

string - The pointer color.

Try it:

Usage sample

color(color)Since version 7.11.0

Setter for the pointer color.

Detailed description

Note: color methods sets fill and stroke settings, which means it is not wise to pass image fill here - stroke doesn't accept image fill.
Learn more about coloring.

Params:

Name	Type	Description
color	string	Color as a string.

Returns:

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

Try it:

Usage sample

data

data()Since version 8.2.0

Getter for pointers data.

Returns:

anychart.data.View - Pointers data.

See listing

var pointer = pointer.data();

data(data, csvSettings)Since version 8.2.0

Getter for pointers data.

Params:

Name	Type	Description
data	anychart.data.View \| anychart.data.Set \| Array \| string	Data to set.
csvSettings	anychart.enums.TextParsingMode \| anychart.data.TextParsingSettings	If CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

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

Try it:

dataIndex

dataIndex()Since version 7.11.0

Getter for the data index.

Returns:

number - Data index.

Try it:

Usage sample

dataIndex(index)Since version 7.11.0

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:

Usage sample

enabled

enabled()

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.

Try it:

Usage sample

enabled(enabled)

Setter for the element enabled state.

Params:

Name	Type	Default	Description
enabled	boolean	true	Enabled state to set.

Returns:

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

Example.

if (!element.enabled())
   element.enabled(true);

Try it:

Usage sample

fill

fill()Since version 7.11.0

Getter for the pointer fill color.

Returns:

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

Try it:

Usage sample

fill(color)Since version 7.11.0

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

Params:

Name	Type	Description
color	anychart.graphics.vector.Fill \| Array.<(anychart.graphics.vector.GradientKey\|string)>	Color as an object, an array or a string.

Returns:

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

Try it:

fill(color, opacity)Since version 7.11.0

Fill color with opacity. Fill as a string or an object.

Detailed description

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

Try it:

Usage sample

fill(keys, angle, mode, opacity)Since version 7.11.0

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:

Usage sample

fill(keys, cx, cy, mode, opacity, fx, fy)Since version 7.11.0

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:

Usage sample

fill(imageSettings)Since version 7.11.0

Image fill. Learn more about coloring.

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:

Usage sample

getGauge

getGauge()Since version 7.11.0

Getter for the gauge.

Returns:

anychart.charts.LinearGauge - Gauge.

Try it:

Usage sample

hatchFill

hatchFill()Since version 7.11.0

Getter for pointer hatch fill settings.

Returns:

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

Try it:

Usage sample

hatchFill(type, color, thickness, size)Since version 7.11.0

Setter for hatch fill settings.

Params:

Name	Type	Default	Description
type	anychart.graphics.vector.HatchFill.HatchFillType \| string	false	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:

Usage sample

hatchFill(hatchFillFunction)Since version 7.11.0

Setter for hatch fill settings using function. Learn more about coloring.

Params:

Name	Type	Description
hatchFillFunction	function	HatchFill function.

Returns:

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

Try it:

Usage sample

hatchFill(patternFill)Since version 7.11.0

Setter for hatch fill settings using pattern fill. Learn more about coloring.

Params:

Name	Type	Description
patternFill	anychart.graphics.vector.PatternFill	Pattern fill to set.

Returns:

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

Try it:

Usage sample

hatchFill(settings)Since version 7.11.0

Setter for hatch fill settings using an instance. Learn more about coloring.

Params:

Name	Type	Description
settings	anychart.graphics.vector.HatchFill	Hatch fill instance.

Returns:

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

Try it:

Usage sample

hatchFill(enabled)Since version 7.11.0

Setter for hatch fill using boolean. Learn more about hatch fill settings.

Params:

Name	Type	Default	Description
enabled	boolean	false	Whether to enable hatch fill or no.

Returns:

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

Try it:

Usage sample

hover

hover()Since version 7.11.0

Hovers a pointer.

Detailed description

Note: Works only after anychart.charts.LinearGauge#draw is called.

Returns:

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

Try it:

Usage sample

hovered

hovered()Since version 8.0.0

Getter for hovered state settings.

Returns:

anychart.core.StateSettings - Hovered state settings

Try it:

Usage sample

hovered(settings)Since version 8.0.0

Setter for hovered state settings.

Params:

Name	Type	Description
settings	Object	State settings to set.

Returns:

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

Try it:

Usage sample

id

id()Since version 8.2.0

Getter for the pointer id.

Returns:

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

See listing

var id = pointer.id();

id(id)Since version 8.2.0

Setter for the pointer id.

Params:

Name	Type	Default	Description
id	string \| number	0	Pointer id to set.

Returns:

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

Try it:

Usage sample

labels

labels()Since version 7.11.0

Getter for the pointer labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Usage sample

labels(settings)Since version 7.11.0

Setter for the pointer labels.

Detailed description

Sets pointer label settings depending on parameter type:

null/boolean - disable or enable pointer labels.
object - sets pointer labels settings.

Params:

Name	Type	Description
settings	anychart.core.ui.LabelsFactory \| Object \| boolean	Pointer labels settings.

Returns:

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

Try it:

legendItem

legendItem()Since version 7.11.0

Getter for the legend item settings.

Returns:

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

Try it:

Usage sample

legendItem(settings)Since version 7.11.0

Setter for the legend item settings.

Params:

Name	Type	Description
settings	Object	Legend item settings to set.

Returns:

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

Try it:

Usage sample

name

name()Since version 7.11.0

Getter for the pointer name.

Returns:

string - The pointer name.

Try it:

Usage sample

name(name)Since version 7.11.0

Setter for the pointer name.

Detailed description

Basically, name of series is used in Legend displaying, but it can be used in tooltips.

Params:

Name	Type	Description
name	string	Pointer name to set.

Returns:

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

Try it:

Usage sample

normal

normal()Since version 8.0.0

Getter for normal state settings.

Returns:

anychart.core.StateSettings - Normal state settings.

Try it:

Usage sample

normal(settings)Since version 8.0.0

Setter for normal state settings.

Params:

Name	Type	Description
settings	Object	State settings to set.

Returns:

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

Try it:

Usage sample

offset

offset()Since version 7.11.0

Getter for the pointer offset.

Returns:

string - The pointer offset in percent.

Try it:

Usage sample

offset(offset)Since version 7.11.0

Setter for the pointer offset.

Params:

Name	Type	Default	Description
offset	string \| number	'0%'	Pointer offset to set.

Returns:

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

Try it:

Usage sample

scale

scale()Since version 7.11.0

Getter for the pointer scale.

Returns:

anychart.scales.Base - Pointer scale.

Try it:

Usage sample

scale(scale)Since version 7.11.0

Setter for the pointer scale.

Params:

Name	Type	Default	Description
scale	anychart.scales.Base	anychart.scales.Linear	Pointer scale.

Returns:

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

Try it:

Usage sample

select

select(event)Since version 7.11.0

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:

Usage sample

selected

selected()Since version 8.0.0

Getter for selected state settings.

Returns:

anychart.core.StateSettings - Selected state settings

Try it:

Usage sample

selected(settings)Since version 8.0.0

Setter for selected state settings.

Params:

Name	Type	Description
settings	Object	State settings to set.

Returns:

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

Try it:

Usage sample

stroke

stroke()Since version 7.11.0

Getter for the pointer stroke.

Returns:

anychart.graphics.vector.Stroke | function():anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFill - The pointer stroke.

Try it:

Usage sample

stroke(strokeFunction)Since version 7.11.0

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

Params:

Name	Type	Default	Description
strokeFunction	function():anychart.graphics.vector.Stroke\|anychart.graphics.vector.ColoredFill	// 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 };

Name

Type

Default

Description

strokeFunction

function():anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFill

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

Usage sample

stroke(color, thickness, dashpattern, lineJoin, lineCap)Since version 7.11.0

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 \| null		Stroke settings.
thickness	number	1	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.