DateTimeAxisX Class

The arguments axis that manages representation of series with DateTimeSeriesData or FinancialSeriesData data.

Declaration

public class DateTimeAxisX
extends AxisX

The date-time x-axis parameters are shown in the following image:

Date-time x-axis

Refer to the Axes guide for more information on common axis properties.

Inheritance

Constructors

DateTimeAxisX() Constructor

Initializes a new DateTimeAxisX class instance with default parameters.

Declaration

public DateTimeAxisX()

Methods

DateTimeAxisX.addConstantLine(DateTimeConstantLine) Method

Adds the specified constant line to the axis.

Declaration

public void addConstantLine(DateTimeConstantLine line)

Parameters

Type Name Description
DateTimeConstantLine line

The DateTimeConstantLine object to be added.

DateTimeAxisX.addStrip(DateTimeStrip) Method

Adds the specified strip to the axis.

Declaration

public void addStrip(DateTimeStrip strip)

Parameters

Type Name Description
DateTimeStrip strip

The DateTimeStrip object to be added.

DateTimeAxisX.getAggregationType() Method

Returns the aggregation function type.

Declaration

public AggregationType getAggregationType()

Returns

Type Description
AggregationType

The AggregationType enumeration value that specifies the aggregation function used to aggregate data.

If series data provides more detailed data than measure unit, for example, data points are by hours and the measurement unit is a day, data is aggregated using function specified by this property.

DateTimeAxisX.getGridAlignment() Method

Return the measurement unit by which the chart grid is aligned.

Declaration

public DateTimeMeasureUnit getGridAlignment()

Returns

Type Description
DateTimeMeasureUnit

The DateTimeMeasureUnit enumeration value that specifies measurement unit by which the grid is aligned.

DateTimeAxisX.getGridOffset() Method

Returns the first major tickmark's and gridline's initial offset from the range's minimum value.

Declaration

public Integer getGridOffset()

Returns

Type Description
Integer

The first major tickmark's and gridline's initial offset, in measurement units.

DateTimeAxisX.getGridSpacing() Method

Returns the distance between two major tickmarks and gridlines.

Declaration

public Integer getGridSpacing()

Returns

Type Description
Integer

The distance between two major tickmarks and gridlines, in grid alignment units.

DateTimeAxisX.getMeasureUnit() Method

Returns the axis's measurement unit.

Declaration

public DateTimeMeasureUnit getMeasureUnit()

Returns

Type Description
DateTimeMeasureUnit

The DateTimeMeasureUnit enumeration value that specifies the axis's measuring unit.

Note that measurement unit specifies the maximum detail level that the chart displays. If your data is more detailed, it is aggregated using the aggregation function the aggregationType property specifies. For example, data points are by hours and the measurement unit is a day, data is aggregated by day.

DateTimeAxisX.getRange() Method

Returns the settings that specify axis's coordinate ranges.

Declaration

public DateTimeRange getRange()

Returns

Type Description
DateTimeRange

The DateTimeRange object that specifies the range settings.

DateTimeAxisX.removeConstantLine(DateTimeConstantLine) Method

Removes the specified constant line from the axis.

Declaration

public void removeConstantLine(DateTimeConstantLine line)

Parameters

Type Name Description
DateTimeConstantLine line

The DateTimeConstantLine object to be removed.

DateTimeAxisX.removeStrip(DateTimeStrip) Method

Removes the strip from the axis.

Declaration

public void removeStrip(DateTimeStrip strip)

Parameters

Type Name Description
DateTimeStrip strip

The DateTimeStrip object to be removed.

DateTimeAxisX.setAggregationType(AggregationType) Method

Specifies the aggregation function type.

Declaration

public void setAggregationType(AggregationType value)

Parameters

Type Name Description
AggregationType value

The AggregationType enumeration value that specifies the aggregation function used to aggregate data.

If series data provides more detailed data than measure unit, for example, data points are by hours and the measurement unit is a day, data is aggregated using function specified by this property.

DateTimeAxisX.setGridAlignment(DateTimeMeasureUnit) Method

Specifies the measurement unit by which grid is aligned.

Declaration

public void setGridAlignment(DateTimeMeasureUnit value)

Parameters

Type Name Description
DateTimeMeasureUnit value

The DateTimeMeasureUnit enumeration value that specifies the measurement unit by which the grid is aligned.

DateTimeAxisX.setGridOffset(Integer) Method

Specifies the first major tickmark's and gridline's initial offset from the range's minimum value.

Declaration

public void setGridOffset(Integer value)

Parameters

Type Name Description
Integer value

The first major tickmark's and gridline's initial offset, in measurement units.

DateTimeAxisX.setGridSpacing(Integer) Method

Specifies the distance between two major tickmarks and gridlines.

Declaration

public void setGridSpacing(Integer value)

Parameters

Type Name Description
Integer value

The distance between two major tickmarks and gridlines, in grid alignment units.

DateTimeAxisX.setMeasureUnit(DateTimeMeasureUnit) Method

Specifies the axis's measurement unit.

Declaration

public void setMeasureUnit(DateTimeMeasureUnit value)

Parameters

Type Name Description
DateTimeMeasureUnit value

The DateTimeMeasureUnit enumeration value that specifies the axis's measuring unit.

Note that measurement unit specifies the maximum detail level that the chart displays. If your data is more detailed, it is aggregated using the aggregation function the aggregationType property specifies. For example, data points are by hours and the measurement unit is a day, data is aggregated by day.

DateTimeAxisX.setRange(DateTimeRange) Method

Specifies the settings that specify ranges of the axis coordinates.

Declaration

public void setRange(DateTimeRange range)

Parameters

Type Name Description
DateTimeRange range

The DateTimeRange object that specifies the range settings.