TimescaleTier
Inheritance: java.lang.Object
public final class TimescaleTier
Represents a single tier of the timescale on a Gantt Chart.
Constructors
| Constructor | Description |
|---|---|
| TimescaleTier() | Initializes a new instance of the TimescaleTier class. |
| TimescaleTier(int unit, int count) | Initializes a new instance of the TimescaleTier class. |
Methods
| Method | Description |
|---|---|
| getAlignment() | Gets how to align labels within each time period of the tier (HorizontalStringAlignment). |
| getCount() | Gets the time unit interval in which to show labels for the tier. |
| getDateTimeConverter() | Gets a callback function for handling rendering date tick in this tier. |
| getLabel() | Gets date label DateLabel for the timescale tier. |
| getShowTicks() | Gets a value indicating whether whether to show tick marks that separate time periods in the tier. |
| getUnit() | Gets timescale unit TimescaleUnit for the timescale tier. |
| getUsesFiscalYear() | Gets a value indicating whether to base the tier labels on the fiscal year. |
| setAlignment(int value) | Sets how to align labels within each time period of the tier (HorizontalStringAlignment). |
| setCount(int value) | Sets the time unit interval in which to show labels for the tier. |
| setDateTimeConverter(DateTimeConverter value) | Sets a callback function for handling rendering date tick in this tier. |
| setLabel(int value) | Sets date label DateLabel for the timescale tier. |
| setShowTicks(boolean value) | Sets a value indicating whether whether to show tick marks that separate time periods in the tier. |
| setUnit(int value) | Sets timescale unit TimescaleUnit for the timescale tier. |
| setUsesFiscalYear(boolean value) | Sets a value indicating whether to base the tier labels on the fiscal year. |
TimescaleTier()
public TimescaleTier()
Initializes a new instance of the TimescaleTier class.
TimescaleTier(int unit, int count)
public TimescaleTier(int unit, int count)
Initializes a new instance of the TimescaleTier class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| unit | int | The timescale unit TimescaleUnit. |
| count | int | The count of TimescaleUnit units. |
getAlignment()
public final int getAlignment()
Gets how to align labels within each time period of the tier (HorizontalStringAlignment).
Returns: int - how to align labels within each time period of the tier (HorizontalStringAlignment).
getCount()
public final int getCount()
Gets the time unit interval in which to show labels for the tier. The default value is 1.
Returns: int - the time unit interval in which to show labels for the tier.
getDateTimeConverter()
public final DateTimeConverter getDateTimeConverter()
Gets a callback function for handling rendering date tick in this tier.
Returns: DateTimeConverter - a callback function for handling rendering date tick in this tier.
getLabel()
public final int getLabel()
Gets date label DateLabel for the timescale tier.
Returns: int - date label DateLabel for the timescale tier.
getShowTicks()
public final boolean getShowTicks()
Gets a value indicating whether whether to show tick marks that separate time periods in the tier.
Returns: boolean - a value indicating whether whether to show tick marks that separate time periods in the tier.
getUnit()
public final int getUnit()
Gets timescale unit TimescaleUnit for the timescale tier. The default value is TimescaleUnit.
Returns: int - timescale unit TimescaleUnit for the timescale tier.
getUsesFiscalYear()
public final boolean getUsesFiscalYear()
Gets a value indicating whether to base the tier labels on the fiscal year.
Returns: boolean - a value indicating whether to base the tier labels on the fiscal year.
setAlignment(int value)
public final void setAlignment(int value)
Sets how to align labels within each time period of the tier (HorizontalStringAlignment).
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | how to align labels within each time period of the tier (HorizontalStringAlignment). |
setCount(int value)
public final void setCount(int value)
Sets the time unit interval in which to show labels for the tier. The default value is 1.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | the time unit interval in which to show labels for the tier. |
setDateTimeConverter(DateTimeConverter value)
public final void setDateTimeConverter(DateTimeConverter value)
Sets a callback function for handling rendering date tick in this tier.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | DateTimeConverter | a callback function for handling rendering date tick in this tier. |
setLabel(int value)
public final void setLabel(int value)
Sets date label DateLabel for the timescale tier.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | date label DateLabel for the timescale tier. |
setShowTicks(boolean value)
public final void setShowTicks(boolean value)
Sets a value indicating whether whether to show tick marks that separate time periods in the tier.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | a value indicating whether whether to show tick marks that separate time periods in the tier. |
setUnit(int value)
public final void setUnit(int value)
Sets timescale unit TimescaleUnit for the timescale tier. The default value is TimescaleUnit.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | timescale unit TimescaleUnit for the timescale tier. |
setUsesFiscalYear(boolean value)
public final void setUsesFiscalYear(boolean value)
Sets a value indicating whether to base the tier labels on the fiscal year.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | a value indicating whether to base the tier labels on the fiscal year. |