class anychart.core.gauge.pointers.Needle Improve this Doc
Extends: anychart.core.gauge.pointers.Base
Needle pointer class.
Methods Overview
| Specific Settings | |
| id() | Pointer id. |
| Specific settings | |
| axisIndex() | Axis index. |
| endRadius() | End radius settings. |
| endWidth() | End width settings. |
| middleRadius() | Middle radius settings. |
| middleWidth() | Middle width settings. |
| startRadius() | Start radius settings. |
| startWidth() | Start width. |
| Coloring | |
| fill() | Fill settings. |
| hatchFill() | Hatch fill settings. |
| stroke() | Stroke settings. |
| Data | |
| data() | Data for pointers. |
| dataIndex() | Data index. |
| Interactivity | |
| enabled() | Element state (enabled or disabled). |
| Size and Position | |
| zIndex() | Z-index of the element. |
Methods Description
axisIndex
Setter for the axis index.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Value to set. |
Returns:
anychart.core.gauge.pointers.Needle - Self instance for method chaining.Try it:
data
Getter for pointers data.
Returns:
anychart.data.View - Pointers data. See listing
var pointer = pointer.data();
Setter for pointers data.
Params:
| Name | Type | Description |
|---|---|---|
| data | anychart.data.View | anychart.data.Set | Array | string | Value 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.gauge.pointers.Needle - Self instance for method chaining.dataIndex
Setter for the data index.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Value to set. |
Returns:
anychart.core.gauge.pointers.Needle - Self instance for method chaining.Try it:
enabled
Getter for the element state (enabled or disabled).
Returns:
boolean - Element state.Try it:
Setter for the element enabled state.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | true | Enabled state to set. |
Returns:
anychart.core.gauge.pointers.Needle - Self instance for method chaining. Example.
if (!element.enabled()) element.enabled(true);
Try it:
endRadius
Getter for the end radius.
Detailed description
This method can be used as getter only if the value has been previously set.
Returns:
string - End radius.Try it:
Setter for the end radius.
Detailed description
Null returns auto calculated end radius.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| radius | number | string | undefined | End radius to set. |
Returns:
anychart.core.gauge.pointers.Needle - Self instance for method chaining.Try it:
endWidth
Getter for the end width.
Detailed description
This method can be used as getter only if the value has been previously set.
Returns:
string - End width.Try it:
Setter for the end width.
Detailed description
Null returns auto calculated end width.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| width | number | string | undefined | End width to set. |
Returns:
anychart.core.gauge.pointers.Needle - Self instance for method chaining.Try it:
fill
Sets pointer fill settings using an array 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 or a string. |
Returns:
anychart.core.gauge.pointers.Needle - Self instance for method chaining.Pointer fill color with opacity.
Fill as a string or an object.
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.gauge.pointers.Needle - Self instance for method chaining.Try it:
Linear gradient pointer 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.gauge.pointers.Needle - Self instance for method chaining.Try it:
Radial gradient pointer 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.gauge.pointers.Needle - Self instance for method chaining.Try it:
Image pointer fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.core.gauge.pointers.Needle - Self instance for method chaining.Try it:
hatchFill
Getter for hatch fill settings.
Returns:
anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | boolean - Hatch fill settings. See listing.
var hatchFill = knob.hatchFill();
Setter for hatch fill settings.
Learn more about 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.gauge.pointers.Needle - Self instance for method chaining.Try it:
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.gauge.pointers.Needle - Self instance for method chaining.Try it:
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.gauge.pointers.Needle - Self instance for method chaining.Try it:
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.gauge.pointers.Needle - Self instance for method chaining.Try it:
id
Getter for the pointer id.
Returns:
anychart.core.gauge.pointers.Needle - Self instance for method chaining. See listing
var id = pointer.id();
Setter for the pointer id.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| id | string | number | 0 | Pointer id to set. |
Returns:
anychart.core.gauge.pointers.Needle - Self instance for method chaining.Try it:
middleRadius
Getter for the middle radius.
Detailed description
This method can be used as getter only if the value has been previously set.
Returns:
string - Middle radius.Try it:
Setter for the middle radius.
Detailed description
Null returns auto calculated middle radius.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| radius | number | string | undefined | Middle radius to set. |
Returns:
anychart.core.gauge.pointers.Needle - Self instance for method chaining.Try it:
middleWidth
Getter for the middle width.
Detailed description
This method can be used as getter only if the value has been previously set.
Returns:
string - Middle width.Try it:
Setter for the middle width.
Detailed description
Null returns auto calculated bar pointer radius.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| width | number | string | '1%' | Middle width to set. |
Returns:
anychart.core.gauge.pointers.Needle - Self instance for method chaining.Try it:
startRadius
Getter for the start radius.
Detailed description
This method can be used as getter only if the value has been previously set.
Returns:
string - Start radius.Try it:
Setter for the start radius.
Detailed description
Null returns auto calculated start radius.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| radius | number | string | '-20%' | Start radius to set. |
Returns:
anychart.core.gauge.pointers.Needle - Self instance for method chaining.Try it:
startWidth
Getter for the start width.
Detailed description
This method can be used as getter only if the value has been previously set.
Returns:
string - Start width.Try it:
Setter for the start width.
Detailed description
Null returns auto calculated bar pointer radius.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| width | number | string | '3%' | Start width to set. |
Returns:
anychart.core.gauge.pointers.Needle - Self instance for method chaining.Try it:
stroke
Getter for the pointer stroke.
Returns:
anychart.graphics.vector.Stroke | function - Stroke settings.Try it:
Setter for the pointer stroke by function.
Params:
| Name | Type | Description |
|---|---|---|
| strokeFunction | function():anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFill | Function for stroke. In the function can be used radius for bars, angle for needles. |
Returns:
anychart.core.gauge.pointers.Needle - Self instance for method chaining.Try it:
Setter for stroke settings.
Learn more about stroke settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| color | anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null | '#f22922' | Stroke settings. |
| thickness | number | 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.gauge.pointers.Needle - Self instance for method chaining.Try it:
Setter for the stroke using an object.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | Stroke settings from anychart.graphics.vector.Stroke. |
Returns:
anychart.core.gauge.pointers.Needle - Self instance for method chaining.Try it:
zIndex
Setter for the Z-index of the element.
Detailed description
The bigger the index - the higher the element position is.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| zIndex | number | 0 | Value to set. |
Returns:
anychart.core.gauge.pointers.Needle - Self instance for method chaining.Try it: