Scale (Charba - GWT Charts library based on CHART.JS)

java.lang.Object
- org.pepstock.charba.client.commons.NativeObjectContainer
- - org.pepstock.charba.client.options.Scale

All Implemented Interfaces:

IsDefaultScale

Direct Known Subclasses:

ExtendedScale, GlobalScale
```
public class Scale
extends NativeObjectContainer
implements IsDefaultScale
```
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
Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors
Modifier	Constructor and Description
	`Scale(IsDefaultScale defaultValues)` Creates the object only with default provider.
`protected`	`Scale(IsDefaultScale defaultValues, NativeObject nativeObject)` Creates the object only with default provider and native object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`checkAndAddToParent()` Called recursively when a property has been set in the item. This is mandatory because it could happen that the parent item is not present, therefore it must be added.
`AngleLines`	`getAngleLines()` Returns the angle lines element.
`ScaleBounds`	`getBounds()` Returns the property controls the scale boundary strategy (bypassed by min/max time options).
`protected Key`	`getChildKey()` Returns the property name to use to add this element to its parent.
`protected D`	`getDefaultValues()` Returns the default provider instance.
`Display`	`getDisplay()` The display option controls the visibility of axis. Controls the axis global visibility (visible when true, hidden when false).
`ScaleDistribution`	`getDistribution()` Returns the property controls the data distribution along the scale.
`GridLines`	`getGrideLines()` Returns the grid lines element.
`String`	`getId()` The ID is used to link datasets and scale axes together. This is especially needed if multi-axes charts are used.
`protected P`	`getParent()` Returns the parent element.
`PointLabels`	`getPointLabels()` Returns the point labels element.
`Position`	`getPosition()` Position of the axis in the chart.
`ScaleLabel`	`getScaleLabel()` Returns the scale label element.
`Ticks`	`getTicks()` Returns the ticks element.
`Time`	`getTime()` Returns the time element.
`AxisType`	`getType()` Returns the type of axis.
`double`	`getWeight()` The weight used to sort 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`	`setBounds(ScaleBounds bounds)` Sets the property controls the scale boundary strategy (bypassed by min/max time options).
`protected void`	`setCallbackToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model, Key key, CallbackProxy.Proxy proxy)` Adds a proxy function (for callbacks) to a model at the specific key.
`void`	`setDisplay(boolean display)` If `true`, shows the axis.
`void`	`setDisplay(Display display)` The display option controls the visibility of axis. Controls the axis global visibility (visible when true, hidden when false).
`void`	`setDistribution(ScaleDistribution distribution)` Sets property controls the data distribution along the scale.
`protected void`	`setEventToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model, Key key, CallbackProxy.Proxy proxy)` Adds a proxy function (for events) to a model at the specific key.
`void`	`setId(String id)` The ID is used to link datasets and scale axes together. This is especially needed if multi-axes charts are used.
`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(double weight)` The weight used to sort the axis.

Methods inherited from class org.pepstock.charba.client.commons.NativeObjectContainer
checkValue, empty, getArrayValue, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, keys, remove, remove, removeIfExists, setArrayValue, setArrayValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, toJSON, type

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

- Constructor Detail
  - Scale
```
public Scale(IsDefaultScale defaultValues)
```
    Creates the object only with default provider. This is used when the scale is the root element.
    New native java script object is created and it's empty.
    
    Parameters:
    
    defaultValues - default provider instance.
  - Scale
```
protected Scale(IsDefaultScale defaultValues,
                NativeObject nativeObject)
```
    Creates the object only with default provider and native object. This is used when the scale is the root element.
    
    Parameters:
    
    defaultValues - default provider instance.
    
    nativeObject - native object to store properties.
- Method Detail
  - getScaleLabel
```
public final ScaleLabel getScaleLabel()
```
    Returns the scale label element.
    
    Specified by:
    
    getScaleLabel in interface IsDefaultScale
    
    Returns:
    
    the scaleLabel
  - getTicks
```
public final Ticks getTicks()
```
    Returns the ticks element.
    
    Specified by:
    
    getTicks in interface IsDefaultScale
    
    Returns:
    
    the ticks
  - getGrideLines
```
public final GridLines getGrideLines()
```
    Returns the grid lines element.
    
    Specified by:
    
    getGrideLines in interface IsDefaultScale
    
    Returns:
    
    the grideLines
  - getAngleLines
```
public final AngleLines getAngleLines()
```
    Returns the angle lines element.
    
    Specified by:
    
    getAngleLines in interface IsDefaultScale
    
    Returns:
    
    the angleLines
  - getPointLabels
```
public final PointLabels getPointLabels()
```
    Returns the point labels element.
    
    Specified by:
    
    getPointLabels in interface IsDefaultScale
    
    Returns:
    
    the pointLabels
  - getTime
```
public final Time getTime()
```
    Returns the time element.
    
    Specified by:
    
    getTime in interface IsDefaultScale
    
    Returns:
    
    the time
  - setId
```
public final void setId(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 final 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 UndefinedValues.STRING if not set
  - setStacked
```
public final void setStacked(boolean stacked)
```
    Sets if the axis are stacked or not.
    
    Parameters:
    
    stacked - if the axis are stacked or not.
  - isStacked
```
public final boolean isStacked()
```
    Returns if the axis are stacked or not.
    
    Specified by:
    
    isStacked in interface IsDefaultScale
    
    Returns:
    
    if the axis are stacked or not.
  - setType
```
public final void setType(AxisType type)
```
    Type of scale being employed.
    
    Parameters:
    
    type - type of axis
  - getType
```
public final AxisType getType()
```
    Returns the type of axis.
    
    Specified by:
    
    getType in interface IsDefaultScale
    
    Returns:
    
    the type of axis.
  - setWeight
```
public final void setWeight(double weight)
```
    The weight used to sort the axis. Higher weights are further away from the chart area.
    
    Parameters:
    
    weight - weight of axis
  - getWeight
```
public final double getWeight()
```
    The weight used to sort the axis. Higher weights are further away from the chart area.
    
    Specified by:
    
    getWeight in interface IsDefaultScale
    
    Returns:
    
    weight of axis.
  - setDisplay
```
public final void setDisplay(boolean display)
```
    If true, shows the axis.
    
    Parameters:
    
    display - if true, shows the axes.
  - setDisplay
```
public final void setDisplay(Display display)
```
    The display option controls the visibility of axis.
    Controls the axis global visibility (visible when true, hidden when false). When display: 'auto', the axis is visible only if at least one associated dataset is visible.
    
    Parameters:
    
    display - display option controls the visibility of axis
  - getDisplay
```
public final Display getDisplay()
```
    The display option controls the visibility of axis.
    Controls the axis global visibility (visible when true, hidden when false). When display: 'auto', the axis is visible only if at least one associated dataset is visible.
    
    Specified by:
    
    getDisplay in interface IsDefaultScale
    
    Returns:
    
    display option controls the visibility of axis
  - setOffset
```
public final 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 final boolean isOffset()
```
    If true, extra space is added to the both edges and the axis is scaled to fit into the chart area.
    
    Specified by:
    
    isOffset in interface IsDefaultScale
    
    Returns:
    
    extra space of axis.
  - setPosition
```
public final void setPosition(Position position)
```
    Position of the axis in the chart. Possible values are: 'top', 'left', 'bottom', 'right'
    
    Parameters:
    
    position - position of axis
  - getPosition
```
public final Position getPosition()
```
    Position of the axis in the chart. Possible values are: 'top', 'left', 'bottom', 'right'
    
    Specified by:
    
    getPosition in interface IsDefaultScale
    
    Returns:
    
    position of axis.
  - setDistribution
```
public final void setDistribution(ScaleDistribution distribution)
```
    Sets property controls the data distribution along the scale.
    
    Parameters:
    
    distribution - property controls the data distribution along the scale.
  - getDistribution
```
public final ScaleDistribution getDistribution()
```
    Returns the property controls the data distribution along the scale.
    
    Specified by:
    
    getDistribution in interface IsDefaultScale
    
    Returns:
    
    property controls the data distribution along the scale.
  - setBounds
```
public final void setBounds(ScaleBounds bounds)
```
    Sets the property controls the scale boundary strategy (bypassed by min/max time options).
    
    Parameters:
    
    bounds - property controls the scale boundary strategy (bypassed by min/max time options).
  - getBounds
```
public final ScaleBounds getBounds()
```
    Returns the property controls the scale boundary strategy (bypassed by min/max time options).
    
    Specified by:
    
    getBounds in interface IsDefaultScale
    
    Returns:
    
    property controls the scale boundary strategy (bypassed by min/max time options).
  - getChildKey
```
protected final Key getChildKey()
```
    Returns the property name to use to add this element to its parent.
    
    Returns:
    
    the childKey or null if is a root element.
  - getParent
```
protected final P getParent()
```
    Returns the parent element.
    
    Returns:
    
    the parent or null if is a root element.
  - getDefaultValues
```
protected final D getDefaultValues()
```
    Returns the default provider instance.
    
    Returns:
    
    the default provider instance.
  - setEventToModel
```
protected final void setEventToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model,
                                     Key key,
                                     CallbackProxy.Proxy proxy)
```
    Adds a proxy function (for events) to a model at the specific key.
    
    Parameters:
    
    model - element where adding the function proxy
    
    key - property name to use to add the function proxy
    
    proxy - the function proxy instance to add
  - setCallbackToModel
```
protected final void setCallbackToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model,
                                        Key key,
                                        CallbackProxy.Proxy proxy)
```
    Adds a proxy function (for callbacks) to a model at the specific key.
    
    Parameters:
    
    model - element where adding the function proxy
    
    key - property name to use to add the function proxy
    
    proxy - the function proxy instance to add
  - checkAndAddToParent
```
protected final void checkAndAddToParent()
```
    Called recursively when a property has been set in the item.
    This is mandatory because it could happen that the parent item is not present, therefore it must be added.

Class Scale

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

Scale

Scale

Method Detail

getScaleLabel

getTicks

getGrideLines

getAngleLines

getPointLabels

getTime

setId

getId

setStacked

isStacked

setType

getType

setWeight

getWeight

setDisplay

setDisplay

getDisplay

setOffset

isOffset

setPosition

getPosition

setDistribution

getDistribution

setBounds

getBounds

getChildKey

getParent

getDefaultValues

setEventToModel

setCallbackToModel

checkAndAddToParent