Top

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

Extends: anychart.core.VisualBase

Base class for pointers.

Methods Overview

Specific settings
label()Label 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
dataIndex()Pointer name settings.
name()Pointer name settings.
Gauges
getGauge()Getter for the gauge.
Interactivity
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

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:

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:

hovered

Getter for hovered state settings.

Returns:

anychart.core.StateSettings - Hovered state settings

Try it:

Setter for hovered state settings.

Params:

Name Type Description
value Object State settings to set.

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:

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:

normal

Getter for normal state settings.

Returns:

anychart.core.StateSettings - Normal state settings.

Try it:

Setter for normal state settings.

Params:

Name Type Description
value Object State settings to set.

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:

selected

Getter for selected state settings.

Returns:

anychart.core.StateSettings - Selected state settings

Try it:

Setter for selected state settings.

Params:

Name Type Description
value Object State settings to set.

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:

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: