com.aspose.tasks

Interfaces

Classes

Exceptions

com.aspose.tasks

Class TimescaleTier



  • public class TimescaleTier
    extends Object

    Represents a single tier of the timescale on a Gantt Chart.

    • Constructor Summary

      Constructors 
      Constructor and Description
      TimescaleTier()
      Initializes a new instance of the TimescaleTier class.
      TimescaleTier(int unit, int count)
      Initializes a new instance of the TimescaleTier class.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      int getAlignment()
      Specifies how to align labels within each time period of the tier (StringAlignment).
      int getCount()
      Specifies 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 a date label for the timescale tier (DateLabel).
      boolean getShowTicks()
      Specifies whether to show tick marks that separate time periods in the tier.
      int getUnit()
      Timescale unit for the timescale tier (TimescaleUnit).
      boolean getUsesFiscalYear()
      Specifies whether to base the tier labels on the fiscal year.
      void setAlignment(int value)
      Sets string alignment of tier labels.
      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 a date label for the timescale tier (DateLabel).
      void setShowTicks(boolean value)
      Sets a flag which specifies whether to show tick marks that separate time periods in the tier.
      void setUnit(int value)
      Sets Timescale unit for the timescale tier (TimescaleUnit).
      void setUsesFiscalYear(boolean value)
      Sets a flag which specifies 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 unit TimescaleUnit.
        count - The count of TimescaleUnit units.
    • Method Detail

      • getAlignment

        public int getAlignment()

        Specifies how to align labels within each time period of the tier (StringAlignment).

        Returns:
        StringAlignment enumerated type value.
      • setAlignment

        public void setAlignment(int value)
        Sets string alignment of tier labels.
        Parameters:
        value - StringAlignment enumerated type value.
      • getCount

        public int getCount()

        Specifies the time unit interval in which to show labels for the tier.

        Returns:
        the time unit interval.
      • setCount

        public void setCount(int value)
        Sets the time unit interval in which to show labels for the tier.
        Parameters:
        value - the time unit interval.
      • getDateTimeConverter

        public DateTimeConverter getDateTimeConverter()

        Gets a callback function for handling rendering date tick in this tier.

        Returns:
        a callback function for handling rendering date tick in the tier.
      • setDateTimeConverter

        public 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 the tier.
      • getLabel

        public int getLabel()

        Gets a date label for the timescale tier (DateLabel).

        Returns:
        DateLabel enumerated type value.
      • setLabel

        public void setLabel(int value)
        Sets a date label for the timescale tier (DateLabel).
        Parameters:
        value - DateLabel enumerated type value.
      • getShowTicks

        public boolean getShowTicks()

        Specifies whether to show tick marks that separate time periods in the tier.

        Returns:
        flag value.
      • setShowTicks

        public void setShowTicks(boolean value)
        Sets a flag which specifies whether to show tick marks that separate time periods in the tier.
        Parameters:
        value - flag value.
      • getUnit

        public int getUnit()

        Timescale unit for the timescale tier (TimescaleUnit).

        Returns:
        TimescaleUnit enumerated type value.
      • setUnit

        public void setUnit(int value)
        Sets Timescale unit for the timescale tier (TimescaleUnit).
        Parameters:
        value - TimescaleUnit enumerated type value.
      • getUsesFiscalYear

        public boolean getUsesFiscalYear()

        Specifies whether to base the tier labels on the fiscal year.

        Returns:
        flag value.
      • setUsesFiscalYear

        public void setUsesFiscalYear(boolean value)
        Sets a flag which specifies whether to base the tier labels on the fiscal year.
        Parameters:
        value - flag value.