org.pepstock.charba.client.enums

Enum BorderSkipped

java.lang.Object

java.lang.Enum<BorderSkipped>

org.pepstock.charba.client.enums.BorderSkipped

All Implemented Interfaces:

Serializable, Comparable<BorderSkipped>, Key

public enum BorderSkipped
extends Enum<BorderSkipped>
implements Key

Property to set the border position on chart datasets.
This setting is used to avoid drawing the bar stroke at the base of the fill. In general, this does not need to be changed except when creating chart types that derive from a bar chart.
For negative bars in vertical chart, top and bottom are flipped. Same goes for left and right in horizontal chart.

Author:

Andrea "Stock" Stocchero

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTTOM The bottom property sets the bottom edge of an element to a unit above/below its normal position.
END The end property sets the end edge of an element to a unit above/below its normal position.
FALSE The property sets false to avoid drawing the bar stroke at the base of the fill.
LEFT The left property sets the left edge of an element to a unit to the left/right to its normal position.
MIDDLE The middle property sets the borders between bars are skipped.
RIGHT The right property sets the right edge of an element to a unit to the left/right to its normal position.
START The start property sets the start edge of an element to a unit above/below its normal position.
TOP The top property sets the top edge of an element to a unit above/below its normal position.

Method Summary

Modifier and Type	Method and Description
String	value() Returns the name value of property
static BorderSkipped	valueOf(String name) Returns the enum constant of this type with the specified name.
static BorderSkipped[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.pepstock.charba.client.commons.Key

checkAndGetIfValid, checkIfValid, compare, create, equals, getKeyByValue, getKeyByValue, hasKeyByValue, isValid

Enum Constant Detail

START

public static final BorderSkipped START

The start property sets the start edge of an element to a unit above/below its normal position.

END

public static final BorderSkipped END

The end property sets the end edge of an element to a unit above/below its normal position.

TOP

public static final BorderSkipped TOP

The top property sets the top edge of an element to a unit above/below its normal position.

LEFT

public static final BorderSkipped LEFT

The left property sets the left edge of an element to a unit to the left/right to its normal position.

BOTTOM

public static final BorderSkipped BOTTOM

The bottom property sets the bottom edge of an element to a unit above/below its normal position.

RIGHT

public static final BorderSkipped RIGHT

The right property sets the right edge of an element to a unit to the left/right to its normal position.

MIDDLE

public static final BorderSkipped MIDDLE

The middle property sets the borders between bars are skipped. It's ONLY valid on stacked bars StackedBarDataset.

FALSE

public static final BorderSkipped FALSE

The property sets false to avoid drawing the bar stroke at the base of the fill.

Method Detail

values

public static BorderSkipped[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BorderSkipped c : BorderSkipped.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BorderSkipped valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

value

public String value()

Description copied from interface: Key

Returns the name value of property

Specified by:

value in interface Key

Returns:

the name value of property