class anychart.core.gauge.pointers.Knob Improve this Doc

Extends: anychart.core.gauge.pointers.Base

Knob pointer class.

Methods Overview

Specific Settings
id()	Pointer id.
Specific settings
axisIndex()	Axis index.
bottomRatio()	Bottom ratio.
topRatio()	Top ratio.
verticesCount()	Vertices count.
verticesCurvature()	Vertices curvature.
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
bottomRadius()	Bottom radius.
topRadius()	Top radius.
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.Knob - Self instance for method chaining.

Try it:

Usage sample

bottomRadius

bottomRadius()

Getter for the bottom radius.

Detailed description

This method can be used as getter only if the value has been previously set.

Returns:

string - Bottom radius.

Try it:

Usage sample

bottomRadius(radius)

Setter for the bottom radius.

Detailed description

Null returns auto calculated top radius.

Params:

Name	Type	Default	Description
radius	number \| string	undefined	Bottom radius to set.

Returns:

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

Try it:

Usage sample

bottomRatio

bottomRatio()

Getter for the bottom ratio.

Returns:

number - Bottom ratio.

Try it:

Usage sample

bottomRatio(ratio)

Setter for the bottom ratio.

Params:

Name	Type	Default	Description
ratio	number	0.5	Bottom ratio to set.

Returns:

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

Try it:

Usage sample

data

data()Since version 8.2.0

Getter for pointers data.

Returns:

anychart.data.View - Pointers data.

See listing

var pointer = pointer.data();

data(data, csvSettings)Since version 8.2.0

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.Knob - Self instance for method chaining.

Try it:

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.Knob - Self instance for method chaining.

Try it:

Usage sample

enabled

enabled()

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.

Try it:

Usage sample

enabled(enabled)

Setter for the element enabled state.

Params:

Name	Type	Default	Description
enabled	boolean	true	Enabled state to set.

Returns:

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

Example.

if (!element.enabled())
   element.enabled(true);

Try it:

Usage sample

fill

fill()

Getter for the pointer fill color.

Returns:

anychart.graphics.vector.Fill - Fill color.

Try it:

Usage sample

fill(color)

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

Params:

Name	Type	Default	Description
color	anychart.graphics.vector.Fill \| Array.<(anychart.graphics.vector.GradientKey\|string)>	'#f22922'	Color as an object or a string.

Returns:

anychart.core.gauge.pointers.Knob - 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.Knob - 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.Knob - 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.Knob - 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.Knob - 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(type, color, thickness, size)

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.Knob - Self instance for method chaining.

Try it:

Usage sample

hatchFill(patternFill)

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.Knob - Self instance for method chaining.

Try it:

Usage sample

hatchFill(settings)

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.Knob - Self instance for method chaining.

Try it:

Usage sample

hatchFill(enabled)

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.Knob - Self instance for method chaining.

Try it:

Usage sample

id

id()Since version 8.2.0

Getter for the pointer id.

Returns:

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

See listing

var id = pointer.id();

id(id)Since version 8.2.0

Setter for the pointer id.

Params:

Name	Type	Default	Description
id	string \| number	0	Pointer id to set.

Returns:

anychart.core.gauge.pointers.Knob - 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():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.Knob - 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	string \| anychart.graphics.vector.StrokeLineJoin		Line join style.
lineCap	string \| anychart.graphics.vector.StrokeLineCap		Line cap style.