class anychart.core.linearGauge.pointers.Base Improve this Doc
Extends: anychart.core.VisualBase
Base class for pointers.
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. |
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 | |
offset() | Offset settings. |
width() | Width settings |
Methods Description
color
Learn more about coloring.
Params:
Name | Type | Description |
---|---|---|
value | string | Color as a string. |
Returns:
anychart.core.linearGauge.pointers.Base - Self instance for method chaining.Try it:
dataIndex
Params:
Name | Type | Description |
---|---|---|
index | number | Data index to set. |
Returns:
anychart.core.linearGauge.pointers.Base - Self instance for method chaining.Try it:
fill
Returns:
anychart.graphics.vector.Fill | function - Pointer fill color.Try it:
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.Try it:
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:
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:
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
hatchFill
Returns:
anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - The pointer hatch fill.Try it:
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
Returns:
anychart.core.linearGauge.pointers.Base - Self instance for method chaining.Try it:
hoverFill
Returns:
anychart.graphics.vector.Fill | function - Pointer hover fill color.Try it:
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.Try it:
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:
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:
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
Returns:
anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - Pointer hover hatch fill settings.Try it:
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
Returns:
anychart.core.ui.LabelsFactory - Labels factory instance.Try it:
- null/boolean - disable or enable pointer hover label.
- object - sets pointer hover label settings.
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
Returns:
anychart.graphics.vector.Stroke | function - The pointer hover stroke.Try it:
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:
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
Returns:
anychart.core.ui.LabelsFactory - Labels factory instance.Try it:
- null/boolean - disable or enable pointer label.
- object - sets pointer label settings.
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
Returns:
anychart.core.utils.LegendItemSettings - Legend item settings.Try it:
Params:
Name | Type | Description |
---|---|---|
value | Object | Legend item settings object. |
Returns:
anychart.core.linearGauge.pointers.Base - Self instance for method chaining.Try it:
name
Params:
Name | Type | Description |
---|---|---|
value | string | Pointer name. |
Returns:
anychart.core.linearGauge.pointers.Base - Self instance for method chaining.Try it:
offset
Params:
Name | Type | Description |
---|---|---|
value | string | Percent offset. |
Returns:
anychart.core.linearGauge.pointers.Base - Self instance for method chaining.Try it:
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
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
Returns:
anychart.graphics.vector.Fill | function - Pointer fill color.Try it:
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.Try it:
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:
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:
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
Returns:
anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - The pointer select hatch fill.Try it:
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
Returns:
anychart.core.ui.LabelsFactory - Labels factory instance.Try it:
- null/boolean - disable or enable pointer select label.
- object - sets pointer select label settings.
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
Returns:
anychart.graphics.vector.Stroke | function - The pointer select stroke.Try it:
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:
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
Returns:
anychart.graphics.vector.Stroke | function - The pointer stroke.Try it:
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:
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
Returns:
anychart.core.linearGauge.pointers.Base - Self instance for method chaining.Try it:
unselect
Returns:
anychart.core.linearGauge.pointers.Base - Self instance for method chaining.Try it:
width
Params:
Name | Type | Default | Description |
---|---|---|---|
value | string | "10%" | Pointer width |
Returns:
anychart.core.linearGauge.pointers.Base - Self instance for method chaining.Try it: