Scale (Charba, GWT wrapper for CHART.JS)

java.lang.Object
- org.pepstock.charba.client.commons.JavaScriptObjectContainer
- - org.pepstock.charba.client.defaults.AbstractItem
  - - org.pepstock.charba.client.defaults.scale.Scale

```
public class Scale
extends AbstractItem
```
Axes are an integral part of a chart. They are used to determine how data maps to a pixel value on the chart.
In a cartesian chart, there is 1 or more X axis and 1 or more Y axis to map points onto the 2 dimensional canvas. These axes are know as 'cartesian axes'.
Axes that follow a cartesian grid are known as 'Cartesian Axes'. Cartesian axes are used for line, bar, and bubble charts. Four cartesian axes are included by default.
- linear
- logarithmic
- category
- time (not implemented yet)
It maps the CHART.JS object of default, chart.defaults.scale.
Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Scale(AbstractItem parent, Key childKey)` Builds the object with parent item and child.
	`Scale(GenericJavaScriptObject javaScriptObject)` Creates the object using the java script object with the defaults provided by CHART.JS. It's a root element.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AngleLines`	`getAngleLines()`
`double`	`getBarPercentage()` Returns the percent (0-1) of the available width each bar should be within the category width.
`int`	`getBarThickness()` Returns the width of each bar in pixels.
`double`	`getCategoryPercentage()` Returns the percent (0-1) of the available width each category should be within the sample width.
`GridLines`	`getGrideLines()`
`java.lang.String`	`getId()` The ID is used to link datasets and scale axes together. This is especially needed if multi-axes charts are used.
`int`	`getMaxBarThickness()` Returns the maximum bar thickness.
`PointLabels`	`getPointLabels()`
`Position`	`getPosition()` Position of the axis in the chart.
`ScaleLabel`	`getScaleLabel()`
`Ticks`	`getTicks()`
`AxisType`	`getType()` Returns the type of axis.
`int`	`getWeight()` The weight used to sort the axis.
`boolean`	`isDisplay()` If true, shows the axis.
`boolean`	`isOffset()` If true, extra space is added to the both edges and the axis is scaled to fit into the chart area.
`boolean`	`isStacked()` Returns if the axis are stacked or not.
`void`	`setBarPercentage(double barPercentage)` Sets the percent (0-1) of the available width each bar should be within the category width.
`void`	`setBarThickness(int barThickness)` Sets the width of each bar in pixels.
`void`	`setCategoryPercentage(double categoryPercentage)` Sets the percent (0-1) of the available width each category should be within the sample width.
`void`	`setDisplay(boolean display)` If true, shows the axis.
`void`	`setId(java.lang.String id)` The ID is used to link datasets and scale axes together. This is especially needed if multi-axes charts are used.
`void`	`setMaxBarThickness(int maxBarThickness)` Sets the maximum bar thickness, to ensure that bars are not sized thicker than this
`void`	`setOffset(boolean offset)` If true, extra space is added to the both edges and the axis is scaled to fit into the chart area.
`void`	`setPosition(Position position)` Position of the axis in the chart.
`void`	`setStacked(boolean stacked)` Sets if the axis are stacked or not.
`void`	`setType(AxisType type)` Type of scale being employed.
`void`	`setWeight(int weight)` The weight used to sort the axis.

Methods inherited from class org.pepstock.charba.client.defaults.AbstractItem
checkAndAddToParent, hasProperty

Methods inherited from class org.pepstock.charba.client.commons.JavaScriptObjectContainer
checkAndGetDoubleValues, checkAndGetEnumValues, checkAndGetIntegerValues, checkAndGetStringValues, checkAndSetDoubleValues, checkAndSetEnumValues, checkAndSetIntegerValues, checkAndSetStringValues, getDoubleArray, getIntegerArray, getJavaScriptObject, getObjectArray, getStringArray, getValue, getValue, getValue, getValue, getValue, getValue, getValue, has, has, hasToBeRegistered, isEmpty, keys, remove, remove, removeIfExists, setDoubleArray, setEnumValueArray, setIntegerArray, setObjectArray, setStringArray, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, type

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

- Constructor Detail
  - Scale
```
public Scale(GenericJavaScriptObject javaScriptObject)
```
    Creates the object using the java script object with the defaults provided by CHART.JS.
    It's a root element.
    
    Parameters:
    
    javaScriptObject - the java script object with the defaults provided by CHART.JS.
  - Scale
```
protected Scale(AbstractItem parent,
                Key childKey)
```
    Builds the object with parent item and child. With this constructor we are creating a child of default options.
    
    Parameters:
    
    parent - parent item.
    
    childKey - key of child.
- Method Detail
  - getScaleLabel
```
public ScaleLabel getScaleLabel()
```
    Returns:
    
    the scaleLabel
    
    See Also:
    
    ScaleLabel
  - getTicks
```
public Ticks getTicks()
```
    Returns:
    
    the ticks
    
    See Also:
    
    Ticks
  - getGrideLines
```
public GridLines getGrideLines()
```
    Returns:
    
    the grideLines
    
    See Also:
    
    GridLines
  - getAngleLines
```
public AngleLines getAngleLines()
```
    Returns:
    
    the angleLines
    
    See Also:
    
    AngleLines
  - getPointLabels
```
public PointLabels getPointLabels()
```
    Returns:
    
    the pointLabels
    
    See Also:
    
    PointLabels
  - setId
```
public void setId(java.lang.String id)
```
    The ID is used to link datasets and scale axes together.
    This is especially needed if multi-axes charts are used.
    
    Parameters:
    
    id - The ID is used to link datasets and scale axes together
  - getId
```
public java.lang.String getId()
```
    The ID is used to link datasets and scale axes together.
    This is especially needed if multi-axes charts are used.
    
    Returns:
    
    The ID is used to link datasets and scale axes together or null if not set
  - setStacked
```
public void setStacked(boolean stacked)
```
    Sets if the axis are stacked or not.
    
    Parameters:
    
    stacked - if the axis are stacked or not.
  - isStacked
```
public boolean isStacked()
```
    Returns if the axis are stacked or not.
    
    Returns:
    
    if the axis are stacked or not. Default is false.
  - setType
```
public void setType(AxisType type)
```
    Type of scale being employed.
    
    Parameters:
    
    type - type of axis
    
    See Also:
    
    AxisType
  - getType
```
public AxisType getType()
```
    Returns the type of axis.
    
    Returns:
    
    the type of axis. If not set, the default is AxisType.linear.
    
    See Also:
    
    AxisType
  - setWeight
```
public void setWeight(int weight)
```
    The weight used to sort the axis. Higher weights are further away from the chart area.
    
    Parameters:
    
    weight - weight of axis
  - getWeight
```
public int getWeight()
```
    The weight used to sort the axis. Higher weights are further away from the chart area.
    
    Returns:
    
    weight of axis. Default is 0.
  - setDisplay
```
public void setDisplay(boolean display)
```
    If true, shows the axis.
    
    Parameters:
    
    display - if true, shows the axes.
  - isDisplay
```
public boolean isDisplay()
```
    If true, shows the axis.
    
    Returns:
    
    if true, shows the axis. Default is true.
  - setOffset
```
public void setOffset(boolean offset)
```
    If true, extra space is added to the both edges and the axis is scaled to fit into the chart area.
    
    Parameters:
    
    offset - extra space of axis
  - isOffset
```
public boolean isOffset()
```
    If true, extra space is added to the both edges and the axis is scaled to fit into the chart area.
    
    Returns:
    
    extra space of axis. Default is false.
  - setPosition
```
public void setPosition(Position position)
```
    Position of the axis in the chart. Possible values are: 'top', 'left', 'bottom', 'right'
    
    Parameters:
    
    position - position of axis
    
    See Also:
    
    Position
  - getPosition
```
public Position getPosition()
```
    Position of the axis in the chart. Possible values are: 'top', 'left', 'bottom', 'right'
    
    Returns:
    
    position of axis. Default is Position.top.
    
    See Also:
    
    Position
  - setBarPercentage
```
public void setBarPercentage(double barPercentage)
```
    Sets the percent (0-1) of the available width each bar should be within the category width. 1.0 will take the whole category width and put the bars right next to each other.
    
    Parameters:
    
    barPercentage - percent (0-1) of the available width each bar should be within the category width. 1.0 will take the whole category width and put the bars right next to each other.
  - getBarPercentage
```
public double getBarPercentage()
```
    Returns the percent (0-1) of the available width each bar should be within the category width. 1.0 will take the whole category width and put the bars right next to each other.
    
    Returns:
    
    percent (0-1) of the available width each bar should be within the category width. 1.0 will take the whole category width and put the bars right next to each other. Default is 0.9.
  - setCategoryPercentage
```
public void setCategoryPercentage(double categoryPercentage)
```
    Sets the percent (0-1) of the available width each category should be within the sample width.
    
    Parameters:
    
    categoryPercentage - percent (0-1) of the available width each category should be within the sample width.
  - getCategoryPercentage
```
public double getCategoryPercentage()
```
    Returns the percent (0-1) of the available width each category should be within the sample width.
    
    Returns:
    
    the percent (0-1) of the available width each category should be within the sample width. Default is 0.8.
  - setBarThickness
```
public void setBarThickness(int barThickness)
```
    Sets the width of each bar in pixels. If not set, the base sample widths are calculated automatically so that they take the full available widths without overlap. Then, the bars are sized using barPercentage and categoryPercentage.
    
    Parameters:
    
    barThickness - width of each bar in pixels. If not set, the base sample widths are calculated automatically so that they take the full available widths without overlap. Then, the bars are sized using barPercentage and categoryPercentage.
  - getBarThickness
```
public int getBarThickness()
```
    Returns the width of each bar in pixels. If not set, the base sample widths are calculated automatically so that they take the full available widths without overlap. Then, the bars are sized using barPercentage and categoryPercentage.
    
    Returns:
    
    width of each bar in pixels. If not set, the base sample widths are calculated automatically so that they take the full available widths without overlap. Then, the bars are sized using barPercentage and categoryPercentage. Default is 0.
  - setMaxBarThickness
```
public void setMaxBarThickness(int maxBarThickness)
```
    Sets the maximum bar thickness, to ensure that bars are not sized thicker than this
    
    Parameters:
    
    maxBarThickness - the maximum bar thickness.
  - getMaxBarThickness
```
public int getMaxBarThickness()
```
    Returns the maximum bar thickness.
    
    Returns:
    
    the maximum bar thickness. Default is 0.

Class Scale

Constructor Summary

Method Summary

Methods inherited from class org.pepstock.charba.client.defaults.AbstractItem

Methods inherited from class org.pepstock.charba.client.commons.JavaScriptObjectContainer

Methods inherited from class java.lang.Object

Constructor Detail

Scale

Scale

Method Detail

getScaleLabel

getTicks

getGrideLines

getAngleLines

getPointLabels

setId

getId

setStacked

isStacked

setType

getType

setWeight

getWeight

setDisplay

isDisplay

setOffset

isOffset

setPosition

getPosition

setBarPercentage

getBarPercentage

setCategoryPercentage

getCategoryPercentage

setBarThickness

getBarThickness

setMaxBarThickness

getMaxBarThickness