Class TimescaleTier
- java.lang.Object
-
- com.aspose.tasks.TimescaleTier
-
public final class TimescaleTier extends Object
Represents a single tier of the timescale on a Gantt Chart.
-
-
Constructor Summary
Constructors Constructor Description TimescaleTier()
Initializes a new instance of theTimescaleTier
class.TimescaleTier(int unit, int count)
Initializes a new instance of theTimescaleTier
class.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getAlignment()
Gets how to align labels within each time period of the tier (StringAlignment
).int
getCount()
Gets the time unit interval in which to show labels for the tier.DateTimeConverter
getDateTimeConverter()
Gets a callback function for handling rendering date tick in this tier.int
getLabel()
Gets date labelDateLabel
for the timescale tier.boolean
getShowTicks()
Gets a value indicating whether whether to show tick marks that separate time periods in the tier.int
getUnit()
Gets timescale unitTimescaleUnit
for the timescale tier.boolean
getUsesFiscalYear()
Gets a value indicating whether to base the tier labels on the fiscal year.void
setAlignment(int value)
Sets how to align labels within each time period of the tier (StringAlignment
).void
setCount(int value)
Sets the time unit interval in which to show labels for the tier.void
setDateTimeConverter(DateTimeConverter value)
Sets a callback function for handling rendering date tick in this tier.void
setLabel(int value)
Sets date labelDateLabel
for the timescale tier.void
setShowTicks(boolean value)
Sets a value indicating whether whether to show tick marks that separate time periods in the tier.void
setUnit(int value)
Sets timescale unitTimescaleUnit
for the timescale tier.void
setUsesFiscalYear(boolean value)
Sets a value indicating whether to base the tier labels on the fiscal year.
-
-
-
Constructor Detail
-
TimescaleTier
public TimescaleTier()
Initializes a new instance of the
TimescaleTier
class.
-
TimescaleTier
public TimescaleTier(int unit, int count)
Initializes a new instance of the
TimescaleTier
class.- Parameters:
unit
- The timescale unitTimescaleUnit
.count
- The count ofTimescaleUnit
units.
-
-
Method Detail
-
getAlignment
public final int getAlignment()
Gets how to align labels within each time period of the tier (
StringAlignment
).- Returns:
- how to align labels within each time period of the tier (
StringAlignment
).
-
setAlignment
public final void setAlignment(int value)
Sets how to align labels within each time period of the tier (
StringAlignment
).- Parameters:
value
- how to align labels within each time period of the tier (StringAlignment
).
-
getCount
public final int getCount()
Gets the time unit interval in which to show labels for the tier. The default value is 1.
- Returns:
- the time unit interval in which to show labels for the tier.
-
setCount
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:
value
- 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:
- a callback function for handling rendering date tick in this tier.
-
setDateTimeConverter
public final void setDateTimeConverter(DateTimeConverter value)
Sets a callback function for handling rendering date tick in this tier.
- Parameters:
value
- 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:
- date label
DateLabel
for the timescale tier.
-
setLabel
public final void setLabel(int value)
Sets date label
DateLabel
for the timescale tier.- Parameters:
value
- date labelDateLabel
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:
- a value indicating whether whether to show tick marks that separate time periods in the tier.
-
setShowTicks
public final void setShowTicks(boolean value)
Sets a value indicating whether whether to show tick marks that separate time periods in the tier.
- Parameters:
value
- 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 isTimescaleUnit
.- Returns:
- timescale unit
TimescaleUnit
for the timescale tier.
-
setUnit
public final void setUnit(int value)
Sets timescale unit
TimescaleUnit
for the timescale tier. The default value isTimescaleUnit
.- Parameters:
value
- timescale unitTimescaleUnit
for the timescale tier.
-
getUsesFiscalYear
public final boolean getUsesFiscalYear()
Gets a value indicating whether to base the tier labels on the fiscal year.
- Returns:
- a value indicating whether to base the tier labels on the fiscal year.
-
setUsesFiscalYear
public final void setUsesFiscalYear(boolean value)
Sets a value indicating whether to base the tier labels on the fiscal year.
- Parameters:
value
- a value indicating whether to base the tier labels on the fiscal year.
-
-