AnyChart
API Reference
Still have questions?
Contact support
Top

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

Getter for the axis index.

Returns:

number - Axis index.
Setter for the axis index.

Params:

NameTypeDefaultDescription
indexnumber
0
Value to set.

Returns:

anychart.core.gauge.pointers.Needle - Self instance for method chaining.

data

Getter for pointers data.

Returns:

anychart.data.View - Pointers data.
See listing
var pointer = pointer.data();
Setter for pointers data.

Params:

NameTypeDescription
dataanychart.data.View | anychart.data.Set | Array | stringValue to set.
csvSettingsanychart.enums.TextParsingMode | anychart.data.TextParsingSettingsIf 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

Getter for the data index.

Returns:

number - Data index.
Setter for the data index.

Params:

NameTypeDefaultDescription
indexnumber
0
Value to set.

Returns:

anychart.core.gauge.pointers.Needle - Self instance for method chaining.

enabled

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.
Setter for the element enabled state.

Params:

NameTypeDefaultDescription
enabledboolean
true
Enabled state to set.

Returns:

anychart.core.gauge.pointers.Needle - Self instance for method chaining.
Example.
if (!element.enabled())
   element.enabled(true);

endRadius

Getter for the end radius.

Returns:

string - End radius.
Setter for the end radius.

Params:

NameTypeDefaultDescription
radiusnumber | string
undefined
End radius to set.

Returns:

anychart.core.gauge.pointers.Needle - Self instance for method chaining.

endWidth

Getter for the end width.

Returns:

string - End width.
Setter for the end width.

Params:

NameTypeDefaultDescription
widthnumber | string
undefined
End width to set.

Returns:

anychart.core.gauge.pointers.Needle - Self instance for method chaining.

fill

Getter for the pointer fill color.

Returns:

anychart.graphics.vector.Fill - Fill color.
Sets pointer fill settings using an array or a string. Learn more about coloring.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)>
'#f22922'
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.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.gauge.pointers.Needle - Self instance for method chaining.
Linear gradient pointer fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.core.gauge.pointers.Needle - Self instance for method chaining.
Radial gradient pointer fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

anychart.core.gauge.pointers.Needle - Self instance for method chaining.
Image pointer fill. Learn more about coloring.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

anychart.core.gauge.pointers.Needle - Self instance for method chaining.

hatchFill

Getter for hatch fill settings.
See listing.
var hatchFill = knob.hatchFill();
Setter for hatch fill settings. Learn more about hatch fill settings.

Params:

NameTypeDefaultDescription
typeanychart.graphics.vector.HatchFill.HatchFillType | string
false
Type of hatch fill.
colorstring
Color.
thicknessnumber
Thickness.
sizenumber
Pattern size.

Returns:

anychart.core.gauge.pointers.Needle - Self instance for method chaining.
Setter for hatch fill settings using pattern fill. Learn more about coloring.

Params:

NameTypeDescription
patternFillanychart.graphics.vector.PatternFillPattern fill to set.

Returns:

anychart.core.gauge.pointers.Needle - Self instance for method chaining.
Setter for hatch fill settings using an instance. Learn more about coloring.

Params:

NameTypeDescription
settingsanychart.graphics.vector.HatchFillHatch fill instance.

Returns:

anychart.core.gauge.pointers.Needle - Self instance for method chaining.
Setter for hatch fill using boolean. Learn more about hatch fill settings.

Params:

NameTypeDefaultDescription
enabledboolean
false
Whether to enable hatch fill or no.

Returns:

anychart.core.gauge.pointers.Needle - Self instance for method chaining.

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:

NameTypeDefaultDescription
idstring | number
0
Pointer id to set.

Returns:

anychart.core.gauge.pointers.Needle - Self instance for method chaining.

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
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
}
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

middleRadius

Getter for the middle radius.

Returns:

string - Middle radius.
Setter for the middle radius.

Params:

NameTypeDefaultDescription
radiusnumber | string
undefined
Middle radius to set.

Returns:

anychart.core.gauge.pointers.Needle - Self instance for method chaining.

middleWidth

Getter for the middle width.

Returns:

string - Middle width.
Setter for the middle width.

Params:

NameTypeDefaultDescription
widthnumber | string
'1%'
Middle width to set.

Returns:

anychart.core.gauge.pointers.Needle - Self instance for method chaining.

print

Prints all elements on related stage.

Params:

NameTypeDefaultDescription
paperSizeOrOptionsanychart.graphics.vector.PaperSize | Object
Paper size or object with options.
landscapeboolean
false
Flag of landscape.

removeAllListeners

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

Params:

NameTypeDescription
typestringType of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

startRadius

Getter for the start radius.

Returns:

string - Start radius.
Setter for the start radius.

Params:

NameTypeDefaultDescription
radiusnumber | string
'-20%'
Start radius to set.

Returns:

anychart.core.gauge.pointers.Needle - Self instance for method chaining.

startWidth

Getter for the start width.

Returns:

string - Start width.
Setter for the start width.

Params:

NameTypeDefaultDescription
widthnumber | string
'3%'
Start width to set.

Returns:

anychart.core.gauge.pointers.Needle - Self instance for method chaining.

stroke

Getter for the pointer stroke.

Returns:

anychart.graphics.vector.Stroke | function - Stroke settings.
Setter for the pointer stroke by function.

Params:

NameTypeDescription
strokeFunctionfunction():anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFillFunction 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.
Setter for stroke settings. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
'#f22922'
Stroke settings.
thicknessnumber
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.core.gauge.pointers.Needle - Self instance for method chaining.
Setter for the stroke using an object.

Params:

NameTypeDescription
settingsObjectStroke settings from anychart.graphics.vector.Stroke.

Returns:

anychart.core.gauge.pointers.Needle - Self instance for method chaining.

unlisten

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

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object):boolean|undefined
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

unlistenByKey

Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().

Params:

NameTypeDescription
keyObjectThe key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

zIndex

Getter for the Z-index of the element.

Returns:

number - Z-index.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
zIndexnumber
0
Value to set.

Returns:

anychart.core.gauge.pointers.Needle - Self instance for method chaining.