Aspose.Tasks for C++
Aspose::Tasks::Visualization::TimescaleTier Class Referencefinal

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

#include <TimescaleTier.h>

Inherits System::Object.

Public Member Functions

Aspose::Tasks::Visualization::DateTimeConverter get_DateTimeConverter () const
 Gets a callback function for handling rendering date tick in this tier. More...
 
void set_DateTimeConverter (Aspose::Tasks::Visualization::DateTimeConverter value)
 Sets a callback function for handling rendering date tick in this tier. More...
 
int32_t get_Count () const
 Gets the time unit interval in which to show labels for the tier. The default value is 1. More...
 
void set_Count (int32_t value)
 Sets the time unit interval in which to show labels for the tier. The default value is 1. More...
 
DateLabel get_Label () const
 Gets date label DateLabel for the timescale tier. More...
 
void set_Label (DateLabel value)
 Sets date label DateLabel for the timescale tier. More...
 
HorizontalStringAlignment get_Alignment () const
 Gets how to align labels within each time period of the tier (HorizontalStringAlignment). More...
 
void set_Alignment (HorizontalStringAlignment value)
 Sets how to align labels within each time period of the tier (HorizontalStringAlignment). More...
 
bool get_UsesFiscalYear () const
 Gets a value indicating whether to base the tier labels on the fiscal year. More...
 
void set_UsesFiscalYear (bool value)
 Sets a value indicating whether to base the tier labels on the fiscal year. More...
 
bool get_ShowTicks () const
 Gets a value indicating whether whether to show tick marks that separate time periods in the tier. More...
 
void set_ShowTicks (bool value)
 Sets a value indicating whether whether to show tick marks that separate time periods in the tier. More...
 
TimescaleUnit get_Unit () const
 Gets timescale unit TimescaleUnit for the timescale tier. The default value is Days. More...
 
void set_Unit (TimescaleUnit value)
 Sets timescale unit TimescaleUnit for the timescale tier. The default value is Days. More...
 
bool get_RenderLabelOnEachPage () const
 Gets flag that defines whether date labels should be rendered on each page when a time period spans over several pages. If value is 'true', when time period spans over several pages, date labels for the period are rendered on each page. If values is 'false', date label is rendered only once according to a value of Alignment property. More...
 
void set_RenderLabelOnEachPage (bool value)
 Sets flag that defines whether date labels should be rendered on each page when a time period spans over several pages. If value is 'true', when time period spans over several pages, date labels for the period are rendered on each page. If values is 'false', date label is rendered only once according to a value of Alignment property. More...
 
 TimescaleTier ()
 Initializes a new instance of the TimescaleTier class. More...
 
 TimescaleTier (TimescaleUnit unit, int32_t count)
 Initializes a new instance of the TimescaleTier class. More...
 

Detailed Description

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

Constructor & Destructor Documentation

◆ TimescaleTier() [1/2]

Aspose::Tasks::Visualization::TimescaleTier::TimescaleTier ( )

Initializes a new instance of the TimescaleTier class.

◆ TimescaleTier() [2/2]

Aspose::Tasks::Visualization::TimescaleTier::TimescaleTier ( TimescaleUnit  unit,
int32_t  count 
)

Initializes a new instance of the TimescaleTier class.

Parameters
unitThe timescale unit TimescaleUnit.
countThe count of TimescaleUnit units.

Member Function Documentation

◆ get_Alignment()

HorizontalStringAlignment Aspose::Tasks::Visualization::TimescaleTier::get_Alignment ( ) const

Gets how to align labels within each time period of the tier (HorizontalStringAlignment).

◆ get_Count()

int32_t Aspose::Tasks::Visualization::TimescaleTier::get_Count ( ) const

Gets the time unit interval in which to show labels for the tier. The default value is 1.

◆ get_DateTimeConverter()

Aspose::Tasks::Visualization::DateTimeConverter Aspose::Tasks::Visualization::TimescaleTier::get_DateTimeConverter ( ) const

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

◆ get_Label()

DateLabel Aspose::Tasks::Visualization::TimescaleTier::get_Label ( ) const

Gets date label DateLabel for the timescale tier.

◆ get_RenderLabelOnEachPage()

bool Aspose::Tasks::Visualization::TimescaleTier::get_RenderLabelOnEachPage ( ) const

Gets flag that defines whether date labels should be rendered on each page when a time period spans over several pages. If value is 'true', when time period spans over several pages, date labels for the period are rendered on each page. If values is 'false', date label is rendered only once according to a value of Alignment property.

Doesn't have the equivalent in MS Project.

◆ get_ShowTicks()

bool Aspose::Tasks::Visualization::TimescaleTier::get_ShowTicks ( ) const

Gets a value indicating whether whether to show tick marks that separate time periods in the tier.

◆ get_Unit()

TimescaleUnit Aspose::Tasks::Visualization::TimescaleTier::get_Unit ( ) const

Gets timescale unit TimescaleUnit for the timescale tier. The default value is Days.

◆ get_UsesFiscalYear()

bool Aspose::Tasks::Visualization::TimescaleTier::get_UsesFiscalYear ( ) const

Gets a value indicating whether to base the tier labels on the fiscal year.

◆ set_Alignment()

void Aspose::Tasks::Visualization::TimescaleTier::set_Alignment ( HorizontalStringAlignment  value)

Sets how to align labels within each time period of the tier (HorizontalStringAlignment).

◆ set_Count()

void Aspose::Tasks::Visualization::TimescaleTier::set_Count ( int32_t  value)

Sets the time unit interval in which to show labels for the tier. The default value is 1.

◆ set_DateTimeConverter()

void Aspose::Tasks::Visualization::TimescaleTier::set_DateTimeConverter ( Aspose::Tasks::Visualization::DateTimeConverter  value)

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

◆ set_Label()

void Aspose::Tasks::Visualization::TimescaleTier::set_Label ( DateLabel  value)

Sets date label DateLabel for the timescale tier.

◆ set_RenderLabelOnEachPage()

void Aspose::Tasks::Visualization::TimescaleTier::set_RenderLabelOnEachPage ( bool  value)

Sets flag that defines whether date labels should be rendered on each page when a time period spans over several pages. If value is 'true', when time period spans over several pages, date labels for the period are rendered on each page. If values is 'false', date label is rendered only once according to a value of Alignment property.

Doesn't have the equivalent in MS Project.

◆ set_ShowTicks()

void Aspose::Tasks::Visualization::TimescaleTier::set_ShowTicks ( bool  value)

Sets a value indicating whether whether to show tick marks that separate time periods in the tier.

◆ set_Unit()

void Aspose::Tasks::Visualization::TimescaleTier::set_Unit ( TimescaleUnit  value)

Sets timescale unit TimescaleUnit for the timescale tier. The default value is Days.

◆ set_UsesFiscalYear()

void Aspose::Tasks::Visualization::TimescaleTier::set_UsesFiscalYear ( bool  value)

Sets a value indicating whether to base the tier labels on the fiscal year.