class anychart.core.linearGauge.pointers.Bar Improve this Doc
Extends: anychart.core.linearGauge.pointers.Base
Bar pointer class.
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() | Series 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
Learn more about coloring.
Params:
Name | Type | Description |
---|---|---|
color | string | Color as a string. |
Returns:
anychart.core.linearGauge.pointers.Bar - Self instance for method chaining.Try it:
data
Returns:
anychart.data.View - Pointers data.var pointer = pointer.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.Bar - Self instance for method chaining.dataIndex
Params:
Name | Type | Description |
---|---|---|
index | number | Data index to set. |
Returns:
anychart.core.linearGauge.pointers.Bar - Self instance for method chaining.Try it:
enabled
Returns:
boolean - Element state.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
enabled | boolean | true | Enabled state to set. |
Returns:
anychart.core.linearGauge.pointers.Bar - Self instance for method chaining.if (!element.enabled()) element.enabled(true);
Try it:
fill
Returns:
anychart.graphics.vector.Fill | function - Pointer fill color.Try it:
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.Bar - Self instance for method chaining.Params:
Name | Type | Default | Description |
---|---|---|---|
fillFunction | function():anychart.graphics.vector.Fill | function() { return anychart.color.darken(this.sourceColor); } | Function that looks like: function(){ // this.index - pointer index // this.sourceColor - color returned by fill() getter // this.isVertical - layout direction of the bar return fillValue; // type anychart.graphics.vector.Fill } |
Returns:
anychart.core.linearGauge.pointers.Bar - 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.Bar - 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.Bar - 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.Bar - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.core.linearGauge.pointers.Bar - 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 |
---|---|---|---|
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.Bar - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
hatchFillFunction | function | HatchFill function. |
Returns:
anychart.core.linearGauge.pointers.Bar - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
patternFill | anychart.graphics.vector.PatternFill | Pattern fill to set. |
Returns:
anychart.core.linearGauge.pointers.Bar - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
settings | anychart.graphics.vector.HatchFill | Hatch fill instance. |
Returns:
anychart.core.linearGauge.pointers.Bar - Self instance for method chaining.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
enabled | boolean | false | Whether to enable hatch fill or no. |
Returns:
anychart.core.linearGauge.pointers.Bar - Self instance for method chaining.Try it:
hover
Returns:
anychart.core.linearGauge.pointers.Bar - Self instance for method chaining.Try it:
hovered
Returns:
anychart.core.StateSettings - Hovered state settingsTry it:
Params:
Name | Type | Description |
---|---|---|
settings | Object | State settings to set. |
Returns:
anychart.core.linearGauge.pointers.Bar - Self instance for method chaining.Try it:
id
Params:
Name | Type | Default | Description |
---|---|---|---|
id | string | number | 0 | Pointer id to set. |
Returns:
anychart.core.linearGauge.pointers.Bar - Self instance for method chaining.Try it:
labels
- 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.Bar - Self instance for method chaining.legendItem
Returns:
anychart.core.utils.LegendItemSettings - Legend item settings.Try it:
Params:
Name | Type | Description |
---|---|---|
settings | Object | Legend item settings to set. |
Returns:
anychart.core.linearGauge.pointers.Bar - Self instance for method chaining.Try it:
name
Returns:
string | undefined - Series name.Try it:
Params:
Name | Type | Description |
---|---|---|
name | string | Series name to set. |
Returns:
anychart.core.linearGauge.pointers.Bar - Self instance for method chaining.Try it:
normal
Returns:
anychart.core.StateSettings - Normal state settings.Try it:
Params:
Name | Type | Description |
---|---|---|
settings | Object | State settings to set. |
Returns:
anychart.core.linearGauge.pointers.Bar - Self instance for method chaining.Try it:
offset
Returns:
string - The pointer offset in percent.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
offset | string | number | '0%' | Pointer offset to set. |
Returns:
anychart.core.linearGauge.pointers.Bar - Self instance for method chaining.Try it:
scale
Params:
Name | Type | Default | Description |
---|---|---|---|
scale | anychart.scales.Base | anychart.scales.Linear | Pointer scale. |
Returns:
anychart.core.linearGauge.pointers.Bar - 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.Bar - Self instance for method chaining.Try it:
selected
Returns:
anychart.core.StateSettings - Selected state settingsTry it:
Params:
Name | Type | Description |
---|---|---|
settings | Object | State settings to set. |
Returns:
anychart.core.linearGauge.pointers.Bar - Self instance for method chaining.Try it:
stroke
Returns:
anychart.graphics.vector.Stroke | function():anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFill - The pointer stroke.Try it:
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 }; |
Returns:
anychart.core.linearGauge.pointers.Bar - 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 stroke paths. | |
lineJoin | string | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
lineCap | string | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.core.linearGauge.pointers.Bar - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
settings | Object | Stroke settings from anychart.graphics.vector.Stroke. |
Returns:
anychart.core.linearGauge.pointers.Bar - Self instance for method chaining.Try it:
unhover
Returns:
anychart.core.linearGauge.pointers.Bar - Self instance for method chaining.Try it:
unselect
Returns:
anychart.core.linearGauge.pointers.Bar - Self instance for method chaining.Try it:
width
Params:
Name | Type | Description |
---|---|---|
width | string | Pointer width |
Returns:
anychart.core.linearGauge.pointers.Bar - Self instance for method chaining.Try it:
zIndex
Params:
Name | Type | Default | Description |
---|---|---|---|
zIndex | number | 0 | Value to set. |
Returns:
anychart.core.linearGauge.pointers.Bar - Self instance for method chaining.Try it: