org.pepstock.charba.client.defaults.globals

Class DefaultScale

java.lang.Object

org.pepstock.charba.client.defaults.globals.DefaultScale

All Implemented Interfaces:

IsDefaultScale

public final class DefaultScale
extends Object
implements IsDefaultScale

CHART.JS default values for scale/axis element.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Constructor and Description
DefaultScale()

Method Summary

Modifier and Type	Method and Description
IsDefaultAngleLines	getAngleLines() Returns the angle lines default.
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.
ScaleBounds	getBounds() Returns the property controls the scale boundary strategy (bypassed by min/max time options).
double	getCategoryPercentage() Returns the percent (0-1) of the available width each category should be within the sample width.
ScaleDistribution	getDistribution() Returns the property controls the data distribution along the scale.
IsDefaultGridLines	getGrideLines() Returns the grid lines defaults.
int	getMaxBarThickness() Returns the maximum bar thickness.
IsDefaultPointLabels	getPointLabels() Returns the point labels defaults.
Position	getPosition() Position of the axis in the chart.
IsDefaultScaleLabel	getScaleLabel() Returns the scale label defaults
IsDefaultTicks	getTicks() Returns the ticks defaults.
IsDefaultTime	getTime() Returns the time defaults.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultScale

public DefaultScale()

Method Detail

getAngleLines

public IsDefaultAngleLines getAngleLines()

Description copied from interface: IsDefaultScale

Returns the angle lines default.

Specified by:

getAngleLines in interface IsDefaultScale

Returns:

the angleLines defaults.

getGrideLines

public IsDefaultGridLines getGrideLines()

Description copied from interface: IsDefaultScale

Returns the grid lines defaults.

Specified by:

getGrideLines in interface IsDefaultScale

Returns:

the grideLines defaults.

getPointLabels

public IsDefaultPointLabels getPointLabels()

Description copied from interface: IsDefaultScale

Returns the point labels defaults.

Specified by:

getPointLabels in interface IsDefaultScale

Returns:

the pointLabels defaults.

getScaleLabel

public IsDefaultScaleLabel getScaleLabel()

Description copied from interface: IsDefaultScale

Returns the scale label defaults

Specified by:

getScaleLabel in interface IsDefaultScale

Returns:

the scaleLabel defaults.

getTicks

public IsDefaultTicks getTicks()

Description copied from interface: IsDefaultScale

Returns the ticks defaults.

Specified by:

getTicks in interface IsDefaultScale

Returns:

the ticks defaults.

getTime

public IsDefaultTime getTime()

Description copied from interface: IsDefaultScale

Returns the time defaults.

Specified by:

getTime in interface IsDefaultScale

Returns:

the time defaults.

isStacked

public boolean isStacked()

Description copied from interface: IsDefaultScale

Returns if the axis are stacked or not.

Specified by:

isStacked in interface IsDefaultScale

Returns:

if the axis are stacked or not.

getType

public AxisType getType()

Description copied from interface: IsDefaultScale

Returns the type of axis.

Specified by:

getType in interface IsDefaultScale

Returns:

the type of axis.

getWeight

public int getWeight()

Description copied from interface: IsDefaultScale

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.

isDisplay

public boolean isDisplay()

Description copied from interface: IsDefaultScale

If true, shows the axis.

Specified by:

isDisplay in interface IsDefaultScale

Returns:

if true, shows the axis.

isOffset

public boolean isOffset()

Description copied from interface: IsDefaultScale

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.

getPosition

public Position getPosition()

Description copied from interface: IsDefaultScale

Position of the axis in the chart. Possible values are: 'top', 'left', 'bottom', 'right'

Specified by:

getPosition in interface IsDefaultScale

Returns:

position of axis.

getBarPercentage

public double getBarPercentage()

Description copied from interface: IsDefaultScale

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.

Specified by:

getBarPercentage in interface IsDefaultScale

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.

getCategoryPercentage

public double getCategoryPercentage()

Description copied from interface: IsDefaultScale

Returns the percent (0-1) of the available width each category should be within the sample width.

Specified by:

getCategoryPercentage in interface IsDefaultScale

Returns:

the percent (0-1) of the available width each category should be within the sample width.

getBarThickness

public int getBarThickness()

Description copied from interface: IsDefaultScale

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.

Specified by:

getBarThickness in interface IsDefaultScale

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.

getMaxBarThickness

public int getMaxBarThickness()

Description copied from interface: IsDefaultScale

Returns the maximum bar thickness.

Specified by:

getMaxBarThickness in interface IsDefaultScale

Returns:

the maximum bar thickness.

getDistribution

public ScaleDistribution getDistribution()

Description copied from interface: IsDefaultScale

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.

getBounds

public ScaleBounds getBounds()

Description copied from interface: IsDefaultScale

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).