AnyChart
API Reference
Still have questions?
Contact support
Top
You are looking at an outdated v7 version of this document. Switch to the v8 version to see the up to date information.

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

Extends: anychart.core.gauge.pointers.Base

Marker pointer class.

Methods Overview

Specific settings
axisIndex()Axis index.
type()Marker type.
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
position()Marker position.
radius()Marker radius.
size()Marker size.
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.Marker - 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.Marker - Self instance for method chaining.

enabled

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

Returns:

boolean - The current element state.
Setter for the element enabled state.

Params:

NameTypeDefaultDescription
valueboolean
true
Value to set.

Returns:

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

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
valueanychart.graphics.vector.Fill
"#f22922"
Color as an object or a string.

Returns:

anychart.core.gauge.pointers.Marker - 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.Marker - 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.Marker - 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.Marker - 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.Marker - 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
patternFillOrTypeanychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | anychart.graphics.vector.HatchFill.HatchFillType | string | boolean
false
PatternFill or HatchFill instance or type of hatch fill.
colorstring
Color.
thicknessnumber
Thickness.
sizenumber
Pattern size.

Returns:

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

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
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
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.

position

Getter for the marker position.

Returns:

anychart.enums.GaugeSidePosition | string - Marker position.
Setter for the marker position.

Params:

NameTypeDefaultDescription
valueanychart.enums.GaugeSidePosition | string
"inside"
Value to set.

Returns:

anychart.core.gauge.pointers.Marker - 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.

radius

Getter for the marker radius.

Returns:

string - Marker radius.
Setter for the marker radius.

Params:

NameTypeDefaultDescription
valuenull | number | string
undefined
Value to set.

Returns:

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

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.

size

Getter for the marker size.

Returns:

string - Marker size.
Setter for the marker size.

Params:

NameTypeDefaultDescription
valuenull | number | string
"4%"
Value to set.

Returns:

anychart.core.gauge.pointers.Marker - 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
strokeFunctionfunctionFunction for stroke. In the function can be used radius for bars, angle for needles.

Returns:

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

Returns:

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

type

Getter for the marker type.

Returns:

anychart.enums.MarkerType | function - Marker type.
Setter for the marker type.

Params:

NameTypeDefaultDescription
valueanychart.enums.MarkerType | function | string
"triangleUp"
Value to set.

Returns:

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

unlisten

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

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
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 current Z-index of the element.

Returns:

number - The current zIndex.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
valuenumber
0
Value to set.

Returns:

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