GaugeAxis (Jmix-ui 1.0 API)

java.lang.Object
- io.jmix.charts.model.AbstractChartObject
- - io.jmix.charts.model.GaugeAxis

All Implemented Interfaces:

java.io.Serializable
```
public class GaugeAxis
extends AbstractChartObject
```
Creates an axis for AngularGaugeChart charts, multiple can be assigned.
See documentation for properties of GaugeAxis JS Object.
http://docs.amcharts.com/3/javascriptcharts/GaugeAxis

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

GaugeAxis()

Constructors
Constructor and Description
`GaugeAxis()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GaugeAxis`	`addBands(GaugeBand... bands)` Adds bands.
`java.lang.Double`	`getAxisAlpha()`
`Color`	`getAxisColor()`
`java.lang.Integer`	`getAxisThickness()`
`java.lang.Double`	`getBandAlpha()`
`java.util.List<java.lang.Float>`	`getBandGradientRatio()`
`java.lang.Double`	`getBandOutlineAlpha()`
`Color`	`getBandOutlineColor()`
`java.lang.Integer`	`getBandOutlineThickness()`
`java.util.List<GaugeBand>`	`getBands()`
`java.lang.String`	`getBottomText()`
`java.lang.Boolean`	`getBottomTextBold()`
`Color`	`getBottomTextColor()`
`java.lang.Integer`	`getBottomTextFontSize()`
`java.lang.Integer`	`getBottomTextYOffset()`
`java.lang.String`	`getCenterX()`
`java.lang.String`	`getCenterY()`
`Color`	`getColor()`
`java.lang.Integer`	`getEndAngle()`
`java.lang.Double`	`getEndValue()`
`java.lang.Integer`	`getFontSize()`
`java.lang.Integer`	`getGridCount()`
`java.lang.Boolean`	`getGridInside()`
`java.lang.String`	`getId()`
`java.lang.Boolean`	`getInside()`
`java.lang.Double`	`getLabelFrequency()`
`JsFunction`	`getLabelFunction()`
`java.lang.Integer`	`getLabelOffset()`
`java.lang.Boolean`	`getLabelsEnabled()`
`java.lang.Double`	`getMinorTickInterval()`
`java.lang.Integer`	`getMinorTickLength()`
`java.lang.String`	`getRadius()`
`java.lang.Boolean`	`getShowFirstLabel()`
`java.lang.Boolean`	`getShowLastLabel()`
`java.lang.Integer`	`getStartAngle()`
`java.lang.Double`	`getStartValue()`
`java.lang.Double`	`getTickAlpha()`
`Color`	`getTickColor()`
`java.lang.Integer`	`getTickLength()`
`java.lang.Integer`	`getTickThickness()`
`java.lang.String`	`getTopText()`
`java.lang.Boolean`	`getTopTextBold()`
`Color`	`getTopTextColor()`
`java.lang.Integer`	`getTopTextFontSize()`
`java.lang.Integer`	`getTopTextYOffset()`
`java.lang.String`	`getUnit()`
`UnitPosition`	`getUnitPosition()`
`java.lang.Boolean`	`getUsePrefixes()`
`java.lang.Integer`	`getValueInterval()`
`@Max(value=1L) @Min(value=0L) GaugeAxis`	`setAxisAlpha(java.lang.Double axisAlpha)` Sets axis opacity.
`GaugeAxis`	`setAxisColor(Color axisColor)` Sets axis color.
`GaugeAxis`	`setAxisThickness(java.lang.Integer axisThickness)` Sets thickness of the axis outline.
`@Max(value=1L) @Min(value=0L) GaugeAxis`	`setBandAlpha(java.lang.Double bandAlpha)` Sets opacity of band fills.
`GaugeAxis`	`setBandGradientRatio(java.util.List<java.lang.Float> bandGradientRatio)` Sets list of gradient ratio.
`@Max(value=1L) @Min(value=0L) GaugeAxis`	`setBandOutlineAlpha(java.lang.Double bandOutlineAlpha)` Sets opacity of band outlines.
`GaugeAxis`	`setBandOutlineColor(Color bandOutlineColor)` Sets color of band outlines.
`GaugeAxis`	`setBandOutlineThickness(java.lang.Integer bandOutlineThickness)` Sets thickness of band outlines.
`GaugeAxis`	`setBands(java.util.List<GaugeBand> bands)` Sets list of bands.
`GaugeAxis`	`setBottomText(java.lang.String bottomText)` Sets text displayed below the axis center.
`GaugeAxis`	`setBottomTextBold(java.lang.Boolean bottomTextBold)` Set bottomTextBold to false if text shouldn't be bold.
`GaugeAxis`	`setBottomTextColor(Color bottomTextColor)` Sets bottom text color.
`GaugeAxis`	`setBottomTextFontSize(java.lang.Integer bottomTextFontSize)` Sets font size of bottom text.
`GaugeAxis`	`setBottomTextYOffset(java.lang.Integer bottomTextYOffset)` Sets Y offset of bottom text.
`GaugeAxis`	`setCenterX(java.lang.String centerX)` Sets X position of the axis, relative to the center of the gauge.
`GaugeAxis`	`setCenterY(java.lang.String centerY)` Sets Y position of the axis, relative to the center of the gauge.
`GaugeAxis`	`setColor(Color color)` Sets labels color of the axis.
`@Max(value=180L) @Min(value=-180L) GaugeAxis`	`setEndAngle(java.lang.Integer endAngle)` Sets axis end angle.
`GaugeAxis`	`setEndValue(java.lang.Double endValue)` Sets axis end (maximum) value.
`GaugeAxis`	`setFontSize(java.lang.Integer fontSize)` Sets font size for axis labels.
`GaugeAxis`	`setGridCount(java.lang.Integer gridCount)` Sets number of grid lines.
`GaugeAxis`	`setGridInside(java.lang.Boolean gridInside)` Set gridInside to false if grid shouldn't be drawn inside the axis.
`GaugeAxis`	`setId(java.lang.String id)` Sets unique id of an axis.
`GaugeAxis`	`setInside(java.lang.Boolean inside)` Set inside to false if labels should be placed outside the axis.
`GaugeAxis`	`setLabelFrequency(java.lang.Double labelFrequency)` Sets frequency of labels.
`GaugeAxis`	`setLabelFunction(JsFunction labelFunction)` Sets JS function to format axis labels.
`GaugeAxis`	`setLabelOffset(java.lang.Integer labelOffset)` Sets distance from axis to the labels.
`GaugeAxis`	`setLabelsEnabled(java.lang.Boolean labelsEnabled)` Sets labelsEnabled to false if labels on the axis shouldn't be shown.
`GaugeAxis`	`setMinorTickInterval(java.lang.Double minorTickInterval)` Sets interval, at which minor ticks should be placed.
`GaugeAxis`	`setMinorTickLength(java.lang.Integer minorTickLength)` Sets length of a minor tick.
`GaugeAxis`	`setRadius(java.lang.String radius)` Sets axis radius.
`GaugeAxis`	`setShowFirstLabel(java.lang.Boolean showFirstLabel)` Set showFirstLabel to false if the first label shouldn't be shown.
`GaugeAxis`	`setShowLastLabel(java.lang.Boolean showLastLabel)` Set showLastLabel to false if the last label shouldn't be shown.
`@Max(value=180L) @Min(value=-180L) GaugeAxis`	`setStartAngle(java.lang.Integer startAngle)` Sets axis start angle.
`GaugeAxis`	`setStartValue(java.lang.Double startValue)` Sets axis start (minimum) value.
`@Max(value=1L) @Min(value=0L) GaugeAxis`	`setTickAlpha(java.lang.Double tickAlpha)` Sets opacity of axis ticks.
`GaugeAxis`	`setTickColor(Color tickColor)` Sets color of axis ticks.
`GaugeAxis`	`setTickLength(java.lang.Integer tickLength)` Sets length of a major tick.
`GaugeAxis`	`setTickThickness(java.lang.Integer tickThickness)` Sets tick thickness.
`GaugeAxis`	`setTopText(java.lang.String topText)` Sets text displayed above the axis center.
`GaugeAxis`	`setTopTextBold(java.lang.Boolean topTextBold)` Sets topTextBold to false if text shouldn't be bold.
`GaugeAxis`	`setTopTextColor(Color topTextColor)` Sets color of top text.
`GaugeAxis`	`setTopTextFontSize(java.lang.Integer topTextFontSize)` Sets font size of top text.
`GaugeAxis`	`setTopTextYOffset(java.lang.Integer topTextYOffset)` Sets Y offset of top text.
`GaugeAxis`	`setUnit(java.lang.String unit)` Sets a string which can be placed next to axis labels.
`GaugeAxis`	`setUnitPosition(UnitPosition unitPosition)` Sets position of the unit.
`GaugeAxis`	`setUsePrefixes(java.lang.Boolean usePrefixes)` Set usePrefixes to true if small and big numbers should use prefixes to make them more readable.
`GaugeAxis`	`setValueInterval(java.lang.Integer valueInterval)` Sets interval, at which ticks with values should be placed.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GaugeAxis
```
public GaugeAxis()
```
- Method Detail
  - getAxisAlpha
```
public java.lang.Double getAxisAlpha()
```
    Returns:
    
    axis opacity
  - setAxisAlpha
```
@StudioProperty(defaultValue="1")
 @Max(value=1L)
 @Min(value=0L)
public @Max(value=1L) @Min(value=0L) GaugeAxis setAxisAlpha(java.lang.Double axisAlpha)
```
    Sets axis opacity. If not set the default value is 1.
    
    Parameters:
    
    axisAlpha - opacity
    
    Returns:
    
    gauge axis
  - getAxisColor
```
public Color getAxisColor()
```
    Returns:
    
    axis color
  - setAxisColor
```
@StudioProperty(type=OPTIONS,
                defaultValue="#000000")
public GaugeAxis setAxisColor(Color axisColor)
```
    Sets axis color. If not set the default value is #000000.
    
    Parameters:
    
    axisColor - color
    
    Returns:
    
    gauge axis
  - getAxisThickness
```
public java.lang.Integer getAxisThickness()
```
    Returns:
    
    thickness of the axis outline
  - setAxisThickness
```
@StudioProperty(defaultValue="1")
public GaugeAxis setAxisThickness(java.lang.Integer axisThickness)
```
    Sets thickness of the axis outline. If not set the default value is 1.
    
    Parameters:
    
    axisThickness - axis thickness
    
    Returns:
    
    gauge axis
  - getBandAlpha
```
public java.lang.Double getBandAlpha()
```
    Returns:
    
    opacity of band fills
  - setBandAlpha
```
@StudioProperty(defaultValue="1")
 @Max(value=1L)
 @Min(value=0L)
public @Max(value=1L) @Min(value=0L) GaugeAxis setBandAlpha(java.lang.Double bandAlpha)
```
    Sets opacity of band fills. If not set the default value is 1.
    
    Parameters:
    
    bandAlpha - opacity
    
    Returns:
    
    gauge axis
  - getBandOutlineAlpha
```
public java.lang.Double getBandOutlineAlpha()
```
    Returns:
    
    opacity of band outlines
  - setBandOutlineAlpha
```
@StudioProperty(defaultValue="0")
 @Max(value=1L)
 @Min(value=0L)
public @Max(value=1L) @Min(value=0L) GaugeAxis setBandOutlineAlpha(java.lang.Double bandOutlineAlpha)
```
    Sets opacity of band outlines. If not set the default value is 0.
    
    Parameters:
    
    bandOutlineAlpha - opacity
    
    Returns:
    
    gauge axis
  - getBandOutlineColor
```
public Color getBandOutlineColor()
```
    Returns:
    
    color of band outlines
  - setBandOutlineColor
```
@StudioProperty(type=OPTIONS,
                defaultValue="#000000")
public GaugeAxis setBandOutlineColor(Color bandOutlineColor)
```
    Sets color of band outlines. If not set the default value is #000000.
    
    Parameters:
    
    bandOutlineColor - color
    
    Returns:
    
    gauge axis
  - getBandOutlineThickness
```
public java.lang.Integer getBandOutlineThickness()
```
    Returns:
    
    thickness of band outlines
  - setBandOutlineThickness
```
@StudioProperty(defaultValue="0")
public GaugeAxis setBandOutlineThickness(java.lang.Integer bandOutlineThickness)
```
    Sets thickness of band outlines. If not set the default value is 0.
    
    Parameters:
    
    bandOutlineThickness - thickness
    
    Returns:
    
    gauge axis
  - getBottomText
```
public java.lang.String getBottomText()
```
    Returns:
    
    text displayed below the axis center
  - setBottomText
```
@StudioProperty
public GaugeAxis setBottomText(java.lang.String bottomText)
```
    Sets text displayed below the axis center.
    
    Parameters:
    
    bottomText - bottom text
    
    Returns:
    
    gauge axis
  - getBottomTextBold
```
public java.lang.Boolean getBottomTextBold()
```
    Returns:
    
    true if text is bold
  - setBottomTextBold
```
@StudioProperty(defaultValue="true")
public GaugeAxis setBottomTextBold(java.lang.Boolean bottomTextBold)
```
    Set bottomTextBold to false if text shouldn't be bold. If not set the default value is true.
    
    Parameters:
    
    bottomTextBold - bottomTextBold option
    
    Returns:
    
    gauge axis
  - getBottomTextColor
```
public Color getBottomTextColor()
```
    Returns:
    
    bottom text color
  - setBottomTextColor
```
@StudioProperty(type=OPTIONS)
public GaugeAxis setBottomTextColor(Color bottomTextColor)
```
    Sets bottom text color.
    
    Parameters:
    
    bottomTextColor - color
    
    Returns:
    
    gauge axis
  - getBottomTextFontSize
```
public java.lang.Integer getBottomTextFontSize()
```
    Returns:
    
    font size of bottom text
  - setBottomTextFontSize
```
@StudioProperty
public GaugeAxis setBottomTextFontSize(java.lang.Integer bottomTextFontSize)
```
    Sets font size of bottom text.
    
    Parameters:
    
    bottomTextFontSize - font size
    
    Returns:
    
    gauge axis
  - getBottomTextYOffset
```
public java.lang.Integer getBottomTextYOffset()
```
    Returns:
    
    Y offset of bottom text
  - setBottomTextYOffset
```
@StudioProperty(defaultValue="0")
public GaugeAxis setBottomTextYOffset(java.lang.Integer bottomTextYOffset)
```
    Sets Y offset of bottom text. If not set the default value is 0.
    
    Parameters:
    
    bottomTextYOffset - Y offset
    
    Returns:
    
    gauge axis
  - getCenterX
```
public java.lang.String getCenterX()
```
    Returns:
    
    X position of the axis, relative to the center of the gauge
  - setCenterX
```
@StudioProperty(defaultValue="0%")
public GaugeAxis setCenterX(java.lang.String centerX)
```
    Sets X position of the axis, relative to the center of the gauge. If not set the default value is 0%.
    
    Parameters:
    
    centerX - X position of the axis
    
    Returns:
    
    gauge axis
  - getCenterY
```
public java.lang.String getCenterY()
```
    Returns:
    
    Y position of the axis, relative to the center of the gauge
  - setCenterY
```
@StudioProperty(defaultValue="0%")
public GaugeAxis setCenterY(java.lang.String centerY)
```
    Sets Y position of the axis, relative to the center of the gauge. If not set the default value is 0%.
    
    Parameters:
    
    centerY - Y position of the axis
    
    Returns:
    
    gauge axis
  - getEndAngle
```
public java.lang.Integer getEndAngle()
```
    Returns:
    
    axis end angle
  - setEndAngle
```
@StudioProperty(defaultValue="120")
 @Max(value=180L)
 @Min(value=-180L)
public @Max(value=180L) @Min(value=-180L) GaugeAxis setEndAngle(java.lang.Integer endAngle)
```
    Sets axis end angle. Valid values are from - 180 to 180. If not set the default value is 120.
    
    Parameters:
    
    endAngle - angle
    
    Returns:
    
    gauge axis
  - getEndValue
```
public java.lang.Double getEndValue()
```
    Returns:
    
    axis end (maximum) value
  - setEndValue
```
@StudioProperty
public GaugeAxis setEndValue(java.lang.Double endValue)
```
    Sets axis end (maximum) value.
    
    Parameters:
    
    endValue - end value
    
    Returns:
    
    gauge axis
  - getGridInside
```
public java.lang.Boolean getGridInside()
```
    Returns:
    
    true if grid is drawn inside the axis
  - setGridInside
```
@StudioProperty(defaultValue="true")
public GaugeAxis setGridInside(java.lang.Boolean gridInside)
```
    Set gridInside to false if grid shouldn't be drawn inside the axis. If not set the default value is true.
    
    Parameters:
    
    gridInside - gridInside option
    
    Returns:
    
    gauge axis
  - getInside
```
public java.lang.Boolean getInside()
```
    Returns:
    
    true if labels is placed inside the axis
  - setInside
```
@StudioProperty(defaultValue="true")
public GaugeAxis setInside(java.lang.Boolean inside)
```
    Set inside to false if labels should be placed outside the axis. If not set the default value is true.
    
    Parameters:
    
    inside - inside option
    
    Returns:
    
    gauge axis
  - getLabelFrequency
```
public java.lang.Double getLabelFrequency()
```
    Returns:
    
    frequency of labels
  - setLabelFrequency
```
@StudioProperty(defaultValue="1")
public GaugeAxis setLabelFrequency(java.lang.Double labelFrequency)
```
    Sets frequency of labels. If not set the default value is 1.
    
    Parameters:
    
    labelFrequency - frequency
    
    Returns:
    
    gauge axis
  - getLabelOffset
```
public java.lang.Integer getLabelOffset()
```
    Returns:
    
    distance from axis to the labels
  - setLabelOffset
```
@StudioProperty(defaultValue="15")
public GaugeAxis setLabelOffset(java.lang.Integer labelOffset)
```
    Sets distance from axis to the labels. If not set the default value is 15.
    
    Parameters:
    
    labelOffset - label offset
    
    Returns:
    
    gauge axis
  - getMinorTickInterval
```
public java.lang.Double getMinorTickInterval()
```
    Returns:
    
    interval, at which minor ticks is placed
  - setMinorTickInterval
```
@StudioProperty
public GaugeAxis setMinorTickInterval(java.lang.Double minorTickInterval)
```
    Sets interval, at which minor ticks should be placed.
    
    Parameters:
    
    minorTickInterval - minor tick interval
    
    Returns:
    
    gauge axis
  - getMinorTickLength
```
public java.lang.Integer getMinorTickLength()
```
    Returns:
    
    length of a minor tick
  - setMinorTickLength
```
@StudioProperty(defaultValue="5")
public GaugeAxis setMinorTickLength(java.lang.Integer minorTickLength)
```
    Sets length of a minor tick. If not set the default value is 5.
    
    Parameters:
    
    minorTickLength - length
    
    Returns:
    
    gauge axis
  - getRadius
```
public java.lang.String getRadius()
```
    Returns:
    
    axis radius
  - setRadius
```
@StudioProperty(defaultValue="95%")
public GaugeAxis setRadius(java.lang.String radius)
```
    Sets axis radius. If not set the default value is 95%.
    
    Parameters:
    
    radius - radius
    
    Returns:
    
    gauge axis
  - getShowFirstLabel
```
public java.lang.Boolean getShowFirstLabel()
```
    Returns:
    
    true if the first label is shown
  - setShowFirstLabel
```
@StudioProperty(defaultValue="true")
public GaugeAxis setShowFirstLabel(java.lang.Boolean showFirstLabel)
```
    Set showFirstLabel to false if the first label shouldn't be shown. If not set the default value is true.
    
    Parameters:
    
    showFirstLabel - showFirstLabel option
    
    Returns:
    
    gauge axis
  - getShowLastLabel
```
public java.lang.Boolean getShowLastLabel()
```
    Returns:
    
    true if the last label is shown
  - setShowLastLabel
```
@StudioProperty(defaultValue="true")
public GaugeAxis setShowLastLabel(java.lang.Boolean showLastLabel)
```
    Set showLastLabel to false if the last label shouldn't be shown. If not set the default value is true.
    
    Parameters:
    
    showLastLabel - showLastLabel option
    
    Returns:
    
    gauge axis
  - getStartAngle
```
public java.lang.Integer getStartAngle()
```
    Returns:
    
    axis start angle
  - setStartAngle
```
@StudioProperty(defaultValue="-120")
 @Max(value=180L)
 @Min(value=-180L)
public @Max(value=180L) @Min(value=-180L) GaugeAxis setStartAngle(java.lang.Integer startAngle)
```
    Sets axis start angle. Valid values are from - 180 to 180. If not set the default value is -120.
    
    Parameters:
    
    startAngle - start angle
    
    Returns:
    
    gauge axis
  - getStartValue
```
public java.lang.Double getStartValue()
```
    Returns:
    
    axis start (minimum) value
  - setStartValue
```
@StudioProperty(defaultValue="0")
public GaugeAxis setStartValue(java.lang.Double startValue)
```
    Sets axis start (minimum) value. If not set the default value is 0.
    
    Parameters:
    
    startValue - start value
    
    Returns:
    
    gauge axis
  - getTickAlpha
```
public java.lang.Double getTickAlpha()
```
    Returns:
    
    opacity of axis ticks
  - setTickAlpha
```
@StudioProperty(defaultValue="1")
 @Max(value=1L)
 @Min(value=0L)
public @Max(value=1L) @Min(value=0L) GaugeAxis setTickAlpha(java.lang.Double tickAlpha)
```
    Sets opacity of axis ticks. If not set the default value is 1.
    
    Parameters:
    
    tickAlpha - opacity
    
    Returns:
    
    gauge axis
  - getTickColor
```
public Color getTickColor()
```
    Returns:
    
    color of axis ticks
  - setTickColor
```
@StudioProperty(type=OPTIONS,
                defaultValue="#555555")
public GaugeAxis setTickColor(Color tickColor)
```
    Sets color of axis ticks. If not set the default value is #555555.
    
    Parameters:
    
    tickColor - tick color
    
    Returns:
    
    gauge axis
  - getTickLength
```
public java.lang.Integer getTickLength()
```
    Returns:
    
    length of a major tick
  - setTickLength
```
@StudioProperty(defaultValue="10")
public GaugeAxis setTickLength(java.lang.Integer tickLength)
```
    Sets length of a major tick. If not set the default value is 10.
    
    Parameters:
    
    tickLength - tick length
    
    Returns:
    
    gauge axis
  - getTickThickness
```
public java.lang.Integer getTickThickness()
```
    Returns:
    
    tick thickness
  - setTickThickness
```
@StudioProperty(defaultValue="1")
public GaugeAxis setTickThickness(java.lang.Integer tickThickness)
```
    Sets tick thickness. If not set the default value is 1.
    
    Parameters:
    
    tickThickness - tick thickness
    
    Returns:
    
    gauge axis
  - getTopText
```
public java.lang.String getTopText()
```
    Returns:
    
    text displayed above the axis center
  - setTopText
```
@StudioProperty
public GaugeAxis setTopText(java.lang.String topText)
```
    Sets text displayed above the axis center.
    
    Parameters:
    
    topText - top text
    
    Returns:
    
    gauge axis
  - getTopTextBold
```
public java.lang.Boolean getTopTextBold()
```
    Returns:
    
    true if top text is bold
  - setTopTextBold
```
@StudioProperty(defaultValue="true")
public GaugeAxis setTopTextBold(java.lang.Boolean topTextBold)
```
    Sets topTextBold to false if text shouldn't be bold. If not set the default value is true.
    
    Parameters:
    
    topTextBold - topTextBold option
    
    Returns:
    
    gauge axis
  - getTopTextColor
```
public Color getTopTextColor()
```
    Returns:
    
    color of top text
  - setTopTextColor
```
@StudioProperty(type=OPTIONS)
public GaugeAxis setTopTextColor(Color topTextColor)
```
    Sets color of top text.
    
    Parameters:
    
    topTextColor - color
    
    Returns:
    
    gauge axis
  - getTopTextFontSize
```
public java.lang.Integer getTopTextFontSize()
```
    Returns:
    
    font size of top text
  - setTopTextFontSize
```
@StudioProperty
public GaugeAxis setTopTextFontSize(java.lang.Integer topTextFontSize)
```
    Sets font size of top text.
    
    Parameters:
    
    topTextFontSize - font size
    
    Returns:
    
    gauge axis
  - getTopTextYOffset
```
public java.lang.Integer getTopTextYOffset()
```
    Returns:
    
    Y offset of top text
  - setTopTextYOffset
```
@StudioProperty(defaultValue="0")
public GaugeAxis setTopTextYOffset(java.lang.Integer topTextYOffset)
```
    Sets Y offset of top text. If not set the default value is 0.
    
    Parameters:
    
    topTextYOffset - Y offset
    
    Returns:
    
    gauge axis
  - getUnit
```
public java.lang.String getUnit()
```
    Returns:
    
    string which is placed next to axis labels
  - setUnit
```
@StudioProperty
public GaugeAxis setUnit(java.lang.String unit)
```
    Sets a string which can be placed next to axis labels.
    
    Parameters:
    
    unit - unit string
    
    Returns:
    
    gauge axis
  - getUnitPosition
```
public UnitPosition getUnitPosition()
```
    Returns:
    
    position of the unit
  - setUnitPosition
```
@StudioProperty(type=ENUMERATION,
                defaultValue="RIGHT")
public GaugeAxis setUnitPosition(UnitPosition unitPosition)
```
    Sets position of the unit. If not set the default value is RIGHT.
    
    Parameters:
    
    unitPosition - unit position
    
    Returns:
    
    gauge axis
  - getValueInterval
```
public java.lang.Integer getValueInterval()
```
    Returns:
    
    value interval
  - setValueInterval
```
@StudioProperty
public GaugeAxis setValueInterval(java.lang.Integer valueInterval)
```
    Sets interval, at which ticks with values should be placed.
    
    Parameters:
    
    valueInterval - value interval
    
    Returns:
    
    gauge axis
  - getBands
```
public java.util.List<GaugeBand> getBands()
```
    Returns:
    
    list of bands
  - setBands
```
@StudioElementsGroup(caption="Bands",
                     xmlElement="bands")
public GaugeAxis setBands(java.util.List<GaugeBand> bands)
```
    Sets list of bands.
    
    Parameters:
    
    bands - list of bands
    
    Returns:
    
    gauge axis
  - addBands
```
public GaugeAxis addBands(GaugeBand... bands)
```
    Adds bands.
    
    Parameters:
    
    bands - bands
    
    Returns:
    
    gauge axis
  - getGridCount
```
public java.lang.Integer getGridCount()
```
    Returns:
    
    number of grid lines
  - setGridCount
```
@StudioProperty(defaultValue="5")
public GaugeAxis setGridCount(java.lang.Integer gridCount)
```
    Sets number of grid lines. Note, GaugeAxis doesn't adjust gridCount, so you should check your values and choose a proper gridCount which would result grids at round numbers. If not set the default value is 5.
    
    Parameters:
    
    gridCount - number of grid lines
    
    Returns:
    
    gauge axis
  - getId
```
public java.lang.String getId()
```
    Returns:
    
    unique id of an axis
  - setId
```
@StudioProperty
public GaugeAxis setId(java.lang.String id)
```
    Sets unique id of an axis.
    
    Parameters:
    
    id - id
    
    Returns:
    
    gauge axis
  - getLabelsEnabled
```
public java.lang.Boolean getLabelsEnabled()
```
    Returns:
    
    true if labels on the axis is shown
  - setLabelsEnabled
```
@StudioProperty(defaultValue="true")
public GaugeAxis setLabelsEnabled(java.lang.Boolean labelsEnabled)
```
    Sets labelsEnabled to false if labels on the axis shouldn't be shown. If not set the default value is true.
    
    Parameters:
    
    labelsEnabled - labelsEnabled option
    
    Returns:
    
    gauge axis
  - getUsePrefixes
```
public java.lang.Boolean getUsePrefixes()
```
    Returns:
    
    if small and big numbers use prefixes
  - setUsePrefixes
```
@StudioProperty(defaultValue="false")
public GaugeAxis setUsePrefixes(java.lang.Boolean usePrefixes)
```
    Set usePrefixes to true if small and big numbers should use prefixes to make them more readable. If not set the default value is false.
    
    Parameters:
    
    usePrefixes - usePrefixes option
    
    Returns:
    
    gauge axis
  - getLabelFunction
```
public JsFunction getLabelFunction()
```
    Returns:
    
    JS function to format axis labels
  - setLabelFunction
```
public GaugeAxis setLabelFunction(JsFunction labelFunction)
```
    Sets JS function to format axis labels. This function is called and value is passed as a attribute: labelFunction(value);
    
    Parameters:
    
    labelFunction - JS function
    
    Returns:
    
    gauge axis
  - getColor
```
public Color getColor()
```
    Returns:
    
    labels color of the axis
  - setColor
```
@StudioProperty(type=OPTIONS)
public GaugeAxis setColor(Color color)
```
    Sets labels color of the axis.
    
    Parameters:
    
    color - color
    
    Returns:
    
    gauge axis
  - getFontSize
```
public java.lang.Integer getFontSize()
```
    Returns:
    
    font size for axis labels
  - setFontSize
```
@StudioProperty
public GaugeAxis setFontSize(java.lang.Integer fontSize)
```
    Sets font size for axis labels.
    
    Parameters:
    
    fontSize - font size
    
    Returns:
    
    gauge axis
  - getBandGradientRatio
```
public java.util.List<java.lang.Float> getBandGradientRatio()
```
    Returns:
    
    list gradient ratios
  - setBandGradientRatio
```
@StudioProperty(type=STRING)
public GaugeAxis setBandGradientRatio(java.util.List<java.lang.Float> bandGradientRatio)
```
    Sets list of gradient ratio. Will make bands to be filled with color gradients. Negative value means the color will be darker than the original, and positive number means the color will be lighter.
    
    Parameters:
    
    bandGradientRatio - list gradient ratios
    
    Returns:
    
    gauge axis

Class GaugeAxis

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GaugeAxis

Method Detail

getAxisAlpha

setAxisAlpha

getAxisColor

setAxisColor

getAxisThickness

setAxisThickness

getBandAlpha

setBandAlpha

getBandOutlineAlpha

setBandOutlineAlpha

getBandOutlineColor

setBandOutlineColor

getBandOutlineThickness

setBandOutlineThickness

getBottomText

setBottomText

getBottomTextBold

setBottomTextBold

getBottomTextColor

setBottomTextColor

getBottomTextFontSize

setBottomTextFontSize

getBottomTextYOffset

setBottomTextYOffset

getCenterX

setCenterX

getCenterY

setCenterY

getEndAngle

setEndAngle

getEndValue

setEndValue

getGridInside

setGridInside

getInside

setInside

getLabelFrequency

setLabelFrequency

getLabelOffset

setLabelOffset

getMinorTickInterval

setMinorTickInterval

getMinorTickLength

setMinorTickLength

getRadius

setRadius

getShowFirstLabel

setShowFirstLabel

getShowLastLabel

setShowLastLabel

getStartAngle

setStartAngle

getStartValue

setStartValue

getTickAlpha

setTickAlpha

getTickColor

setTickColor

getTickLength

setTickLength

getTickThickness

setTickThickness

getTopText

setTopText

getTopTextBold

setTopTextBold

getTopTextColor

setTopTextColor

getTopTextFontSize

setTopTextFontSize

getTopTextYOffset

setTopTextYOffset

getUnit