class anychart.core.linearGauge.ScaleBar Improve this Doc

Base class for scale bar.

Methods Overview

Axes and Scales
colorScale()	Color scale settings.
scale()	Scale settings.
Coloring
fill()	Fill settings.
stroke()	Stroke settings.
Size and Position
from()	Starting range value.
offset()	Offset settings.
points()	Points settings.
to()	Ending range value.
width()	Width settings.
zIndex()	Z-index of the element.

Methods Description

colorScale

colorScale()Since version 7.11.0

Getter for the color scale.

Returns:

anychart.scales.LinearColor | anychart.scales.OrdinalColor - The color scale.

See listing

var scaleBar = chart.scaleBar();
var colorScale = scaleBar.colorScale();

colorScale(settings)Since version 7.11.0

Setter for the color scale.

Params:

Name	Type	Description
settings	anychart.scales.LinearColor \| anychart.scales.OrdinalColor \| Object \| anychart.enums.ScaleTypes \| string	Color scale settings.

Returns:

anychart.core.linearGauge.ScaleBar - Self instance for method chaining.

Try it:

Usage sample

fill

fill()Since version 7.11.0

Getter for the scale bar fill color.

Detailed description

This method can be used as getter only if you have set its value.

Returns:

anychart.graphics.vector.Fill - The fill color.

Try it:

Usage sample

fill(color)Since version 7.11.0

Setter for fill settings using an array, an object or a string. Learn more about coloring.

Params:

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

Returns:

anychart.core.linearGauge.ScaleBar - Self instance for method chaining.

Try it:

fill(color, opacity)Since version 7.11.0

Fill color with opacity.

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

Try it:

Usage sample

fill(keys, angle, mode, opacity)Since version 7.11.0

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

Try it:

Usage sample

fill(keys, cx, cy, mode, opacity, fx, fy)Since version 7.11.0

Radial gradient 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.linearGauge.ScaleBar - Self instance for method chaining.

Try it:

Usage sample

fill(imageSettings)Since version 7.11.0

Image fill. Learn more about coloring.

Params:

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

Returns:

anychart.core.linearGauge.ScaleBar - Self instance for method chaining.

Try it:

Usage sample

from

from()Since version 7.11.0

Getter for the starting range value.

Returns:

string | number - Starting range value.

Try it:

Usage sample

from(fromValue)Since version 7.11.0

Setter for the starting range value.

Detailed description

If set as string value will be treated as percent ('55%') or as 'min' or 'max'. If set as an integer will be treated as value of scale. But will not extend scale.

Params:

Name	Type	Description
fromValue	string \| number	'From' value to set. In case of string it can be 'max' or 'min'. In case of number - ratio (from 0 to 1).

Returns:

anychart.core.linearGauge.ScaleBar - Self instance for method chaining.

Try it:

Usage sample

offset

offset()Since version 7.11.0

Getter for scale bar offset.

Returns:

string - The scale bar offset.

Try it:

Usage sample

offset(offset)Since version 7.11.0

Setter for scale bar offset.

Params:

Name	Type	Default	Description
offset	string	'0%'	Offset value in percent.

Returns:

anychart.core.linearGauge.ScaleBar - Self instance for method chaining.

Try it:

Usage sample

points

points()Since version 7.11.0

Getter for points.

Returns:

Array.<anychart.core.linearGauge.ScaleBar.ControlPoint> - Points.

See listing.

var scaleBar = chart.scaleBar();
var points = scaleBar.points();

points(pointsList)Since version 7.11.0

Setter for points.

Params:

Name	Type	Description
pointsList	Array.<anychart.core.linearGauge.ScaleBar.ControlPoint>	Points to set.

Returns:

anychart.core.linearGauge.ScaleBar - Self instance for method chaining.

Try it:

Usage sample

scale

scale()Since version 7.11.0

Getter for the scale bar scale.

Returns:

anychart.scales.Base - Scale bar scale.

See listing

var scaleBar = chart.scaleBar();
var scale = scaleBar.scale();

scale(scale)Since version 7.11.0

Setter for the scale bar scale.

Params:

Name	Type	Default	Description
scale	anychart.scales.Base	anychart.scales.Linear	Scale for the scale bar.

Returns:

anychart.scales.Base - Self instance for method chaining.

Try it:

Usage sample

stroke

stroke()Since version 7.11.0

Getter for stroke settings.

Detailed description

This method can be used as getter only if you have set its value.

Returns:

anychart.graphics.vector.Stroke - Stroke settings.

Try it:

Usage sample

stroke(color, thickness, dashpattern, lineJoin, lineCap)Since version 7.11.0

Setter for stroke settings. Learn more about stroke settings.

Detailed description

If you first set the anychart.core.linearGauge.ScaleBar#fill or anychart.core.linearGauge.ScaleBar#stroke color and then a anychart.core.linearGauge.ScaleBar#colorScale, the priority will be given to the color set by anychart.core.linearGauge.ScaleBar#fill or anychart.core.linearGauge.ScaleBar#stroke.

Params:

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

Returns:

anychart.core.linearGauge.ScaleBar - Self instance for method chaining.

Try it:

Usage sample

stroke(settings)Since version 7.11.0

Setter for the grid stroke using an object.

Params:

Name	Type	Description
settings	Object	Stroke settings from anychart.graphics.vector.Stroke.

Returns:

anychart.core.linearGauge.ScaleBar - Self instance for method chaining.

Try it:

Usage sample

to

to()Since version 7.11.0

Getter for the ending range value.

Returns:

string | number - Ending range value.

Try it:

Usage sample

to(toValue)Since version 7.11.0

Setter for the ending range value.

Detailed description

If set as string value will be treated as percent ('55%') or as 'min' or 'max'. If set as an integer will be treated as value of scale. But will not extend scale.

Params: