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

axisIndex()

Getter for the axis index.

Returns:

number - Axis index.

Try it:

Usage sample

axisIndex(index)

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:

Usage sample

dataIndex

dataIndex()

Getter for the data index.

Returns:

number - Data index.

Try it:

Usage sample

dataIndex(index)

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:

Usage sample

enabled

enabled()

Getter for the current element state (enabled or disabled).

Returns:

boolean - The current element state.

Try it:

Usage sample

Name	Type	Default	Description
value	boolean	true	Value to set.

endRadius

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:

Usage sample

endRadius(value)

Setter for the end radius.

Detailed description

Null returns auto calculated end radius.

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:

Usage sample

endWidth

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:

Usage sample

endWidth(value)

Setter for the end width.

Detailed description

Null returns auto calculated end width.

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:

Usage sample

fill

fill()

Getter for the pointer fill color.

Returns:

anychart.graphics.vector.Fill - Fill color.

Try it:

Usage sample

fill(value)

Sets pointer fill settings using an array or a string. Learn more about coloring.

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(color, opacity)

Pointer 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.gauge.pointers.Needle - Self instance for method chaining.

Try it:

Usage sample

fill(keys, angle, mode, opacity)

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:

Usage sample

fill(keys, cx, cy, mode, opacity, fx, fy)

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:

Usage sample

fill(imageSettings)

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:

Usage sample

hatchFill

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();

hatchFill(patternFillOrType, color, thickness, size)

Setter for hatch fill settings. Learn more about hatch fill settings.

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:

Usage sample

listen

listen(type, listener, useCapture, listenerScope)

Adds an event listener to an implementing object.

Detailed description

The listener can be added to an object once, and if it is added one more time, its key will be returned.
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:

Usage sample

listenOnce

listenOnce(type, listener, useCapture, listenerScope)

Adds an event listener to an implementing object.

Detailed description

After the event is called, its handler will be deleted.
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:

Usage sample

middleRadius

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:

Usage sample

middleRadius(value)

Setter for the middle radius.

Detailed description

Null returns auto calculated middle radius.

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:

Usage sample

middleWidth

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:

Usage sample

middleWidth(value)

Setter for the middle width

Detailed description

Null returns auto calculated bar pointer radius.

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:

Usage sample

print

print(paperSizeOrOptions, landscape)

Prints all elements on related stage.

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:

Usage sample

removeAllListeners

removeAllListeners(type)

Removes all listeners from an object. You can also optionally remove listeners of some particular type.

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:

Usage sample

startRadius

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:

Usage sample

startRadius(value)

Setter for the start radius.

Detailed description

Null returns auto calculated start radius.

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:

Usage sample

startWidth

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:

Usage sample

startWidth(value)

Setter for the start width

Detailed description

Null returns auto calculated bar pointer radius.

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:

Usage sample

stroke

stroke()

Getter for the pointer stroke.

Returns:

anychart.graphics.vector.Stroke | function - Stroke settings.

Try it:

Usage sample

stroke(strokeFunction)

Setter for the pointer stroke by function.

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:

Usage sample

stroke(color, thickness, dashpattern, lineJoin, lineCap)

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	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:

Usage sample

unlisten

unlisten(type, listener, useCapture, listenerScope)

Removes a listener added using listen() or listenOnce() methods.

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.