org.pepstock.charba.client.impl.callbacks

Class PercentageCallback

java.lang.Object

org.pepstock.charba.client.impl.callbacks.PercentageCallback

All Implemented Interfaces:

FormatterCallback

public final class PercentageCallback
extends Object
implements FormatterCallback

Formatter implementation for DataLabelsPlugin.ID plugin in order to provide the percentage of the value.
Setting this object to formatter callback of DataLabelsPlugin.ID options, it will return the percentage for each data index per dataset.

Author:

Andrea "Stock" Stocchero

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_FORMAT Default number format, "##0.##%".
static String	NAN_AS_STRING Default value of NaN as string, "NaN".

Constructor Summary

Constructors

Constructor and Description
PercentageCallback() Creates the formatter using the default values.
PercentageCallback(boolean stacked) Creates the formatter using the argument as flag to compute the percentage on stacked datasets.
PercentageCallback(String format) Creates the formatter using the argument as number format.
PercentageCallback(String format, boolean stacked) Creates the formatter using the arguments as number format and as flag to compute the percentage on stacked datasets.

Method Summary

Modifier and Type	Method and Description
String	getFormat() Returns the number format as string to apply.
String	invoke(IsChart chart, double value, ScriptableContext context) Returns the formatter property at runtime, using the chart instance and the plugin context.
boolean	isStacked() Returns true if it computes the percentage on stacked datasets.

Methods inherited from class java.lang.Object

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

Field Detail

NAN_AS_STRING

public static final String NAN_AS_STRING

Default value of NaN as string, "NaN".

See Also:

Constant Field Values

DEFAULT_FORMAT

public static final String DEFAULT_FORMAT

Default number format, "##0.##%".

See Also:

Constant Field Values

Constructor Detail

PercentageCallback

public PercentageCallback()

Creates the formatter using the default values. The format is and stacked is false.

PercentageCallback

public PercentageCallback(String format)

Creates the formatter using the argument as number format. The stacked is false.

Parameters:

format - number format to apply

PercentageCallback

public PercentageCallback(boolean stacked)

Creates the formatter using the argument as flag to compute the percentage on stacked datasets. The format is .

Parameters:

stacked - if true computes the percentage on stacked datasets.

PercentageCallback

public PercentageCallback(String format,
                          boolean stacked)

Creates the formatter using the arguments as number format and as flag to compute the percentage on stacked datasets.

Parameters:

format - number format to apply

stacked - if true computes the percentage on stacked datasets.

Method Detail

getFormat

public String getFormat()

Returns the number format as string to apply.

Returns:

the number format as string to apply

isStacked

public boolean isStacked()

Returns true if it computes the percentage on stacked datasets.

Returns:

if true computes the percentage on stacked datasets.

invoke

public String invoke(IsChart chart,
                     double value,
                     ScriptableContext context)

Description copied from interface: FormatterCallback

Returns the formatter property at runtime, using the chart instance and the plugin context.

Specified by:

invoke in interface FormatterCallback

Parameters:

chart - chart instance

value - to be formatted

context - DataLabelsPlugin.ID plugin context instance

Returns:

the label value to be showed