class anychart.core.gauge.pointers.Needle Improve this Doc
Extends: anychart.core.gauge.pointers.Base
Needle pointer class.
Methods Overview
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 | |
dataIndex() | Data index. |
Events | |
listen() | Adds an event listener. |
listenOnce() | Adds a single time event listener. |
removeAllListeners() | Removes all listeners. |
unlisten() | Removes the listener. |
unlistenByKey() | Removes the listener by the key. |
Export | |
print() | Prints all elements. |
Interactivity | |
enabled() | Element state (enabled or disabled). |
Size and Position | |
zIndex() | Z-index of the element. |
Methods Description
axisIndex
Params:
Name | Type | Default | Description |
---|---|---|---|
index | number | 0 | Value to set. |
Returns:
anychart.core.gauge.pointers.Needle - Self instance for method chaining.Try it:
dataIndex
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
Returns:
boolean - The current element state.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | boolean | true | Value to set. |
Returns:
anychart.core.gauge.pointers.Needle - Self instance for method chaining.if (!element.enabled()) element.enabled(true);
Try it:
endRadius
Returns:
string - End radius.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | null | number | string | undefined | Value to set. |
Returns:
anychart.core.gauge.pointers.Needle - Self instance for method chaining.Try it:
endWidth
Returns:
string - End width.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | null | number | string | undefined | Value to set. |
Returns:
anychart.core.gauge.pointers.Needle - Self instance for method chaining.Try it:
fill
Params:
Name | Type | Default | Description |
---|---|---|---|
value | anychart.graphics.vector.Fill | "#f22922" | Color as an object or a string. |
Returns:
anychart.core.gauge.pointers.Needle - Self instance for method chaining.Try it:
Fill as a string or an object.
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:
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:
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:
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
Returns:
anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | boolean - Hatch fill settings.var hatchFill = knob.hatchFill();
Params:
Name | Type | Default | Description |
---|---|---|---|
patternFillOrType | anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | 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.gauge.pointers.Needle - Self instance for method chaining.Try it:
listen
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.
Params:
Name | Type | Default | Description |
---|---|---|---|
type | string | The event type id. | |
listener | function | Callback method. Function that looks like function(event){
// event.actualTarget - actual event target
// event.currentTarget - current event target
// event.iterator - event iterator
// event.originalEvent - original event
// event.point - event point
// event.pointIndex - event point index
} . | |
useCapture | boolean | false | Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing |
listenerScope | Object | Object in whose scope to call the listener. |
Returns:
Object - Unique key for the listener.Try it:
listenOnce
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).
Params:
Name | Type | Default | Description |
---|---|---|---|
type | string | The event type id. | |
listener | function | Callback method. | |
useCapture | boolean | false | Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing |
listenerScope | Object | Object in whose scope to call the listener. |
Returns:
Object - Unique key for the listener.Try it:
middleRadius
Returns:
string - Middle radius.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | null | number | string | undefined | Value to set. |
Returns:
anychart.core.gauge.pointers.Needle - Self instance for method chaining.Try it:
middleWidth
Returns:
string - Middle width.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | null | number | string | undefined | Value to set. |
Returns:
anychart.core.gauge.pointers.Needle - Self instance for method chaining.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
paperSizeOrOptions | anychart.graphics.vector.PaperSize | Object | Paper size or object with options. | |
landscape | boolean | false | Flag of landscape. |
Try it:
removeAllListeners
Params:
Name | Type | Description |
---|---|---|
type | string | Type of event to remove, default is to remove all types. |
Returns:
number - Number of listeners removed.Try it:
startRadius
Returns:
string - Start radius.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | null | number | string | undefined | Value to set. |
Returns:
anychart.core.gauge.pointers.Needle - Self instance for method chaining.Try it:
startWidth
Returns:
string - Start width.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | null | number | string | undefined | Value to set. |
Returns:
anychart.core.gauge.pointers.Needle - Self instance for method chaining.Try it:
stroke
Returns:
anychart.graphics.vector.Stroke | function - Stroke settings.Try it:
Params:
Name | Type | Description |
---|---|---|
strokeFunction | function | 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:
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 | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
lineCap | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.core.gauge.pointers.Needle - Self instance for method chaining.Try it:
unlisten
Params:
Name | Type | Default | Description |
---|---|---|---|
type | string | The event type id. | |
listener | function | Callback method. | |
useCapture | boolean | false | Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing |
listenerScope | Object | Object in whose scope to call the listener. |
Returns:
boolean - Whether any listener was removed.Try it:
unlistenByKey
Params:
Name | Type | Description |
---|---|---|
key | Object | The key returned by listen() or listenOnce(). |
Returns:
boolean - Whether any listener was removed.Try it:
zIndex
Returns:
number - The current zIndex.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | 0 | Value to set. |
Returns:
anychart.core.gauge.pointers.Needle - Self instance for method chaining.Try it: