
public class ScaleBar
extends VisualBase

Base class for scale bar.

Constructor Summary

Constructors
Constructor	Description
`ScaleBar(String jsChart)`

Method Summary

Modifier and Type	Method	Description
`static ScaleBar`	`instantiate()`
`String`	`getJsBase()`
`LinearColor`	`colorScale()`	Getter for the color scale.
`ScaleBar`	`colorScale(LinearColor settings)`	Setter for the color scale.
`ScaleBar`	`colorScale(OrdinalColor settings)`	Setter for the color scale.
`ScaleBar`	`colorScale(String settings)`	Setter for the color scale.
`ScaleBar`	`colorScale(ScaleTypes settings)`	Setter for the color scale.
`void`	`fill()`	Getter for the scale bar fill color.
`ScaleBar`	`fill(Fill color)`	Setter for fill settings using an array, an object or a string.
`ScaleBar`	`fill(GradientKey color)`	Setter for fill settings using an array, an object or a string.
`ScaleBar`	`fill(Array<String> color)`	Setter for fill settings using an array, an object or a string.
`ScaleBar`	`fill(String color, Number opacity)`	Fill color with opacity.
`ScaleBar`	`fill(GradientKey keys, Number angle, Boolean mode, Number opacity)`	Linear gradient fill.
`ScaleBar`	`fill(GradientKey keys, Number angle, Rect mode, Number opacity)`	Linear gradient fill.
`ScaleBar`	`fill(GradientKey keys, Number angle, String mode, Number opacity)`	Linear gradient fill.
`ScaleBar`	`fill(Array<String> keys, Number angle, Boolean mode, Number opacity)`	Linear gradient fill.
`ScaleBar`	`fill(Array<String> keys, Number angle, Rect mode, Number opacity)`	Linear gradient fill.
`ScaleBar`	`fill(Array<String> keys, Number angle, String mode, Number opacity)`	Linear gradient fill.
`ScaleBar`	`fill(GradientKey keys, Number cx, Number cy, Rect mode, Number opacity, Number fx, Number fy)`	Radial gradient fill.
`ScaleBar`	`fill(Array<String> keys, Number cx, Number cy, Rect mode, Number opacity, Number fx, Number fy)`	Radial gradient fill.
`void`	`from()`	Getter for the starting range value.
`ScaleBar`	`from(String fromValue)`	Setter for the starting range value.
`ScaleBar`	`from(Number fromValue)`	Setter for the starting range value.
`void`	`offset()`	Getter for scale bar offset.
`ScaleBar`	`offset(String offset)`	Setter for scale bar offset.
`void`	`points()`	Getter for points.
`ScaleBar`	`points(Array<ControlPoint> pointsList)`	Setter for points.
`Base`	`scale()`	Getter for the scale bar scale.
`Base`	`scale(Base scale)`	Setter for the scale bar scale.
`void`	`stroke()`	Getter for stroke settings.
`ScaleBar`	`stroke(Stroke color, Number thickness, String dashpattern, String lineJoin, String lineCap)`	Setter for stroke settings.
`ScaleBar`	`stroke(Stroke color, Number thickness, String dashpattern, String lineJoin, StrokeLineCap lineCap)`	Setter for stroke settings.
`ScaleBar`	`stroke(Stroke color, Number thickness, String dashpattern, StrokeLineJoin lineJoin, String lineCap)`	Setter for stroke settings.
`ScaleBar`	`stroke(Stroke color, Number thickness, String dashpattern, StrokeLineJoin lineJoin, StrokeLineCap lineCap)`	Setter for stroke settings.
`ScaleBar`	`stroke(ColoredFill color, Number thickness, String dashpattern, String lineJoin, String lineCap)`	Setter for stroke settings.
`ScaleBar`	`stroke(ColoredFill color, Number thickness, String dashpattern, String lineJoin, StrokeLineCap lineCap)`	Setter for stroke settings.
`ScaleBar`	`stroke(ColoredFill color, Number thickness, String dashpattern, StrokeLineJoin lineJoin, String lineCap)`	Setter for stroke settings.
`ScaleBar`	`stroke(ColoredFill color, Number thickness, String dashpattern, StrokeLineJoin lineJoin, StrokeLineCap lineCap)`	Setter for stroke settings.
`ScaleBar`	`stroke(String color, Number thickness, String dashpattern, String lineJoin, String lineCap)`	Setter for stroke settings.
`ScaleBar`	`stroke(String color, Number thickness, String dashpattern, String lineJoin, StrokeLineCap lineCap)`	Setter for stroke settings.
`ScaleBar`	`stroke(String color, Number thickness, String dashpattern, StrokeLineJoin lineJoin, String lineCap)`	Setter for stroke settings.
`ScaleBar`	`stroke(String color, Number thickness, String dashpattern, StrokeLineJoin lineJoin, StrokeLineCap lineCap)`	Setter for stroke settings.
`ScaleBar`	`stroke(String settings)`	Setter for the grid stroke using an object.
`void`	`to()`	Getter for the ending range value.
`ScaleBar`	`to(String toValue)`	Setter for the ending range value.
`ScaleBar`	`to(Number toValue)`	Setter for the ending range value.
`void`	`width()`	Getter for the scale bar width.
`ScaleBar`	`width(String width)`	Setter for the scale bar width.
`Layer`	`container()`	Getter for the container.
`ScaleBar`	`container(Layer element)`	Setter for the container.
`ScaleBar`	`container(Stage element)`	Setter for the container.
`ScaleBar`	`container(String element)`	Setter for the container.
`void`	`enabled()`	Getter for the element state (enabled or disabled).
`ScaleBar`	`enabled(Boolean enabled)`	Setter for the element enabled state.
`Rect`	`parentBounds()`	Getter for the parent bounds.
`ScaleBar`	`parentBounds(Rect bounds)`	Setter for the parent bounds using single value.
`ScaleBar`	`parentBounds(String bounds)`	Setter for the parent bounds using single value.
`ScaleBar`	`parentBounds(Number bounds)`	Setter for the parent bounds using single value.
`ScaleBar`	`parentBounds(Number left, Number top, Number width, Number height)`	Setter for the parent bounds using several values.
`void`	`print(PaperSize paperSizeOrOptions, Boolean landscape)`	Prints all elements on related stage.
`void`	`print(String paperSizeOrOptions, Boolean landscape)`	Prints all elements on related stage.
`void`	`removeAllListeners(String type)`	Removes all listeners from an object.
`void`	`setOnClickListener(ListenersInterface.OnClickListener listener)`
`void`	`setOnClickListener(ListenersInterface.OnClickListener listener, String type, String ePath)`
`void`	`unlistenByKey(String key)`	Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().
`void`	`zIndex()`	Getter for the Z-index of the element.
`ScaleBar`	`zIndex(Number zIndex)`	Setter for the Z-index of the element.
`ScaleBar`	`fill(String value)`

Methods inherited from class com.anychart.core.VisualBase
container, container, container, enabled, instantiate, parentBounds, parentBounds, parentBounds, parentBounds, zIndex
Methods inherited from class com.anychart.core.Base
instantiate
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ScaleBar
```
ScaleBar(String jsChart)
```
- Method Detail
  - instantiate
```
 static ScaleBar instantiate()
```
  - getJsBase
```
 String getJsBase()
```
  - colorScale
```
 LinearColor colorScale()
```
    Getter for the color scale.
  - colorScale
```
 ScaleBar colorScale(LinearColor settings)
```
    Setter for the color scale.
  - colorScale
```
 ScaleBar colorScale(OrdinalColor settings)
```
    Setter for the color scale.
  - colorScale
```
 ScaleBar colorScale(String settings)
```
    Setter for the color scale.
  - colorScale
```
 ScaleBar colorScale(ScaleTypes settings)
```
    Setter for the color scale.
  - fill
```
 void fill()
```
    Getter for the scale bar fill color.
  - fill
```
 ScaleBar fill(Fill color)
```
    Setter for fill settings using an array, an object or a string. {docs:Graphics/Fill_Settings}Learn more about coloring.{docs}
  - fill
```
 ScaleBar fill(GradientKey color)
```
    Setter for fill settings using an array, an object or a string. {docs:Graphics/Fill_Settings}Learn more about coloring.{docs}
  - fill
```
 ScaleBar fill(Array<String> color)
```
    Setter for fill settings using an array, an object or a string. {docs:Graphics/Fill_Settings}Learn more about coloring.{docs}
  - fill
```
 ScaleBar fill(String color, Number opacity)
```
    Fill color with opacity.
  - fill
```
 ScaleBar fill(GradientKey keys, Number angle, Boolean mode, Number opacity)
```
    Linear gradient fill. {docs:Graphics/Fill_Settings}Learn more about coloring.{docs}
  - fill
```
 ScaleBar fill(GradientKey keys, Number angle, Rect mode, Number opacity)
```
    Linear gradient fill. {docs:Graphics/Fill_Settings}Learn more about coloring.{docs}
  - fill
```
 ScaleBar fill(GradientKey keys, Number angle, String mode, Number opacity)
```
    Linear gradient fill. {docs:Graphics/Fill_Settings}Learn more about coloring.{docs}
  - fill
```
 ScaleBar fill(Array<String> keys, Number angle, Boolean mode, Number opacity)
```
    Linear gradient fill. {docs:Graphics/Fill_Settings}Learn more about coloring.{docs}
  - fill
```
 ScaleBar fill(Array<String> keys, Number angle, Rect mode, Number opacity)
```
    Linear gradient fill. {docs:Graphics/Fill_Settings}Learn more about coloring.{docs}
  - fill
```
 ScaleBar fill(Array<String> keys, Number angle, String mode, Number opacity)
```
    Linear gradient fill. {docs:Graphics/Fill_Settings}Learn more about coloring.{docs}
  - fill
```
 ScaleBar fill(GradientKey keys, Number cx, Number cy, Rect mode, Number opacity, Number fx, Number fy)
```
    Radial gradient fill. {docs:Graphics/Fill_Settings}Learn more about coloring.{docs}
  - fill
```
 ScaleBar fill(Array<String> keys, Number cx, Number cy, Rect mode, Number opacity, Number fx, Number fy)
```
    Radial gradient fill. {docs:Graphics/Fill_Settings}Learn more about coloring.{docs}
  - from
```
 void from()
```
    Getter for the starting range value.
  - from
```
 ScaleBar from(String fromValue)
```
    Setter for the starting range value.
  - from
```
 ScaleBar from(Number fromValue)
```
    Setter for the starting range value.
  - offset
```
 void offset()
```
    Getter for scale bar offset.
  - offset
```
 ScaleBar offset(String offset)
```
    Setter for scale bar offset.
  - points
```
 void points()
```
    Getter for points.
  - points
```
 ScaleBar points(Array<ControlPoint> pointsList)
```
    Setter for points.
  - scale
```
 Base scale()
```
    Getter for the scale bar scale.
  - scale
```
 Base scale(Base scale)
```
    Setter for the scale bar scale.
  - stroke
```
 void stroke()
```
    Getter for stroke settings.
  - stroke
```
 ScaleBar stroke(Stroke color, Number thickness, String dashpattern, String lineJoin, String lineCap)
```
    Setter for stroke settings. {docs:Graphics/Stroke_Settings}Learn more about stroke settings.{docs}
  - stroke
```
 ScaleBar stroke(Stroke color, Number thickness, String dashpattern, String lineJoin, StrokeLineCap lineCap)
```
    Setter for stroke settings. {docs:Graphics/Stroke_Settings}Learn more about stroke settings.{docs}
  - stroke
```
 ScaleBar stroke(Stroke color, Number thickness, String dashpattern, StrokeLineJoin lineJoin, String lineCap)
```
    Setter for stroke settings. {docs:Graphics/Stroke_Settings}Learn more about stroke settings.{docs}
  - stroke
```
 ScaleBar stroke(Stroke color, Number thickness, String dashpattern, StrokeLineJoin lineJoin, StrokeLineCap lineCap)
```
    Setter for stroke settings. {docs:Graphics/Stroke_Settings}Learn more about stroke settings.{docs}
  - stroke
```
 ScaleBar stroke(ColoredFill color, Number thickness, String dashpattern, String lineJoin, String lineCap)
```
    Setter for stroke settings. {docs:Graphics/Stroke_Settings}Learn more about stroke settings.{docs}
  - stroke
```
 ScaleBar stroke(ColoredFill color, Number thickness, String dashpattern, String lineJoin, StrokeLineCap lineCap)
```
    Setter for stroke settings. {docs:Graphics/Stroke_Settings}Learn more about stroke settings.{docs}
  - stroke
```
 ScaleBar stroke(ColoredFill color, Number thickness, String dashpattern, StrokeLineJoin lineJoin, String lineCap)
```
    Setter for stroke settings. {docs:Graphics/Stroke_Settings}Learn more about stroke settings.{docs}
  - stroke
```
 ScaleBar stroke(ColoredFill color, Number thickness, String dashpattern, StrokeLineJoin lineJoin, StrokeLineCap lineCap)
```
    Setter for stroke settings. {docs:Graphics/Stroke_Settings}Learn more about stroke settings.{docs}
  - stroke
```
 ScaleBar stroke(String color, Number thickness, String dashpattern, String lineJoin, String lineCap)
```
    Setter for stroke settings. {docs:Graphics/Stroke_Settings}Learn more about stroke settings.{docs}
  - stroke
```
 ScaleBar stroke(String color, Number thickness, String dashpattern, String lineJoin, StrokeLineCap lineCap)
```
    Setter for stroke settings. {docs:Graphics/Stroke_Settings}Learn more about stroke settings.{docs}
  - stroke
```
 ScaleBar stroke(String color, Number thickness, String dashpattern, StrokeLineJoin lineJoin, String lineCap)
```
    Setter for stroke settings. {docs:Graphics/Stroke_Settings}Learn more about stroke settings.{docs}
  - stroke
```
 ScaleBar stroke(String color, Number thickness, String dashpattern, StrokeLineJoin lineJoin, StrokeLineCap lineCap)
```
    Setter for stroke settings. {docs:Graphics/Stroke_Settings}Learn more about stroke settings.{docs}
  - stroke
```
 ScaleBar stroke(String settings)
```
    Setter for the grid stroke using an object.
  - to
```
 void to()
```
    Getter for the ending range value.
  - to
```
 ScaleBar to(String toValue)
```
    Setter for the ending range value.
  - to
```
 ScaleBar to(Number toValue)
```
    Setter for the ending range value.
  - width
```
 void width()
```
    Getter for the scale bar width.
  - width
```
 ScaleBar width(String width)
```
    Setter for the scale bar width.
  - container
```
 Layer container()
```
    Getter for the container.
  - container
```
 ScaleBar container(Layer element)
```
    Setter for the container.
  - container
```
 ScaleBar container(Stage element)
```
    Setter for the container.
  - container
```
 ScaleBar container(String element)
```
    Setter for the container.
  - enabled
```
 void enabled()
```
    Getter for the element state (enabled or disabled).
  - enabled
```
 ScaleBar enabled(Boolean enabled)
```
    Setter for the element enabled state.
  - parentBounds
```
 Rect parentBounds()
```
    Getter for the parent bounds. Bounds that would be used in case of percent size calculations. Expects pixel values only.
  - parentBounds
```
 ScaleBar parentBounds(Rect bounds)
```
    Setter for the parent bounds using single value. Bounds that would be used in case of percent size calculations. Expects pixel values only.
  - parentBounds
```
 ScaleBar parentBounds(String bounds)
```
    Setter for the parent bounds using single value. Bounds that would be used in case of percent size calculations. Expects pixel values only.
  - parentBounds
```
 ScaleBar parentBounds(Number bounds)
```
    Setter for the parent bounds using single value. Bounds that would be used in case of percent size calculations. Expects pixel values only.
  - parentBounds
```
 ScaleBar parentBounds(Number left, Number top, Number width, Number height)
```
    Setter for the parent bounds using several values. Bounds that would be used in case of percent size calculations. Expects pixel values only.
  - print
```
 void print(PaperSize paperSizeOrOptions, Boolean landscape)
```
    Prints all elements on related stage.
  - print
```
 void print(String paperSizeOrOptions, Boolean landscape)
```
    Prints all elements on related stage.
  - removeAllListeners
```
 void removeAllListeners(String type)
```
    Removes all listeners from an object. You can also optionally remove listeners of some particular type.
  - setOnClickListener
```
 void setOnClickListener(ListenersInterface.OnClickListener listener)
```
  - setOnClickListener
```
 void setOnClickListener(ListenersInterface.OnClickListener listener, String type, String ePath)
```
  - unlistenByKey
```
 void unlistenByKey(String key)
```
    Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().
  - zIndex
```
 void zIndex()
```
    Getter for the Z-index of the element.
  - zIndex
```
 ScaleBar zIndex(Number zIndex)
```
    Setter for the Z-index of the element.
  - fill
```
 ScaleBar fill(String value)
```

Class ScaleBar

Constructor Summary

Method Summary

Methods inherited from class com.anychart.core.VisualBase

Methods inherited from class com.anychart.core.Base

Methods inherited from class java.lang.Object

Constructor Detail

ScaleBar

Method Detail

instantiate

getJsBase

colorScale

colorScale

colorScale

colorScale

colorScale

fill

fill

fill

fill

fill

fill

fill

fill

fill

fill

fill

fill

fill

from

from

from

offset

offset

points

points

scale

scale

stroke

stroke

stroke

stroke

stroke

stroke

stroke

stroke

stroke

stroke

stroke

stroke

stroke

stroke

to

to

to

width

width

container

container

container

container

enabled

enabled

parentBounds

parentBounds

parentBounds

parentBounds

parentBounds

print

print

removeAllListeners

setOnClickListener

setOnClickListener

unlistenByKey

zIndex

zIndex

fill