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
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.
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
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.
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.Try it:
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:
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:
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:
getGauge
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.
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:
hoverFill
Getter for the 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.Try it:
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:
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:
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:
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.
Detailed description
Sets pointer hover label settings depending on parameter type:
- 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
Getter for 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.
Detailed description
Sets pointer label settings depending on parameter type:
- 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.Try it:
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
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 |
|---|---|---|
| value | string | Pointer name. |
Returns:
anychart.core.linearGauge.pointers.Base - Self instance for method chaining.Try it:
offset
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
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.
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.Try it:
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:
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:
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:
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.
Detailed description
Sets pointer select label settings depending on parameter type:
- 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
Getter for 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.
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.
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:
unselect
Deselects 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:
width
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: