Top
You are looking at an outdated 7.14.0 version of this document. Switch to the 8.0.1 version to see the up to date information.

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

Extends: anychart.core.VisualBase

Base pointer class for all pointers.

Methods Overview

Specific settings
axisIndex()Axis index.
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

Getter for the axis index.

Returns:

number - Axis index.

Try it:

Setter for the axis index.

Params:

Name Type Default Description
index number
0
Value to set.

Returns:

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

Try it:

dataIndex

Getter for the data index.

Returns:

number - Data index.

Try it:

Setter for the data index.

Params:

Name Type Default Description
index number
0
Value to set.

Returns:

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

Try it:

enabled

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

Returns:

boolean - The current element state.

Try it:

Setter for the element enabled state.

Params:

Name Type Default Description
value boolean
true
Value to set.

Returns:

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

Try it:

fill

Getter for the pointer fill color.

Returns:

anychart.graphics.vector.Fill - Fill color.

Try it:

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.Base - Self instance for method chaining.
Pointer fill color with opacity.
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.Base - 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.Base - 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.Base - 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.Base - Self instance for method chaining.

Try it:

hatchFill

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

Try it:

listen

Adds an event listener to an implementing object.

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

Adds an event listener to an implementing object.

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:

print

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:

removeAllListeners

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:

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 Function for stroke. In the function can be used radius for bars, angle for needles.

Returns:

anychart.core.gauge.pointers.Base - 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 anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCap anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

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

Try it:

unlisten

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.

Returns:

boolean - Whether any listener was removed.

Try it:

unlistenByKey

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

Params:

Name Type Description
key Object The key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

Try it:

zIndex

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.

Try it:

Setter for the Z-index of the element.

Params:

Name Type Default Description
value number
0
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it: