ilog.views.chart

Class IlvCategoryStepsDefinition

java.lang.Object

ilog.views.chart.IlvStepsDefinition

ilog.views.chart.IlvCategoryStepsDefinition

All Implemented Interfaces:

Serializable

public class IlvCategoryStepsDefinition
extends IlvStepsDefinition

A steps definition for scales displaying categories. This class defines one step at each category number, and one substep between each step. The step labels display either the category numbers or the data labels of a data set.

Since:

JViews 5.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvCategoryStepsDefinition(boolean stepBetweenCategory) Creates a new IlvCategoryStepsDefinition.
IlvCategoryStepsDefinition(boolean stepBetweenCategory, IlvDataSet dataSet) Creates a new IlvCategoryStepsDefinition that will use the data labels of the specified data set.
IlvCategoryStepsDefinition(boolean stepBetweenCategory, int dataSetIndex) Creates a new IlvCategoryStepsDefinition that will use the data labels of the data set with the specified index.

Method Summary

Modifier and Type	Method and Description
String	computeLabel(double value) Computes the label associated with the specified value.
IlvDataSet	getLabelDataSet() Returns the data set that is used for computing labels.
int	getLabelDataSetIndex() Returns the specified index of the labels data set in the chart's data source.
boolean	hasSubStep() Returns true if ticks and labels are positioned differently.
double	incrementStep(double v) Returns the next step value.
double	incrementSubStep(double v) Returns the next substep value.
boolean	isLabelBetweenCategory() Indicates whether the labels are positioned between categories.
boolean	isStepBetweenCategory() Indicates whether major ticks are positioned between categories.
double	previousStep(double v) Returns the step value immediately before the specified value.
double	previousSubStep(double v) Returns the substep value immediately before the specified value.
void	setLabelBetweenCategory(boolean labelBetweenCategory) Specifies whether the labels are positioned between categories.
void	setLabelDataSetIndex(int dataSetIndex) Sets the index of the labels data set in the chart's data source.
void	setStepBetweenCategory(boolean stepBetweenCategory) Specifies whether major ticks are positioned between categories.

Methods inherited from class ilog.views.chart.IlvStepsDefinition

getLocale, getScale, getULocale, hasNext, localeChanged, nextStep, nextSubStep, update

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvCategoryStepsDefinition

public IlvCategoryStepsDefinition(boolean stepBetweenCategory)

Creates a new IlvCategoryStepsDefinition. The category labels are supplied by the main data source of the chart (see IlvChart.getDataSource()).

Parameters:

stepBetweenCategory - If set to true, steps are positioned between categories, and substeps are positioned at each category. If set to false, steps are positioned at each category.

IlvCategoryStepsDefinition

public IlvCategoryStepsDefinition(boolean stepBetweenCategory,
                                  IlvDataSet dataSet)

Creates a new IlvCategoryStepsDefinition that will use the data labels of the specified data set.

Parameters:

stepBetweenCategory - If set to true, steps will be positioned between categories. Otherwise, steps will be positioned at each category.

dataSet - The data set that will supply the category labels.

IlvCategoryStepsDefinition

public IlvCategoryStepsDefinition(boolean stepBetweenCategory,
                                  int dataSetIndex)

Creates a new IlvCategoryStepsDefinition that will use the data labels of the data set with the specified index.

Parameters:

stepBetweenCategory - If set to true, steps will be positioned between categories. Otherwise, steps will be positioned at each category.

dataSetIndex - The index of the data set that will supply the category labels.

Since:

JViews 8.1

Method Detail

getLabelDataSetIndex

public final int getLabelDataSetIndex()

Returns the specified index of the labels data set in the chart's data source. Returns 0 if the labels data set was specified explicitly, not through its index.

Since:

JViews 8.1

setLabelDataSetIndex

public void setLabelDataSetIndex(int dataSetIndex)

Sets the index of the labels data set in the chart's data source.

Note: This method has no effect if the labels data set was already specified through a constructor argument.

Since:

JViews 8.1

isStepBetweenCategory

public final boolean isStepBetweenCategory()

Indicates whether major ticks are positioned between categories.

See Also:

setStepBetweenCategory(boolean)

setStepBetweenCategory

public void setStepBetweenCategory(boolean stepBetweenCategory)

Specifies whether major ticks are positioned between categories.

Parameters:

stepBetweenCategory - If set to true, steps are positioned between categories, and substeps are positioned at each category. If set to false, steps are positioned at each category.

See Also:

isStepBetweenCategory()

isLabelBetweenCategory

public final boolean isLabelBetweenCategory()

Indicates whether the labels are positioned between categories.

Since:

JViews 8.1

See Also:

setLabelBetweenCategory(boolean)

setLabelBetweenCategory

public void setLabelBetweenCategory(boolean labelBetweenCategory)

Specifies whether the labels are positioned between categories.

Parameters:

labelBetweenCategory - If set to true, labels are positioned between categories. If set to false, labels are positioned at each category.

Since:

JViews 8.1

See Also:

isLabelBetweenCategory()

hasSubStep

public boolean hasSubStep()

Returns true if ticks and labels are positioned differently.

Overrides:

hasSubStep in class IlvStepsDefinition

previousStep

public double previousStep(double v)

Returns the step value immediately before the specified value.

Specified by:

previousStep in class IlvStepsDefinition

incrementStep

public double incrementStep(double v)

Returns the next step value.

Specified by:

incrementStep in class IlvStepsDefinition

previousSubStep

public double previousSubStep(double v)

Returns the substep value immediately before the specified value.

Overrides:

previousSubStep in class IlvStepsDefinition

See Also:

IlvStepsDefinition.hasSubStep()

incrementSubStep

public double incrementSubStep(double v)

Returns the next substep value.

Overrides:

incrementSubStep in class IlvStepsDefinition

See Also:

IlvStepsDefinition.hasSubStep()

getLabelDataSet

public IlvDataSet getLabelDataSet()

Returns the data set that is used for computing labels.

This implementation considers first the data set that was given as constructor argument, or the data set in the chart's data source with the index that was given as a constructor argument.

Since:

JViews 8.1

computeLabel

public String computeLabel(double value)

Computes the label associated with the specified value. If this steps definition references a data set, the method returns the data label corresponding to the specified category number. Otherwise, the method returns the category label of the chart main data source.

Specified by:

computeLabel in class IlvStepsDefinition

Parameters:

value - Numeric coordinate value.

Returns:

A label denoting this value.