class anychart.core.gauge.Cap Improve this Doc

Cap class.

Methods Overview

Coloring
fill()	Fill settings.
hatchFill()	Hatch fill settings.
stroke()	Stroke settings.
Interactivity
enabled()	Element state (enabled or disabled).
Size and Position
radius()	Cap radius settings.
zIndex()	Z-index of the element.

Methods Description

enabled

enabled()

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.

enabled(enabled)

Setter for the element enabled state.

Params:

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

Returns:

anychart.core.gauge.Cap - Self instance for method chaining.

Example.

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

Try it:

Usage sample

fill

fill()

Getter for the cap fill color.

Returns:

anychart.graphics.vector.Fill - Fill color.

Try it:

Usage sample

fill(color)

Setter for cap 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)>	'#EAEAEA'	Color as an object, an array or a string.

Returns:

anychart.core.gauge.Cap - Self instance for method chaining.

Try it:

fill(color, opacity)

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

Try it:

Usage sample

fill(keys, angle, mode, opacity)

Linear gradient cap 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.Cap - Self instance for method chaining.

Try it:

Usage sample

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

Radial cap 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.Cap - Self instance for method chaining.

Try it:

Usage sample

fill(imageSettings)

Image cap fill. Learn more about coloring.

Params:

Name	Type	Description
imageSettings	anychart.graphics.vector.Fill	Object with settings.

Returns:

anychart.core.gauge.Cap - Self instance for method chaining.

Try it:

Usage sample

hatchFill

hatchFill()

Getter for cap hatch fill settings.

Returns:

anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | boolean - Hatch fill settings.

See listing

var cap = chart.cap();
var hatchFill = cap.hatchFill();

hatchFill(type, color, thickness, size)

Setter for cap 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.Cap - Self instance for method chaining.

Try it:

Usage sample

hatchFill(patternFill)

Setter for cap 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.Cap - Self instance for method chaining.

Try it:

Usage sample

hatchFill(settings)

Setter for cap 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.Cap - Self instance for method chaining.

Try it:

Usage sample

hatchFill(enabled)

Setter for cap 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.Cap - Self instance for method chaining.

Try it:

Usage sample

radius

radius()

Getter for the cap radius.

Returns:

string - Cap radius.

Try it:

Usage sample

radius(radius)

Setter for the cap radius.

Params:

Name	Type	Default	Description
radius	number \| string	'15%'	Value to set.

Returns:

anychart.core.gauge.Cap - Self instance for method chaining.

Try it:

Usage sample

stroke

stroke()

Getter for the cap stroke.

Returns:

anychart.graphics.vector.Stroke - Stroke settings.

Try it:

Usage sample

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

Setter for cap stroke settings. Learn more about stroke settings.

Params:

Name	Type	Default	Description
color	anychart.graphics.vector.Stroke \| anychart.graphics.vector.ColoredFill \| string \| null	'#CECECE'	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.