com.softwarefx.chartfx.desktop
Enum AxisStyles

java.lang.Object
  java.lang.Enum<AxisStyles>
      com.softwarefx.chartfx.desktop.AxisStyles

All Implemented Interfaces:

Serializable, Comparable<AxisStyles>

public enum AxisStyles
extends Enum<AxisStyles>

Allows you to add additional styles to the selected axis.

Enum Constant Summary

ALLOW_HALF
If space permits and the Step property is left at auto, this enum will instruct the Axis to draw double the amount of labels as it normally would (drawing labels for half steps).

AUTO_CENTER
Instructs Chart FX to center the labels automatically.

AUTO_FIRST_LABEL
Automatically positions the first label to the closest number rounded to the axis step.

AUTO_LABEL_LAYOUT
Auto label layout will automatically determine if staggering or setting in an angle will increase the visibility of the labels.

AUTO_MINOR_STEP
Instructs Chart FX to calculate the MinorStep automatically.

AUTO_SCALE
Same as AutoScale Property.

BREAK_ZERO
This constant will cause a chart to set the starting point at zero.

CENTERED
Displays Interlaced Grid on the selected axis.

DEFAULT
The default value is: SingleLine OR BreakZero OR LongTick OR AutoScale OR ForceZero

DETECT_AREA
Instructs Chart FX to include the area around the axis labels when accessing the axis context menu.

DO_NOT_RESET
Setting this enum will prevent the Axis to reset in situations where it would normally reset it, like when the method RecalculateScale is called or the data is bound to the chart.

FIX_RIGHT_ALIGNED
Right justifies label text.

FORCE_ZERO
Forces minimum to zero when adjusting the axis in a chart where all values are positive.

GRID_FRONT
Paints the axis gridlines on top of the series point markers.

HIDE
Hides entire axis, including labels and tick marks.

HIDE_TEXT
Hides labels for the selected axis.

HIGHLIGHT_VALUES
Instructs Chart FX to Highlight values higher than the value pointed by the mouse when highlighting the Axis.

IGNORE_LABELS
Ignores any axis label assignments and displays labels as default.

INVERTED
Sets the Max value for the selected axis lesser than the Min value.

LEFT_ALIGNED
If Y Axis is set to Far, this will instruct the labels to be aligned to the left.

LONG_TICK
Displays a long major tick mark that makes the axis label appear enclosed in a box.

NOT_CLIPPED
Do not clip the X legends (It is the programmers responsibility to assure that labels don't overlap each other).

NOTIFY
Setting this flag will make the chart generate a GetAxisLabel Event every time it needs to draw a legend in the selected axis.

ROTATE_TEXT
This setting applies to 3D charts only and it allows the text to be rotated when the chart is rotated.

ROUND_STEP
Do round the interval of tick marks and gridlines on the selected axis.

SHOW_2LEVELS
Displays staggered labels.

SHOW_ENDS
Forces ChartFX to display the minimum and maximum value independently from the step set to the chart.

SHOW_INTERMEDIATE_LOG_LABELS
Used to display incremental values for charts with logarithmic scale.

SINGLE_LINE
Do not word-wrap labels.

Method Summary

static EnumSet<AxisStyles>	getEnumSetValue(int value) Returns a EnumSet that represents the given numeric value.
static AxisStyles	getEnumValue(int value) Returns a Enum Item that represents the given numeric value.
static int	getUnderlyingValue(AxisStyles value) Returns a numeric value that represents the given EnumSet or Enum item.
static int	getUnderlyingValue(EnumSet<AxisStyles> value) Returns a numeric value that represents the given EnumSet or Enum item.
static AxisStyles	valueOf(String name) Returns the enum constant of this type with the specified name.
static AxisStyles[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HIDE_TEXT

public static final AxisStyles HIDE_TEXT

Hides labels for the selected axis.

NOTIFY

public static final AxisStyles NOTIFY

Setting this flag will make the chart generate a GetAxisLabel Event every time it needs to draw a legend in the selected axis.

SHOW_2LEVELS

public static final AxisStyles SHOW_2LEVELS

Displays staggered labels.

SINGLE_LINE

public static final AxisStyles SINGLE_LINE

Do not word-wrap labels.

BREAK_ZERO

public static final AxisStyles BREAK_ZERO

This constant will cause a chart to set the starting point at zero. For example, if you have a bar chart with a minimum value of -50 and turn on this flag the starting point will be zero and you will have bars that go up or down, depending on their value.

HIDE

public static final AxisStyles HIDE

Hides entire axis, including labels and tick marks.

NOT_CLIPPED

public static final AxisStyles NOT_CLIPPED

Do not clip the X legends (It is the programmers responsibility to assure that labels don't overlap each other). Setting this flag ON will avoid the RED tags to show when a label is too big, you can also use this flag when you don't want to set labels for every point (i.e. set a label every 20th point).

CENTERED

public static final AxisStyles CENTERED

Displays Interlaced Grid on the selected axis.

ROTATE_TEXT

public static final AxisStyles ROTATE_TEXT

This setting applies to 3D charts only and it allows the text to be rotated when the chart is rotated.

LONG_TICK

public static final AxisStyles LONG_TICK

Displays a long major tick mark that makes the axis label appear enclosed in a box. This setting is used in conjunction with the Centered flag.

AUTO_SCALE

public static final AxisStyles AUTO_SCALE

Same as AutoScale Property.

FORCE_ZERO

public static final AxisStyles FORCE_ZERO

Forces minimum to zero when adjusting the axis in a chart where all values are positive.

SHOW_ENDS

public static final AxisStyles SHOW_ENDS

Forces ChartFX to display the minimum and maximum value independently from the step set to the chart. For example, if step is 10 and maximum is 95 when this setting is used, the axis will show ...60,70,80,90 and 95.

ROUND_STEP

public static final AxisStyles ROUND_STEP

Do round the interval of tick marks and gridlines on the selected axis. The values shown on the axis will exactly the same data passed to the chart.

IGNORE_LABELS

public static final AxisStyles IGNORE_LABELS

Ignores any axis label assignments and displays labels as default.

GRID_FRONT

public static final AxisStyles GRID_FRONT

Paints the axis gridlines on top of the series point markers.

INVERTED

public static final AxisStyles INVERTED

Sets the Max value for the selected axis lesser than the Min value.

DETECT_AREA

public static final AxisStyles DETECT_AREA

Instructs Chart FX to include the area around the axis labels when accessing the axis context menu. By default the menu is only accessible by right-clicking over an axis label.

SHOW_INTERMEDIATE_LOG_LABELS

public static final AxisStyles SHOW_INTERMEDIATE_LOG_LABELS

Used to display incremental values for charts with logarithmic scale.

AUTO_MINOR_STEP

public static final AxisStyles AUTO_MINOR_STEP

Instructs Chart FX to calculate the MinorStep automatically.

AUTO_FIRST_LABEL

public static final AxisStyles AUTO_FIRST_LABEL

Automatically positions the first label to the closest number rounded to the axis step.

AUTO_CENTER

public static final AxisStyles AUTO_CENTER

Instructs Chart FX to center the labels automatically.

FIX_RIGHT_ALIGNED

public static final AxisStyles FIX_RIGHT_ALIGNED

Right justifies label text.

AUTO_LABEL_LAYOUT

public static final AxisStyles AUTO_LABEL_LAYOUT

Auto label layout will automatically determine if staggering or setting in an angle will increase the visibility of the labels. If turned off, the Axis will not stagger or angle the labels unless specified using the right properties.

ALLOW_HALF

public static final AxisStyles ALLOW_HALF

If space permits and the Step property is left at auto, this enum will instruct the Axis to draw double the amount of labels as it normally would (drawing labels for half steps).

HIGHLIGHT_VALUES

public static final AxisStyles HIGHLIGHT_VALUES

Instructs Chart FX to Highlight values higher than the value pointed by the mouse when highlighting the Axis.

LEFT_ALIGNED

public static final AxisStyles LEFT_ALIGNED

If Y Axis is set to Far, this will instruct the labels to be aligned to the left.

DO_NOT_RESET

public static final AxisStyles DO_NOT_RESET

Setting this enum will prevent the Axis to reset in situations where it would normally reset it, like when the method RecalculateScale is called or the data is bound to the chart. Will only affect charts where the scale is left as auto. The method ResetScale will still work, since it is Axis specific.

DEFAULT

public static final AxisStyles DEFAULT

The default value is: SingleLine OR BreakZero OR LongTick OR AutoScale OR ForceZero

Method Detail

values

public static AxisStyles[] 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 (AxisStyles c : AxisStyles.values())
    System.out.println(c);

Returns:

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

valueOf

public static AxisStyles 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

getEnumSetValue

public static EnumSet<AxisStyles> getEnumSetValue(int value)

Returns a EnumSet that represents the given numeric value.

Parameters:

value - numeric representation of the Enumset.

getEnumValue

public static AxisStyles getEnumValue(int value)

Returns a Enum Item that represents the given numeric value.

Parameters:

value - numeric representation of the Enum item.

getUnderlyingValue

public static int getUnderlyingValue(AxisStyles value)

Returns a numeric value that represents the given EnumSet or Enum item.

Parameters:

value - A Enum Item or EnumSet.

getUnderlyingValue

public static int getUnderlyingValue(EnumSet<AxisStyles> value)

Returns a numeric value that represents the given EnumSet or Enum item.

Parameters:

value - A Enum Item or EnumSet.